tesla-fleet-api 0.2.0 → 0.3.0

package/src/teslemetry.ts

@@ -6,34 +6,49 @@ type Region = "na" | "eu" | "api";
 type Test = { response: boolean };
 
 type Metadata = {
-    uid: string;
-    region: "NA" | "EU";
-    scopes: Scope[];
-    vins: string[];
+  uid: string;
+  region: "NA" | "EU";
+  scopes: Scope[];
+  vins: string[];
 };
 
 export default class Telemetry extends TeslaFleetApi {
-    constructor(accessToken: string, region: Region = "api") {
-        super({ accessToken, server: `https://${region}.teslemetry.com`, partnerScope: false, userScope: false });
-    }
+  constructor(accessToken: string, region: Region = "api") {
+    super({
+      accessToken,
+      server: `https://${region}.teslemetry.com`,
+      partnerScope: false,
+      userScope: false,
+    });
+  }
 
-    /**
-     * Test the connection to Teslemetry
-     */
-    async test(): Promise<Test> {
-        return this._request("GET", "/api/test").then(({ response }) => response);
+  async _response(resp: Response) {
+    if (resp.headers.has("x-region")) {
+      const region = resp.headers.get("x-region")?.toLowerCase();
+      if (region) {
+        this.server = `https://${region}.teslemetry.com`;
+      }
     }
+    return super._response(resp);
+  }
 
-    /**
-     * Get details about your Teslemetry account
-     * @param update_region Update the server URL based on the region in the metadata
-     */
-    async metadata(update_region = true): Promise<Metadata> {
-        return this._request("GET", "/api/metadata").then((metadata) => {
-            if (update_region) {
-                this.server = `https://${metadata.region.toLowerCase()}.teslemetry.com`;
-            }
-            return metadata;
-        });
-    }
+  /**
+   * Test the connection to Teslemetry
+   */
+  async test(): Promise<Test> {
+    return this._request("GET", "/api/test").then(({ response }) => response);
+  }
+
+  /**
+   * Get details about your Teslemetry account
+   * @param update_region Update the server URL based on the region in the metadata
+   */
+  async metadata(update_region = true): Promise<Metadata> {
+    return this._request("GET", "/api/metadata").then((metadata) => {
+      if (update_region) {
+        this.server = `https://${metadata.region.toLowerCase()}.teslemetry.com`;
+      }
+      return metadata;
+    });
+  }
 }

package/src/types/site_info.ts

@@ -110,20 +110,50 @@ export type UserSettings = {
     off_grid_vehicle_charging_enabled: boolean;
 };
 
+export type TariffPeriodWindow = {
+    fromDayOfWeek?: number;
+    toDayOfWeek?: number;
+    fromHour?: number;
+    toHour?: number;
+    fromMinute?: number;
+    toMinute?: number;
+};
+
+export type TouPeriods = Record<string, { periods: TariffPeriodWindow[] }>;
+
+export type Season = {
+    fromDay?: number;
+    toDay?: number;
+    fromMonth?: number;
+    toMonth?: number;
+    tou_periods?: TouPeriods;
+};
+
+export type EnergyCharges = Record<string, { rates?: Record<string, number> }>;
+
+export type SellTariff = {
+    name?: string;
+    utility?: string;
+    daily_charges?: Record<string, any>[];
+    demand_charges?: Record<string, any>;
+    energy_charges: EnergyCharges;
+    seasons?: Record<string, Season>;
+};
+
 export type TariffContentV2 = {
     version: number;
-    monthly_minimum_bill: number;
-    min_applicable_demand: number;
-    max_applicable_demand: number;
-    monthly_charges: number;
+    monthly_minimum_bill?: number;
+    min_applicable_demand?: number;
+    max_applicable_demand?: number;
+    monthly_charges?: number;
     utility: string;
     code: string;
     name: string;
     currency: string;
     daily_charges: Record<string, any>[];
-    daily_demand_charges: Record<string, any>;
+    daily_demand_charges?: Record<string, any>;
     demand_charges: Record<string, any>;
-    energy_charges: Record<string, any>;
-    seasons: Record<string, any>[];
-    sell_tariff: Record<string, any>;
+    energy_charges: EnergyCharges;
+    seasons: Record<string, Season>;
+    sell_tariff?: SellTariff;
 };

package/src/types/vehicle.ts

@@ -21,3 +21,13 @@ export type VehicleResponse = {
 export type GranularAccess = {
     hide_private: boolean;
 };
+
+export const Models: Record<string, string> = {
+    S: "Model S",
+    "3": "Model 3",
+    X: "Model X",
+    Y: "Model Y",
+    C: "Cybertruck",
+    T: "Semi",
+    A: "Cybercab",
+};

package/src/vehicle.ts

@@ -1,21 +1,15 @@
 import TeslaFleetApi from "./teslafleetapi.js";
 import { ClimateMode, ClimateModes, CommandResponse, FleetTelemetryConfig, Level, Seat, Seats, Trunk, VehicleDataEndpoint } from "./types/commands.js";
 import { OptionsResponse } from "./types/responses.js";
-import { VehicleResponse } from "./types/vehicle.js";
+import { Models, VehicleResponse } from "./types/vehicle.js";
 import { VehicleDataResponse } from "./types/vehicle_data.js";
 import VehicleSpecific from "./vehiclespecific.js";
-
-const Models: Record<string, string> = {
-    S: "Model S",
-    "3": "Model 3",
-    X: "Model X",
-    Y: "Model Y",
-    C: "Cybertruck",
-    T: "Semi",
-};
+import VehicleSigned from "./vehiclesigned.js";
 
 export default class Vehicle {
     parent: TeslaFleetApi;
+    /** Fallback private key for `signed()` when a call site doesn't pass one explicitly. */
+    private_key?: Buffer;
 
     constructor(parent: TeslaFleetApi) {
         this.parent = parent;
@@ -30,6 +24,18 @@ export default class Vehicle {
         return new VehicleSpecific(this, vin);
     }
 
+    /**
+     * Returns a class for a single vehicle that signs commands with the
+     * Tesla Vehicle Command Protocol and dispatches them through the Fleet
+     * API `/signed_command` endpoint, instead of the plaintext REST commands.
+     * @param vin
+     * @param private_key Raw 32-byte P-256 private key scalar. Falls back to `this.private_key`.
+     * @param public_key Uncompressed P-256 public key point. Derived from `private_key` if omitted.
+     */
+    signed(vin: string, private_key?: Buffer, public_key?: Buffer): VehicleSigned {
+        return new VehicleSigned(this, vin, private_key, public_key);
+    }
+
     /**
      * Return the vehicle model name
      * @param vin

package/src/vehiclesigned.ts

@@ -0,0 +1,20 @@
+import { RoutableMessage } from "@teslemetry/tesla-protocol/command/universal_message";
+import { VehicleStatus } from "@teslemetry/tesla-protocol/command/vcsec";
+import Commands from "./commands.js";
+
+/**
+ * The Fleet API `/signed_command` transport: fills `Commands`'s abstract
+ * `_send` seam by base64-encoding the signed `RoutableMessage`, POSTing it to
+ * the cloud `signed_command` endpoint, and decoding the reply. A future BLE
+ * transport (Story 3) fills the same seam over a GATT link instead - nothing
+ * else in `Commands` needs to change for that to work.
+ */
+export default class VehicleSigned extends Commands {
+    protected async _send(msg: RoutableMessage, _requires: string, _expectsData?: boolean, _confirmBroadcast?: (status: VehicleStatus) => boolean): Promise<RoutableMessage> {
+        const encoded = Buffer.from(RoutableMessage.encode(msg).finish()).toString("base64");
+        const json = await this.parent.signed_command(this.vin, encoded);
+        const resp = RoutableMessage.decode(Buffer.from(json.response, "base64"));
+        this.validateAndUpdateSession(resp, Buffer.from(msg.uuid));
+        return resp;
+    }
+}