vehicle command下載 - vehicle command原始碼下載

vehicle command

其他源碼

v0.2.1

下載

特斯拉車輛命令 SDK

建置和測試

特斯拉車輛現在支援提供端到端命令身份驗證的協定。該 Golang 套件使用新協議來控制車輛功能，例如氣候控制和充電。

其中包含的工具包括 HTTP 代理伺服器，可將 REST API 呼叫轉換為新的車輛命令協定。

一些開發人員可能熟悉 Tesla 的 Owner API。當車輛開始需要端到端命令身份驗證時，車主 API 將停止運作。如果您是這些開發人員之一，您可以設定代理伺服器或重構您的應用程式以直接使用此程式庫。 2021 年之前的 Model S 和 X 車輛不支援此新協議。 Fleet API 將繼續在這些車輛上運行。

系統概述

命令驗證分兩步驟進行：

只有當客戶端具有有效的 OAuth 令牌時，特斯拉的伺服器才會將訊息轉發到車輛。
只有當可以使用車輛鑰匙圈中的公鑰進行身份驗證時，車輛才會執行該命令。

因此，為了向車輛發送命令，第三方應用程式必須從用戶那裡獲取有效的 OAuth 令牌，並且用戶必須在車輛中註冊應用程式的公鑰。

Tesla 的網站有取得 OAuth 令牌的說明。此自述文件包含有關產生私鑰並將使用者引導至公鑰註冊流程的說明。此儲存庫中的工具可以使用 OAuth 令牌和私鑰向車輛發送命令。

例如，儲存庫包含一個命令列介面：

tesla-control -ble -key-file private_key.pem lock

以及 REST API 代理伺服器（在啟動時提供私鑰並使用客戶端發送的 OAuth 令牌）：

 curl --cacert cert.pem 
    --header 'Content-Type: application/json' 
    --header "Authorization: Bearer $TESLA_AUTH_TOKEN" 
    --data '{}' 
    "https://localhost:4443/api/1/vehicles/$VIN/command/door_lock"

安裝與配置

本地安裝

要求：

您已經安裝了 Golang。該包已使用 Go 1.23.0 進行測試。
您使用的是 macOS 或 Linux。（除了 BLE 之外的所有內容都應該在 Windows 上運行，但 Windows 並未得到官方支援）。

安裝步驟：

下載依賴項： go get ./...
編譯工具和範例： go build ./...
將工具安裝到您的路徑： go install ./...

最終命令安裝以下實用程式：

tesla-keygen ：產生命令驗證私鑰並將其儲存到系統金鑰環中。
tesla-control ：透過 BLE 或網路向車輛發送命令。有關詳細信息，請參閱工具的自述文件。
tesla-http-proxy ：公開用於發送車輛命令的 REST API 的 HTTP 代理。
tesla-auth-token ：將 OAuth 令牌寫入您的系統金鑰環。該實用程式不獲取令牌。請閱讀 Fleet API 文檔，以了解有關取得 OAuth 令牌的資訊。

使用 Docker 安裝

Docker 映像可用於執行這些工具。此映像預設執行 HTTP 代理，但--entrypoint標誌變更要使用的工具。

從 Docker hub 運行映像：

docker pull tesla/vehicle-command:latest
docker run tesla/vehicle-command:latest --help

# running a different tool
docker run --entrypoint tesla-control tesla/vehicle-command:latest --help

也提供了範例 docker-compose.yml 檔案。

docker compose up

配置

可以使用以下環境變數代替命令列標誌。

TESLA_KEY_NAME用於派生系統金鑰環中命令驗證私鑰的條目名稱。
TESLA_TOKEN_NAME用於派生系統金鑰環中 OAuth 令牌的條目名稱。
TESLA_KEYRING_TYPE用於覆蓋作業系統的預設系統金鑰環類型。執行tesla-keygen -h以查看-keyring-type標誌文件中列出的支援的值。有關每個選項的詳細信息，請參閱密鑰環文件。
TESLA_VIN指定車輛識別號碼。您可以在車輛 UI 的「控制」>「軟體」下找到您的 VIN。（儘管有名稱，VIN 仍包含字母和數字）。
TESLA_CACHE_FILE指定快取會話資訊的檔案。快取允許程式跳過向車輛發送握手訊息。這可以減少客戶端在重新啟動後重新連接到車輛時進行的佇列 API 呼叫的延遲和數量。這在使用tesla-control時特別有用，每次呼叫都會重新啟動。
TESLA_HTTP_PROXY_TLS_CERT指定 HTTP 代理的 TLS 憑證檔案。
TESLA_HTTP_PROXY_TLS_KEY指定 HTTP 代理的 TLS 金鑰檔案。
TESLA_HTTP_PROXY_HOST指定 HTTP 代理的主機。
TESLA_HTTP_PROXY_PORT指定 HTTP 代理的連接埠。
TESLA_HTTP_PROXY_TIMEOUT指定 HTTP 代理在聯絡 Tesla 伺服器時所使用的逾時。
TESLA_VERBOSE啟用詳細日誌記錄。由tesla-control和tesla-http-proxy支援。

例如：

 export TESLA_KEY_NAME= $( whoami )
export TESLA_TOKEN_NAME= $( whoami )
export TESLA_CACHE_FILE= ~ /.tesla-cache.json

此時，您已準備好使用命令列工具開始透過 BLE 向您的個人車輛發送命令！或者，繼續閱讀下面的內容，了解如何建立可以使用 REST API 透過 Internet 發送命令的應用程式。

使用 HTTP 代理

本節介紹如何設定和使用 HTTP 代理，該代理允許客戶端使用 REST API 發送車輛命令。

如上所述，您的 HTTP 代理需要對 Tesla（使用 OAuth 令牌）和單一車輛（使用私鑰）進行驗證。

取得 OAuth 存取權令牌

Tesla 的伺服器要求您的用戶端提供 OAuth 存取令牌，然後才能將命令轉發到車輛。您必須從車主處取得 OAuth 令牌。請參閱 Tesla 網站，以了解有關註冊開發者帳戶和取得 OAuth 令牌的說明。

產生命令認證私鑰

即使您的客戶端擁有有效的令牌，車輛也只接受由您的客戶端私鑰授權的命令。

此儲存庫中包含的tesla-keygen實用程式會產生私鑰，將其儲存在系統金鑰環中，並列印相應的公鑰：

 export TESLA_KEY_NAME=$(whoami)
tesla-keygen create > public_key.pem

系統密鑰環使用依賴作業系統的憑證儲存作為系統密鑰環。例如，在 macOS 上，它預設使用您的登入鑰匙圈。運行tesla-keygen -h以獲取更多選項。

重新運行tesla-keygen命令將列印相同的公鑰，而不會覆蓋私鑰。您可以使用-f強制實用程式覆蓋現有公鑰。

分發您的公鑰

車輛使用公鑰驗證指令。您的公鑰必須在用戶的車輛上註冊，然後他們才會接受您的應用程式發送的命令。

從業主的角度來看，註冊流程如下：

您的網站或應用程式提供了一個鏈接，如下所述。
用戶點擊該鏈接，這將打開 Tesla 應用程式。
Tesla 應用程式要求用戶批准該請求。
如果用戶批准，特斯拉應用程式會向車輛發送命令以註冊您的公鑰。這需要車輛在線並與手機配對。

為了使此過程正常進行，您必須註冊一個可標識您的應用程式的網域名稱。當特斯拉應用程式詢問用戶是否希望批准您的請求時，將向用戶顯示該域名，並且車輛將在鎖定螢幕中的鑰匙旁邊顯示該域名。

按照說明註冊您的公鑰和網域。這些說明中所引用的公鑰是上例中的public_key.pem檔案。

成功註冊您的公鑰後，請向車主提供https://tesla.com/_ak/<your_domain_name>的連結。例如，如果您註冊了example.com ，請提供指向https://tesla.com/_ak/example.com的連結。官方 Tesla iPhone 或 Android 行動應用程式（版本 4.27.3 或更高版本）將處理剩下的事情。擁有超過一款特斯拉產品的客戶必須在點擊連結或掃描二維碼之前選擇所需的車輛。

產生伺服器 TLS 金鑰和憑證

HTTP 代理程式需要 TLS 伺服器憑證。出於測試和開發目的，您可以使用 OpenSSL 建立自簽名本機主機伺服器憑證：

 mkdir config
openssl req -x509 -nodes -newkey ec 
    -pkeyopt ec_paramgen_curve:secp521r1 
    -pkeyopt ec_param_enc:named_curve  
    -subj '/CN=localhost' 
    -keyout config/tls-key.pem -out config/tls-cert.pem -sha256 -days 3650 
    -addext "extendedKeyUsage = serverAuth" 
    -addext "keyUsage = digitalSignature, keyCertSign, keyAgreement"

此指令會建立未加密的私鑰config/tls-key.pem 。

運行代理伺服器

可以使用以下命令運行代理伺服器：

tesla-http-proxy -tls-key config/tls-key.pem -cert config/tls-cert.pem -key-file config/fleet-key.pem -port 4443

它也可以使用 Docker 運行：

 # option 1: using docker run
docker pull tesla/vehicle-command:latest
docker run -v ./config:/config -p 127.0.0.1:4443:4443 tesla/vehicle-command:latest -tls-key /config/tls-key.pem -cert /config/tls-cert.pem -key-file /config/fleet-key.pem -host 0.0.0.0 -port 4443

# option 2: using docker compose
docker compose up

注意：在生產中，您可能需要省略-port 4443並監聽標準連接埠 443。

向代理伺服器發送命令

本節說明客戶端如何使用curl存取伺服器。客戶端負責取得 OAuth 令牌。如上所述取得 OAuth 令牌。

不支援端對端身份驗證的端點將被代理到 Tesla 的 REST API：

 export TESLA_AUTH_TOKEN= < access-token >
export VIN= < vin >
curl --cacert cert.pem 
    --header " Authorization: Bearer $TESLA_AUTH_TOKEN " 
    " https://localhost:4443/api/1/vehicles/ $VIN /vehicle_data " 
    | jq -r .

支援端對端身份驗證的端點由代理攔截並重寫，代理處理會話狀態和重試。將cert.pem複製到客戶端後，從客戶端執行以下命令將導致代理程式向車輛發送flash_lights命令：

 export TESLA_AUTH_TOKEN= < access-token >
export VIN= < vin >
curl --cacert cert.pem 
    --header ' Content-Type: application/json ' 
    --header " Authorization: Bearer $TESLA_AUTH_TOKEN " 
    --data ' {} ' 
    " https://localhost:4443/api/1/vehicles/ $VIN /command/flash_lights "