tesla-fleet-api 0.4.0 → 0.5.0

package/dist/teslemetryvehicle.mjs

@@ -0,0 +1,405 @@
+import { ClosureState } from "./const.mjs";
+import { InvalidResponse } from "./exceptions.mjs";
+import Vehicle from "./vehicle.mjs";
+import VehicleSpecific from "./vehiclespecific.mjs";
+// src/teslemetryvehicle.ts
+/** A Teslemetry vehicle: the Fleet REST commands plus Teslemetry's `custom_command` routes. */
+var TeslemetryVehicle = class extends VehicleSpecific {
+	_request(method, path, params, json) {
+		return this.parent.parent._request(method, path, params, json);
+	}
+	_custom_command(name, json) {
+		return this._request("POST", `api/1/vehicles/${this.vin}/custom_command/${name}`, null, json);
+	}
+	/**
+	* Get or set Auto mode.
+	* @deprecated Python marks this for removal in a future release.
+	* @param value `true` enables it, `false` disables it, omit to read it.
+	*/
+	async server_side_polling(value) {
+		this.parent.parent._log("This method is deprecated and will be removed in a future release.");
+		return this.parent.parent.server_side_polling(this.vin, value);
+	}
+	/** Force a refresh of the vehicle data. */
+	async data_refresh() {
+		return this.parent.parent.vehicle_data_refresh(this.vin);
+	}
+	/** Performs a no-op on the vehicle. */
+	async ping() {
+		return this._custom_command("ping");
+	}
+	/**
+	* Open, close, move and stop the vehicle's doors, frunk, trunk, charge port and tonneau.
+	* @example await vehicle.closure({ front_trunk: ClosureState.OPEN });
+	*/
+	async closure(options = {}) {
+		const keys = [
+			["frontDriverDoor", options.front_driver_door],
+			["frontPassengerDoor", options.front_passenger_door],
+			["rearDriverDoor", options.rear_driver_door],
+			["rearPassengerDoor", options.rear_passenger_door],
+			["rearTrunk", options.rear_trunk],
+			["frontTrunk", options.front_trunk],
+			["chargePort", options.charge_port],
+			["tonneau", options.tonneau]
+		];
+		return this._custom_command("closure", Object.fromEntries(keys.filter(([, state]) => state !== ClosureState.NONE)));
+	}
+	/** Opens the rear trunk; unlike `actuate_trunk`, never closes it. */
+	async open_rear_trunk() {
+		return this.closure({ rear_trunk: ClosureState.OPEN });
+	}
+	/** Closes the rear trunk; unlike `actuate_trunk`, never opens it. */
+	async close_rear_trunk() {
+		return this.closure({ rear_trunk: ClosureState.CLOSE });
+	}
+	/** Opens the tonneau cover. */
+	async open_tonneau() {
+		return this.closure({ tonneau: ClosureState.OPEN });
+	}
+	/** Closes the tonneau cover. */
+	async close_tonneau() {
+		return this.closure({ tonneau: ClosureState.CLOSE });
+	}
+	/** Stops the tonneau cover. */
+	async stop_tonneau() {
+		return this.closure({ tonneau: ClosureState.STOP });
+	}
+	/**
+	* Sets multiple seat heaters at once.
+	* @example await vehicle.seat_heater({ front_left: SeatHeaterLevel.HIGH });
+	*/
+	async seat_heater(options = {}) {
+		return this._custom_command("seat_heater", {
+			frontLeft: options.front_left,
+			frontRight: options.front_right,
+			rearLeft: options.rear_left,
+			rearRight: options.rear_right,
+			rearLeftBack: options.rear_left_back,
+			rearCenter: options.rear_center,
+			rearRightBack: options.rear_right_back,
+			thirdRowLeft: options.third_row_left,
+			thirdRowRight: options.third_row_right
+		});
+	}
+	/**
+	* Enable or disable charging on solar, and set its charge limits.
+	* @param enabled
+	* @param lower_charge_limit 0 to `upper_charge_limit`
+	* @param upper_charge_limit `lower_charge_limit` to 100
+	*/
+	async charge_on_solar(enabled, lower_charge_limit, upper_charge_limit) {
+		return this._custom_command("charge_on_solar", {
+			enabled,
+			lowerChargeLimit: lower_charge_limit,
+			upperChargeLimit: upper_charge_limit
+		});
+	}
+	/** Gets the current charge-on-solar settings. */
+	async get_charge_on_solar() {
+		return this._request("GET", `api/1/vehicles/${this.vin}/custom_command/charge_on_solar`);
+	}
+	/** Save the last 10 minutes of dashcam footage. */
+	async dashcam_save() {
+		return this._custom_command("dashcam_save");
+	}
+	/**
+	* Play a supported video URL in the vehicle.
+	* @param url Video URL, e.g. a YouTube URL.
+	*/
+	async play_video(url) {
+		return this._custom_command("play_video", { url });
+	}
+	/** Stop the currently playing light show. */
+	async stop_light_show() {
+		return this._custom_command("stop_light_show");
+	}
+	/**
+	* Start a light show on the vehicle.
+	* @param show_index Index of the light show to play.
+	* @param start_time Start time in milliseconds since epoch.
+	* @param volume Volume level for the light show.
+	* @param dance_moves Enable dance moves during the light show.
+	*/
+	async start_light_show(show_index, start_time, volume, dance_moves) {
+		return this._custom_command("start_light_show", {
+			show_index,
+			start_time,
+			volume,
+			dance_moves
+		});
+	}
+	/**
+	* Deactivates PIN to Drive.
+	* @param pin 4-digit PIN to clear.
+	*/
+	async clear_pin_to_drive(pin) {
+		return this._custom_command("clear_pin_to_drive", { pin });
+	}
+	/** Remove all impermanent keys from the vehicle. */
+	async remove_key() {
+		return this._custom_command("remove_key");
+	}
+	/**
+	* Sets the front zone light level. Named to match the signed sibling for router failover.
+	* @param level 0 off, 1 low, 2 medium, 3 high.
+	*/
+	async set_front_zone_lights(level) {
+		return this._custom_command("front_zone_light", { level });
+	}
+	/**
+	* Sets the rear zone light level. Named to match the signed sibling for router failover.
+	* @param level 0 off, 1 low, 2 medium, 3 high.
+	*/
+	async set_rear_zone_lights(level) {
+		return this._custom_command("rear_zone_light", { level });
+	}
+	/**
+	* Sets outlets on or off.
+	* @param request 0 off, 1 cabin and bed, 2 cabin.
+	*/
+	async set_outlets(request) {
+		return this._custom_command("set_outlets", { request });
+	}
+	/** Sets the outlet SOC limit percentage. */
+	async set_outlet_soc_limit(percent) {
+		return this._custom_command("set_outlet_soc_limit", { percent });
+	}
+	/**
+	* Sets power feed on or off.
+	* @param request 0 off, 1 feed 1, 2 feed 2, 3 both.
+	*/
+	async set_power_feed(request) {
+		return this._custom_command("set_power_feed", { request });
+	}
+	/** Sets the power feed SOC limit percentage. */
+	async set_power_feed_soc_limit(percent) {
+		return this._custom_command("set_power_feed_soc_limit", { percent });
+	}
+	/** Sets the lightbar brightness. */
+	async set_lightbar_brightness(brightness) {
+		return this._custom_command("set_lightbar_brightness", { brightness });
+	}
+	/** Enables or disables the lightbar middle light. */
+	async set_lightbar_middle(on) {
+		return this._custom_command("set_lightbar_middle", { on });
+	}
+	/** Enables or disables the ditch lights. */
+	async set_lightbar_ditch(on) {
+		return this._custom_command("set_lightbar_ditch", { on });
+	}
+	/** Starts or stops the trailer light test. */
+	async set_trailer_light_test(on) {
+		return this._custom_command("set_trailer_light_test", { on });
+	}
+	/** Sets the truck bed light auto state. */
+	async set_truck_bed_light_auto(on) {
+		return this._custom_command("set_truck_bed_light_auto", { on });
+	}
+	/** Sets the truck bed light brightness. */
+	async set_truck_bed_light_brightness(brightness) {
+		return this._custom_command("set_truck_bed_light_brightness", { brightness });
+	}
+	/** Enables or disables the Powershare feature. */
+	async set_powershare_feature(on) {
+		return this._custom_command("set_powershare_feature", { on });
+	}
+	/** Enables or disables an active Powershare session. */
+	async set_powershare_request(on) {
+		return this._custom_command("set_powershare_request", { on });
+	}
+	/** Sets the Powershare discharge limit percentage. */
+	async set_powershare_discharge_limit(percent) {
+		return this._custom_command("set_powershare_discharge_limit", { percent });
+	}
+	/** Sets HVAC recirculation on or off. Named to match the signed sibling for router failover. */
+	async set_recirculation(on) {
+		return this._custom_command("hvac_recirculation", { on });
+	}
+	/** Enables or disables tent mode. */
+	async set_tent_mode(on) {
+		return this._custom_command("set_tent_mode", { on });
+	}
+	/**
+	* Sets the suspension level.
+	* @param level 1 entry, 2 low, 3 medium, 4 high, 5 very high, 6 extract.
+	*/
+	async set_suspension_level(level) {
+		return this._custom_command("set_suspension_level", { level });
+	}
+	/** Turns Low Power mode on or off, reducing standby consumption while parked. */
+	async set_low_power_mode(on) {
+		return this._custom_command("set_low_power_mode", { on });
+	}
+	/** Turns Keep Accessory Power mode on or off, keeping 12V accessory power available while parked. */
+	async set_keep_accessory_power_mode(on) {
+		return this._custom_command("set_keep_accessory_power_mode", { on });
+	}
+	/** Sets the displayed temperature unit. */
+	async set_temperature_unit(unit) {
+		return this._custom_command("set_temperature_unit", { unit });
+	}
+	/** Sets the displayed distance unit. */
+	async set_distance_unit(unit) {
+		return this._custom_command("set_distance_unit", { unit });
+	}
+	/** Sets the displayed clock format (12h or 24h). */
+	async set_time_display_format(format) {
+		return this._custom_command("set_time_display_format", { format });
+	}
+	/** Sets the displayed tire pressure unit. */
+	async set_tire_pressure_unit(unit) {
+		return this._custom_command("set_tire_pressure_unit", { unit });
+	}
+	/** Sets the displayed energy unit (percentage or distance). */
+	async set_energy_display_format(format) {
+		return this._custom_command("set_energy_display_format", { format });
+	}
+	/** Activates or deactivates parental controls with a PIN. */
+	async parental_controls(activate, pin) {
+		return this._custom_command("parental_controls", {
+			activate,
+			pin
+		});
+	}
+	/** Clears the parental controls PIN. */
+	async parental_controls_clear_pin(pin) {
+		return this._custom_command("parental_controls_clear_pin", { pin });
+	}
+	/** Clears the parental controls PIN as admin (fleet manager or owner). */
+	async parental_controls_clear_pin_admin() {
+		return this._custom_command("parental_controls_clear_pin_admin");
+	}
+	/**
+	* Enables or disables a parental controls setting.
+	* @param setting 1 speed limit, 2 acceleration, 3 safety features, 4 curfew.
+	* @param enable
+	*/
+	async parental_controls_enable_setting(setting, enable) {
+		return this._custom_command("parental_controls_enable_setting", {
+			setting,
+			enable
+		});
+	}
+	/** Sets the parental controls speed limit. */
+	async parental_controls_set_speed_limit(limit_mph) {
+		return this._custom_command("parental_controls_set_speed_limit", { limit_mph });
+	}
+	/**
+	* Navigates to coordinates with a named destination. Named to match the signed sibling for router failover.
+	* @param lat
+	* @param lon
+	* @param destination
+	* @param order Sent as given: on tesla-protocol 6, `RemoteNavTripOrder_E` is 0 replace, 1 prepend, 2 append.
+	*/
+	async navigation_gps_destination_request(lat, lon, destination, order) {
+		return this._custom_command("navigation_gps_destination", {
+			lat,
+			lon,
+			destination,
+			order
+		});
+	}
+	/** Auto-secures the vehicle: locks it, closes windows, and so on. */
+	async auto_secure_vehicle() {
+		return this._custom_command("auto_secure_vehicle");
+	}
+	/** Cancels a State of Health test. */
+	async cancel_soh_test() {
+		return this._custom_command("cancel_soh_test");
+	}
+	/** Returns the charging sites near the vehicle's current location. */
+	async get_nearby_charging_sites(count, radius, detail) {
+		return this._custom_command("get_nearby_charging_sites", {
+			count,
+			radius,
+			detail
+		});
+	}
+	/** Gets the current time-of-use rate tariff schedule. */
+	async get_rate_tariff() {
+		return this._custom_command("get_rate_tariff");
+	}
+	/**
+	* Triggers a time-of-use rate tariff update, with no schedule payload.
+	* Deliberately not named `set_rate_tariff`: the signed sibling takes a
+	* required schedule, which a router failing over here would silently drop.
+	*/
+	async trigger_rate_tariff_update() {
+		return this._custom_command("set_rate_tariff");
+	}
+	/**
+	* Gets a snapshot of cached vehicle telemetry.
+	* @param topics Topics to include.
+	* @param cursor Return only what changed since this cursor.
+	*/
+	async telemetry(topics, cursor) {
+		return this._request("GET", `api/1/vehicles/${this.vin}/telemetry`, {
+			topics: joinTopics(topics),
+			cursor
+		});
+	}
+	/** Creates a cursor-aware reader of this vehicle's cached telemetry. */
+	create_telemetry_tracker(topics) {
+		return new TeslemetryVehicleTelemetry(this, topics);
+	}
+};
+function joinTopics(topics) {
+	return Array.isArray(topics) ? topics.join(";") : topics;
+}
+/** Python truthiness, which an update's fields are tested by: an empty object or list counts as absent. */
+function hasContent(value) {
+	return value !== null && typeof value === "object" ? Object.keys(value).length > 0 : !!value;
+}
+/** A cursor-aware vehicle telemetry reader, keeping a snapshot merged from each update. */
+var TeslemetryVehicleTelemetry = class {
+	/** The cursor the next `update()` sends. */
+	cursor = 0;
+	/** Everything received so far. `data` merges field by field; other topics are replaced whole. */
+	snapshot = {};
+	_parent;
+	_topics;
+	constructor(parent, topics) {
+		this._parent = parent;
+		this._topics = joinTopics(topics);
+	}
+	/**
+	* Get the changes since the last update, and merge them into `snapshot`.
+	* @returns The update's `response`.
+	* @throws InvalidResponse when the update has an empty `response`, or no `cursor`.
+	*/
+	async update() {
+		const response = (await this._parent.telemetry(this._topics, this.cursor))?.response;
+		if (!hasContent(response)) throw new InvalidResponse("No response from telemetry");
+		if (typeof response !== "object" || !("cursor" in response)) throw new InvalidResponse("Telemetry response did not contain a cursor");
+		this.cursor = response.cursor;
+		if (hasContent(response.state)) this.snapshot.state = response.state;
+		if (hasContent(response.data)) this.snapshot.data = {
+			...this.snapshot.data,
+			...response.data
+		};
+		for (const topic of [
+			"connectivity",
+			"alerts",
+			"errors",
+			"vehicle_data"
+		]) if (hasContent(response[topic])) this.snapshot[topic] = response[topic];
+		return response;
+	}
+};
+/** Creates `TeslemetryVehicle`s. Teslemetry cannot use the Fleet API directly, so `create` is the only factory. */
+var TeslemetryVehicles = class extends Vehicle {
+	/** Class `create` instantiates; a subclass overrides it to supply its own vehicle type. */
+	static Vehicle = TeslemetryVehicle;
+	createFleet = void 0;
+	createSigned = void 0;
+	specific = void 0;
+	specificSigned = void 0;
+	/** Creates a vehicle, and records it by VIN. */
+	create(vin) {
+		const vehicle = new this.constructor.Vehicle(this, vin);
+		this.byVin.set(vin, vehicle);
+		return vehicle;
+	}
+};
+export { TeslemetryVehicle, TeslemetryVehicleTelemetry, TeslemetryVehicles };

package/dist/tessie.cjs

@@ -1,13 +1,26 @@
+const require_exceptions = require("./exceptions.cjs");
 const require_teslafleetapi = require("./teslafleetapi.cjs");
+const require_tessievehicle = require("./tessievehicle.cjs");
 // src/tessie.ts
 var Tessie = class extends require_teslafleetapi.default {
-	constructor(accessToken) {
+	static Vehicles = require_tessievehicle.TessieVehicles;
+	_transport_name = "tessie";
+	wait_for_completion;
+	max_attempts;
+	constructor(accessToken, options = {}) {
+		const { wait_for_completion = true, max_attempts = 3, ...rest } = options;
 		super({
+			...rest,
 			accessToken,
 			server: `https://api.tessie.com`,
-			partnerScope: false,
-			userScope: false
+			partnerScope: false
 		});
+		this.wait_for_completion = wait_for_completion;
+		this.max_attempts = max_attempts;
+	}
+	/** Tessie has one server; there is nothing to find. */
+	async find_server() {
+		throw new require_exceptions.LibraryError("Do not use this function for Tessie.");
 	}
 	/**
 	* Get your approved Tesla scopes
@@ -15,20 +28,44 @@ var Tessie = class extends require_teslafleetapi.default {
 	async tesla_scopes() {
 		return this._request("GET", "auth/tesla_scopes").then(({ scopes }) => scopes);
 	}
+	/** Get the user's scopes. */
+	async scopes() {
+		return this._request("GET", "auth/tesla_scopes").then(({ scopes }) => scopes);
+	}
 	async metadata() {
 		return this._request("GET", "auth/tesla_scopes");
 	}
 	async status(vin) {
+		if (vin === void 0) return super.status();
 		return this._request("GET", `${vin}/status`).then(({ status }) => status);
 	}
 	async state(vin, use_cache = true) {
 		return this._request("GET", `${vin}/state`, { use_cache });
 	}
-	async vehicles(only_active = false) {
-		return this._request("GET", "vehicles", { only_active }).then(({ results }) => results);
+	async list_vehicles(only_active = false) {
+		return this._request("GET", "vehicles", { only_active });
 	}
 	async wake(vin) {
 		return this._request("POST", `${vin}/wake`).then(({ result }) => result);
 	}
+	/** Get battery health data for every vehicle. */
+	async all_battery_health(options = {}) {
+		const { start, end, distance_format, only_active = false } = options;
+		return this._request("GET", "battery_health", {
+			from: start,
+			to: end,
+			distance_format,
+			only_active
+		});
+	}
+	/** Get charging costs for every vehicle. */
+	async charging_invoices(options = {}) {
+		const { start, end, ...params } = options;
+		return this._request("GET", "charging_invoices", {
+			from: start,
+			to: end,
+			...params
+		});
+	}
 };
 exports.default = Tessie;

package/dist/tessie.d.cts

@@ -1,23 +1,69 @@
-import TeslaFleetApi from "./teslafleetapi.cjs";
+import TeslaFleetApi, { AccessToken } from "./teslafleetapi.cjs";
+import { TessieVehicles } from "./tessievehicle.cjs";
+import { Logger } from "./log.cjs";
 import { Scope } from "./const.cjs";
 import { VehicleDataResponse } from "./types/vehicle_data.cjs";
+import Vehicle from "./vehicle.cjs";
 type TessieVehicleResponse = {
   vin: string;
   is_active: boolean;
   last_state: VehicleDataResponse;
 };
-declare class Tessie extends TeslaFleetApi {
-  constructor(accessToken: string);
+export type TessieOptions = {
+  debug?: boolean;
+  logger?: Logger;
+  fetch?: typeof fetch;
+  timeout?: number;
+  /** Default for each command's `wait_for_completion`. */
+  wait_for_completion?: boolean;
+  /** Default for each command's `max_attempts`. */
+  max_attempts?: number;
+};
+/** Options of `all_battery_health`. `start` and `end` are sent as `from` and `to`. */
+export type TessieAllBatteryHealthOptions = {
+  start?: number | null;
+  end?: number | null;
+  distance_format?: string;
+  only_active?: boolean;
+};
+/** Options of `charging_invoices`. `start` and `end` are sent as `from` and `to`. */
+export type TessieChargingInvoicesOptions = {
+  start?: number | null;
+  end?: number | null;
+  timezone?: string;
+  vin?: string;
+  format?: string;
+  only_active?: boolean;
+};
+export default class Tessie extends TeslaFleetApi {
+  static Vehicles: new (parent: TeslaFleetApi) => Vehicle;
+  vehicles: TessieVehicles;
+  readonly _transport_name: string;
+  wait_for_completion: boolean;
+  max_attempts: number;
+  constructor(accessToken: AccessToken, options?: TessieOptions);
+  /** Tessie has one server; there is nothing to find. */
+  find_server(): Promise<string>;
   /**
    * Get your approved Tesla scopes
    */
   tesla_scopes(): Promise<Scope[]>;
+  /** Get the user's scopes. */
+  scopes(): Promise<Scope[]>;
   metadata(): Promise<{
     scopes: Scope[];
   }>;
+  /** With no VIN, the API status (`"ok"`); with a VIN, that vehicle's sleep status. */
+  status(): Promise<string>;
   status(vin: string): Promise<"asleep" | "waiting_for_sleep" | "awake">;
   state(vin: string, use_cache?: boolean): Promise<VehicleDataResponse>;
-  vehicles(only_active?: boolean): Promise<TessieVehicleResponse[]>;
+  list_vehicles(only_active?: boolean): Promise<{
+    results: TessieVehicleResponse[];
+  }>;
   wake(vin: string): Promise<boolean>;
+  /** Get battery health data for every vehicle. */
+  all_battery_health(options?: TessieAllBatteryHealthOptions): Promise<any>;
+  /** Get charging costs for every vehicle. */
+  charging_invoices(options?: TessieChargingInvoicesOptions): Promise<any>;
 }
-export = Tessie;
+export {};

package/dist/tessie.d.mts

@@ -1,23 +1,69 @@
-import TeslaFleetApi from "./teslafleetapi.mjs";
+import TeslaFleetApi, { AccessToken } from "./teslafleetapi.mjs";
+import { TessieVehicles } from "./tessievehicle.mjs";
+import { Logger } from "./log.mjs";
 import { Scope } from "./const.mjs";
 import { VehicleDataResponse } from "./types/vehicle_data.mjs";
+import Vehicle from "./vehicle.mjs";
 type TessieVehicleResponse = {
   vin: string;
   is_active: boolean;
   last_state: VehicleDataResponse;
 };
+export type TessieOptions = {
+  debug?: boolean;
+  logger?: Logger;
+  fetch?: typeof fetch;
+  timeout?: number;
+  /** Default for each command's `wait_for_completion`. */
+  wait_for_completion?: boolean;
+  /** Default for each command's `max_attempts`. */
+  max_attempts?: number;
+};
+/** Options of `all_battery_health`. `start` and `end` are sent as `from` and `to`. */
+export type TessieAllBatteryHealthOptions = {
+  start?: number | null;
+  end?: number | null;
+  distance_format?: string;
+  only_active?: boolean;
+};
+/** Options of `charging_invoices`. `start` and `end` are sent as `from` and `to`. */
+export type TessieChargingInvoicesOptions = {
+  start?: number | null;
+  end?: number | null;
+  timezone?: string;
+  vin?: string;
+  format?: string;
+  only_active?: boolean;
+};
 export default class Tessie extends TeslaFleetApi {
-  constructor(accessToken: string);
+  static Vehicles: new (parent: TeslaFleetApi) => Vehicle;
+  vehicles: TessieVehicles;
+  readonly _transport_name: string;
+  wait_for_completion: boolean;
+  max_attempts: number;
+  constructor(accessToken: AccessToken, options?: TessieOptions);
+  /** Tessie has one server; there is nothing to find. */
+  find_server(): Promise<string>;
   /**
    * Get your approved Tesla scopes
    */
   tesla_scopes(): Promise<Scope[]>;
+  /** Get the user's scopes. */
+  scopes(): Promise<Scope[]>;
   metadata(): Promise<{
     scopes: Scope[];
   }>;
+  /** With no VIN, the API status (`"ok"`); with a VIN, that vehicle's sleep status. */
+  status(): Promise<string>;
   status(vin: string): Promise<"asleep" | "waiting_for_sleep" | "awake">;
   state(vin: string, use_cache?: boolean): Promise<VehicleDataResponse>;
-  vehicles(only_active?: boolean): Promise<TessieVehicleResponse[]>;
+  list_vehicles(only_active?: boolean): Promise<{
+    results: TessieVehicleResponse[];
+  }>;
   wake(vin: string): Promise<boolean>;
+  /** Get battery health data for every vehicle. */
+  all_battery_health(options?: TessieAllBatteryHealthOptions): Promise<any>;
+  /** Get charging costs for every vehicle. */
+  charging_invoices(options?: TessieChargingInvoicesOptions): Promise<any>;
 }
 export {};