tesla-fleet-api 0.4.0 → 0.6.0

package/dist/teslemetryvehicle.d.cts

@@ -0,0 +1,238 @@
+import { ClosureState, DistanceUnit, EnergyDisplayFormat, SeatHeaterLevel, SnapshotTopic, TemperatureUnit, TimeDisplayFormat, TirePressureUnit } from "./const.cjs";
+import Teslemetry from "./teslemetry.cjs";
+import Vehicle from "./vehicle.cjs";
+import VehicleSpecific from "./vehiclespecific.cjs";
+type Reply = Record<string, any>;
+/** Telemetry topics: a list, or an already `;`-joined string. Omit for every topic. */
+export type TelemetryTopics = SnapshotTopic[] | string[] | string | null;
+/** What each closure should do. A closure left out, or set to `none`, is not sent. */
+export type ClosureOptions = {
+  front_driver_door?: ClosureState;
+  front_passenger_door?: ClosureState;
+  rear_driver_door?: ClosureState;
+  rear_passenger_door?: ClosureState;
+  rear_trunk?: ClosureState;
+  front_trunk?: ClosureState;
+  charge_port?: ClosureState;
+  tonneau?: ClosureState;
+};
+/** The heater level for each seat. A seat left out is not sent. */
+export type SeatHeaterOptions = {
+  front_left?: SeatHeaterLevel;
+  front_right?: SeatHeaterLevel;
+  rear_left?: SeatHeaterLevel;
+  rear_right?: SeatHeaterLevel;
+  rear_left_back?: SeatHeaterLevel;
+  rear_center?: SeatHeaterLevel;
+  rear_right_back?: SeatHeaterLevel;
+  third_row_left?: SeatHeaterLevel;
+  third_row_right?: SeatHeaterLevel;
+};
+/** A Teslemetry vehicle: the Fleet REST commands plus Teslemetry's `custom_command` routes. */
+export declare class TeslemetryVehicle extends VehicleSpecific {
+  parent: TeslemetryVehicles;
+  private _request;
+  private _custom_command;
+  /**
+   * 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.
+   */
+  server_side_polling(value?: boolean | null): Promise<boolean | undefined>;
+  /** Force a refresh of the vehicle data. */
+  data_refresh(): Promise<Reply>;
+  /** Performs a no-op on the vehicle. */
+  ping(): Promise<Reply>;
+  /**
+   * Open, close, move and stop the vehicle's doors, frunk, trunk, charge port and tonneau.
+   * @example await vehicle.closure({ front_trunk: ClosureState.OPEN });
+   */
+  closure(options?: ClosureOptions): Promise<Reply>;
+  /** Opens the rear trunk; unlike `actuate_trunk`, never closes it. */
+  open_rear_trunk(): Promise<Reply>;
+  /** Closes the rear trunk; unlike `actuate_trunk`, never opens it. */
+  close_rear_trunk(): Promise<Reply>;
+  /** Opens the tonneau cover. */
+  open_tonneau(): Promise<Reply>;
+  /** Closes the tonneau cover. */
+  close_tonneau(): Promise<Reply>;
+  /** Stops the tonneau cover. */
+  stop_tonneau(): Promise<Reply>;
+  /**
+   * Sets multiple seat heaters at once.
+   * @example await vehicle.seat_heater({ front_left: SeatHeaterLevel.HIGH });
+   */
+  seat_heater(options?: SeatHeaterOptions): Promise<Reply>;
+  /**
+   * 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
+   */
+  charge_on_solar(enabled?: boolean, lower_charge_limit?: number, upper_charge_limit?: number): Promise<Reply>;
+  /** Gets the current charge-on-solar settings. */
+  get_charge_on_solar(): Promise<Reply>;
+  /** Save the last 10 minutes of dashcam footage. */
+  dashcam_save(): Promise<Reply>;
+  /**
+   * Play a supported video URL in the vehicle.
+   * @param url Video URL, e.g. a YouTube URL.
+   */
+  play_video(url: string): Promise<Reply>;
+  /** Stop the currently playing light show. */
+  stop_light_show(): Promise<Reply>;
+  /**
+   * 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.
+   */
+  start_light_show(show_index: number, start_time?: number, volume?: number, dance_moves?: boolean): Promise<Reply>;
+  /**
+   * Deactivates PIN to Drive.
+   * @param pin 4-digit PIN to clear.
+   */
+  clear_pin_to_drive(pin: string): Promise<Reply>;
+  /** Remove all impermanent keys from the vehicle. */
+  remove_key(): Promise<Reply>;
+  /**
+   * 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.
+   */
+  set_front_zone_lights(level: number): Promise<Reply>;
+  /**
+   * 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.
+   */
+  set_rear_zone_lights(level: number): Promise<Reply>;
+  /**
+   * Sets outlets on or off.
+   * @param request 0 off, 1 cabin and bed, 2 cabin.
+   */
+  set_outlets(request: number): Promise<Reply>;
+  /** Sets the outlet SOC limit percentage. */
+  set_outlet_soc_limit(percent: number): Promise<Reply>;
+  /**
+   * Sets power feed on or off.
+   * @param request 0 off, 1 feed 1, 2 feed 2, 3 both.
+   */
+  set_power_feed(request: number): Promise<Reply>;
+  /** Sets the power feed SOC limit percentage. */
+  set_power_feed_soc_limit(percent: number): Promise<Reply>;
+  /** Sets the lightbar brightness. */
+  set_lightbar_brightness(brightness: number): Promise<Reply>;
+  /** Enables or disables the lightbar middle light. */
+  set_lightbar_middle(on: boolean): Promise<Reply>;
+  /** Enables or disables the ditch lights. */
+  set_lightbar_ditch(on: boolean): Promise<Reply>;
+  /** Starts or stops the trailer light test. */
+  set_trailer_light_test(on: boolean): Promise<Reply>;
+  /** Sets the truck bed light auto state. */
+  set_truck_bed_light_auto(on: boolean): Promise<Reply>;
+  /** Sets the truck bed light brightness. */
+  set_truck_bed_light_brightness(brightness: number): Promise<Reply>;
+  /** Enables or disables the Powershare feature. */
+  set_powershare_feature(on: boolean): Promise<Reply>;
+  /** Enables or disables an active Powershare session. */
+  set_powershare_request(on: boolean): Promise<Reply>;
+  /** Sets the Powershare discharge limit percentage. */
+  set_powershare_discharge_limit(percent: number): Promise<Reply>;
+  /** Sets HVAC recirculation on or off. Named to match the signed sibling for router failover. */
+  set_recirculation(on: boolean): Promise<Reply>;
+  /** Enables or disables tent mode. */
+  set_tent_mode(on: boolean): Promise<Reply>;
+  /**
+   * Sets the suspension level.
+   * @param level 1 entry, 2 low, 3 medium, 4 high, 5 very high, 6 extract.
+   */
+  set_suspension_level(level: number): Promise<Reply>;
+  /** Turns Low Power mode on or off, reducing standby consumption while parked. */
+  set_low_power_mode(on: boolean): Promise<Reply>;
+  /** Turns Keep Accessory Power mode on or off, keeping 12V accessory power available while parked. */
+  set_keep_accessory_power_mode(on: boolean): Promise<Reply>;
+  /** Sets the displayed temperature unit. */
+  set_temperature_unit(unit: TemperatureUnit | number): Promise<Reply>;
+  /** Sets the displayed distance unit. */
+  set_distance_unit(unit: DistanceUnit | number): Promise<Reply>;
+  /** Sets the displayed clock format (12h or 24h). */
+  set_time_display_format(format: TimeDisplayFormat | number): Promise<Reply>;
+  /** Sets the displayed tire pressure unit. */
+  set_tire_pressure_unit(unit: TirePressureUnit | number): Promise<Reply>;
+  /** Sets the displayed energy unit (percentage or distance). */
+  set_energy_display_format(format: EnergyDisplayFormat | number): Promise<Reply>;
+  /** Activates or deactivates parental controls with a PIN. */
+  parental_controls(activate: boolean, pin: string): Promise<Reply>;
+  /** Clears the parental controls PIN. */
+  parental_controls_clear_pin(pin: string): Promise<Reply>;
+  /** Clears the parental controls PIN as admin (fleet manager or owner). */
+  parental_controls_clear_pin_admin(): Promise<Reply>;
+  /**
+   * Enables or disables a parental controls setting.
+   * @param setting 1 speed limit, 2 acceleration, 3 safety features, 4 curfew.
+   * @param enable
+   */
+  parental_controls_enable_setting(setting: number, enable: boolean): Promise<Reply>;
+  /** Sets the parental controls speed limit. */
+  parental_controls_set_speed_limit(limit_mph: number): Promise<Reply>;
+  /**
+   * 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.
+   */
+  navigation_gps_destination_request(lat: number, lon: number, destination: string, order: number): Promise<Reply>;
+  /** Auto-secures the vehicle: locks it, closes windows, and so on. */
+  auto_secure_vehicle(): Promise<Reply>;
+  /** Cancels a State of Health test. */
+  cancel_soh_test(): Promise<Reply>;
+  /** Returns the charging sites near the vehicle's current location. */
+  get_nearby_charging_sites(count?: number, radius?: number, detail?: boolean): Promise<Reply>;
+  /** Gets the current time-of-use rate tariff schedule. */
+  get_rate_tariff(): Promise<Reply>;
+  /**
+   * 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.
+   */
+  trigger_rate_tariff_update(): Promise<Reply>;
+  /**
+   * Gets a snapshot of cached vehicle telemetry.
+   * @param topics Topics to include.
+   * @param cursor Return only what changed since this cursor.
+   */
+  telemetry(topics?: TelemetryTopics, cursor?: number | null): Promise<Reply>;
+  /** Creates a cursor-aware reader of this vehicle's cached telemetry. */
+  create_telemetry_tracker(topics?: TelemetryTopics): TeslemetryVehicleTelemetry;
+}
+/** A cursor-aware vehicle telemetry reader, keeping a snapshot merged from each update. */
+export declare class TeslemetryVehicleTelemetry {
+  /** The cursor the next `update()` sends. */
+  cursor: number;
+  /** Everything received so far. `data` merges field by field; other topics are replaced whole. */
+  snapshot: Record<string, any>;
+  private readonly _parent;
+  private readonly _topics;
+  constructor(parent: TeslemetryVehicle, topics?: TelemetryTopics);
+  /**
+   * 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`.
+   */
+  update(): Promise<Reply>;
+}
+/** Creates `TeslemetryVehicle`s. Teslemetry cannot use the Fleet API directly, so `create` is the only factory. */
+export declare class TeslemetryVehicles extends Vehicle {
+  /** Class `create` instantiates; a subclass overrides it to supply its own vehicle type. */
+  static Vehicle: new (parent: Vehicle, vin: string) => TeslemetryVehicle;
+  parent: Teslemetry;
+  byVin: Map<string, TeslemetryVehicle>;
+  readonly createFleet: never;
+  readonly createSigned: never;
+  readonly specific: never;
+  readonly specificSigned: never;
+  /** Creates a vehicle, and records it by VIN. */
+  create(vin: string): TeslemetryVehicle;
+}
+export {};

package/dist/teslemetryvehicle.d.mts

@@ -0,0 +1,238 @@
+import { ClosureState, DistanceUnit, EnergyDisplayFormat, SeatHeaterLevel, SnapshotTopic, TemperatureUnit, TimeDisplayFormat, TirePressureUnit } from "./const.mjs";
+import Teslemetry from "./teslemetry.mjs";
+import Vehicle from "./vehicle.mjs";
+import VehicleSpecific from "./vehiclespecific.mjs";
+type Reply = Record<string, any>;
+/** Telemetry topics: a list, or an already `;`-joined string. Omit for every topic. */
+export type TelemetryTopics = SnapshotTopic[] | string[] | string | null;
+/** What each closure should do. A closure left out, or set to `none`, is not sent. */
+export type ClosureOptions = {
+  front_driver_door?: ClosureState;
+  front_passenger_door?: ClosureState;
+  rear_driver_door?: ClosureState;
+  rear_passenger_door?: ClosureState;
+  rear_trunk?: ClosureState;
+  front_trunk?: ClosureState;
+  charge_port?: ClosureState;
+  tonneau?: ClosureState;
+};
+/** The heater level for each seat. A seat left out is not sent. */
+export type SeatHeaterOptions = {
+  front_left?: SeatHeaterLevel;
+  front_right?: SeatHeaterLevel;
+  rear_left?: SeatHeaterLevel;
+  rear_right?: SeatHeaterLevel;
+  rear_left_back?: SeatHeaterLevel;
+  rear_center?: SeatHeaterLevel;
+  rear_right_back?: SeatHeaterLevel;
+  third_row_left?: SeatHeaterLevel;
+  third_row_right?: SeatHeaterLevel;
+};
+/** A Teslemetry vehicle: the Fleet REST commands plus Teslemetry's `custom_command` routes. */
+export declare class TeslemetryVehicle extends VehicleSpecific {
+  parent: TeslemetryVehicles;
+  private _request;
+  private _custom_command;
+  /**
+   * 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.
+   */
+  server_side_polling(value?: boolean | null): Promise<boolean | undefined>;
+  /** Force a refresh of the vehicle data. */
+  data_refresh(): Promise<Reply>;
+  /** Performs a no-op on the vehicle. */
+  ping(): Promise<Reply>;
+  /**
+   * Open, close, move and stop the vehicle's doors, frunk, trunk, charge port and tonneau.
+   * @example await vehicle.closure({ front_trunk: ClosureState.OPEN });
+   */
+  closure(options?: ClosureOptions): Promise<Reply>;
+  /** Opens the rear trunk; unlike `actuate_trunk`, never closes it. */
+  open_rear_trunk(): Promise<Reply>;
+  /** Closes the rear trunk; unlike `actuate_trunk`, never opens it. */
+  close_rear_trunk(): Promise<Reply>;
+  /** Opens the tonneau cover. */
+  open_tonneau(): Promise<Reply>;
+  /** Closes the tonneau cover. */
+  close_tonneau(): Promise<Reply>;
+  /** Stops the tonneau cover. */
+  stop_tonneau(): Promise<Reply>;
+  /**
+   * Sets multiple seat heaters at once.
+   * @example await vehicle.seat_heater({ front_left: SeatHeaterLevel.HIGH });
+   */
+  seat_heater(options?: SeatHeaterOptions): Promise<Reply>;
+  /**
+   * 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
+   */
+  charge_on_solar(enabled?: boolean, lower_charge_limit?: number, upper_charge_limit?: number): Promise<Reply>;
+  /** Gets the current charge-on-solar settings. */
+  get_charge_on_solar(): Promise<Reply>;
+  /** Save the last 10 minutes of dashcam footage. */
+  dashcam_save(): Promise<Reply>;
+  /**
+   * Play a supported video URL in the vehicle.
+   * @param url Video URL, e.g. a YouTube URL.
+   */
+  play_video(url: string): Promise<Reply>;
+  /** Stop the currently playing light show. */
+  stop_light_show(): Promise<Reply>;
+  /**
+   * 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.
+   */
+  start_light_show(show_index: number, start_time?: number, volume?: number, dance_moves?: boolean): Promise<Reply>;
+  /**
+   * Deactivates PIN to Drive.
+   * @param pin 4-digit PIN to clear.
+   */
+  clear_pin_to_drive(pin: string): Promise<Reply>;
+  /** Remove all impermanent keys from the vehicle. */
+  remove_key(): Promise<Reply>;
+  /**
+   * 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.
+   */
+  set_front_zone_lights(level: number): Promise<Reply>;
+  /**
+   * 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.
+   */
+  set_rear_zone_lights(level: number): Promise<Reply>;
+  /**
+   * Sets outlets on or off.
+   * @param request 0 off, 1 cabin and bed, 2 cabin.
+   */
+  set_outlets(request: number): Promise<Reply>;
+  /** Sets the outlet SOC limit percentage. */
+  set_outlet_soc_limit(percent: number): Promise<Reply>;
+  /**
+   * Sets power feed on or off.
+   * @param request 0 off, 1 feed 1, 2 feed 2, 3 both.
+   */
+  set_power_feed(request: number): Promise<Reply>;
+  /** Sets the power feed SOC limit percentage. */
+  set_power_feed_soc_limit(percent: number): Promise<Reply>;
+  /** Sets the lightbar brightness. */
+  set_lightbar_brightness(brightness: number): Promise<Reply>;
+  /** Enables or disables the lightbar middle light. */
+  set_lightbar_middle(on: boolean): Promise<Reply>;
+  /** Enables or disables the ditch lights. */
+  set_lightbar_ditch(on: boolean): Promise<Reply>;
+  /** Starts or stops the trailer light test. */
+  set_trailer_light_test(on: boolean): Promise<Reply>;
+  /** Sets the truck bed light auto state. */
+  set_truck_bed_light_auto(on: boolean): Promise<Reply>;
+  /** Sets the truck bed light brightness. */
+  set_truck_bed_light_brightness(brightness: number): Promise<Reply>;
+  /** Enables or disables the Powershare feature. */
+  set_powershare_feature(on: boolean): Promise<Reply>;
+  /** Enables or disables an active Powershare session. */
+  set_powershare_request(on: boolean): Promise<Reply>;
+  /** Sets the Powershare discharge limit percentage. */
+  set_powershare_discharge_limit(percent: number): Promise<Reply>;
+  /** Sets HVAC recirculation on or off. Named to match the signed sibling for router failover. */
+  set_recirculation(on: boolean): Promise<Reply>;
+  /** Enables or disables tent mode. */
+  set_tent_mode(on: boolean): Promise<Reply>;
+  /**
+   * Sets the suspension level.
+   * @param level 1 entry, 2 low, 3 medium, 4 high, 5 very high, 6 extract.
+   */
+  set_suspension_level(level: number): Promise<Reply>;
+  /** Turns Low Power mode on or off, reducing standby consumption while parked. */
+  set_low_power_mode(on: boolean): Promise<Reply>;
+  /** Turns Keep Accessory Power mode on or off, keeping 12V accessory power available while parked. */
+  set_keep_accessory_power_mode(on: boolean): Promise<Reply>;
+  /** Sets the displayed temperature unit. */
+  set_temperature_unit(unit: TemperatureUnit | number): Promise<Reply>;
+  /** Sets the displayed distance unit. */
+  set_distance_unit(unit: DistanceUnit | number): Promise<Reply>;
+  /** Sets the displayed clock format (12h or 24h). */
+  set_time_display_format(format: TimeDisplayFormat | number): Promise<Reply>;
+  /** Sets the displayed tire pressure unit. */
+  set_tire_pressure_unit(unit: TirePressureUnit | number): Promise<Reply>;
+  /** Sets the displayed energy unit (percentage or distance). */
+  set_energy_display_format(format: EnergyDisplayFormat | number): Promise<Reply>;
+  /** Activates or deactivates parental controls with a PIN. */
+  parental_controls(activate: boolean, pin: string): Promise<Reply>;
+  /** Clears the parental controls PIN. */
+  parental_controls_clear_pin(pin: string): Promise<Reply>;
+  /** Clears the parental controls PIN as admin (fleet manager or owner). */
+  parental_controls_clear_pin_admin(): Promise<Reply>;
+  /**
+   * Enables or disables a parental controls setting.
+   * @param setting 1 speed limit, 2 acceleration, 3 safety features, 4 curfew.
+   * @param enable
+   */
+  parental_controls_enable_setting(setting: number, enable: boolean): Promise<Reply>;
+  /** Sets the parental controls speed limit. */
+  parental_controls_set_speed_limit(limit_mph: number): Promise<Reply>;
+  /**
+   * 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.
+   */
+  navigation_gps_destination_request(lat: number, lon: number, destination: string, order: number): Promise<Reply>;
+  /** Auto-secures the vehicle: locks it, closes windows, and so on. */
+  auto_secure_vehicle(): Promise<Reply>;
+  /** Cancels a State of Health test. */
+  cancel_soh_test(): Promise<Reply>;
+  /** Returns the charging sites near the vehicle's current location. */
+  get_nearby_charging_sites(count?: number, radius?: number, detail?: boolean): Promise<Reply>;
+  /** Gets the current time-of-use rate tariff schedule. */
+  get_rate_tariff(): Promise<Reply>;
+  /**
+   * 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.
+   */
+  trigger_rate_tariff_update(): Promise<Reply>;
+  /**
+   * Gets a snapshot of cached vehicle telemetry.
+   * @param topics Topics to include.
+   * @param cursor Return only what changed since this cursor.
+   */
+  telemetry(topics?: TelemetryTopics, cursor?: number | null): Promise<Reply>;
+  /** Creates a cursor-aware reader of this vehicle's cached telemetry. */
+  create_telemetry_tracker(topics?: TelemetryTopics): TeslemetryVehicleTelemetry;
+}
+/** A cursor-aware vehicle telemetry reader, keeping a snapshot merged from each update. */
+export declare class TeslemetryVehicleTelemetry {
+  /** The cursor the next `update()` sends. */
+  cursor: number;
+  /** Everything received so far. `data` merges field by field; other topics are replaced whole. */
+  snapshot: Record<string, any>;
+  private readonly _parent;
+  private readonly _topics;
+  constructor(parent: TeslemetryVehicle, topics?: TelemetryTopics);
+  /**
+   * 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`.
+   */
+  update(): Promise<Reply>;
+}
+/** Creates `TeslemetryVehicle`s. Teslemetry cannot use the Fleet API directly, so `create` is the only factory. */
+export declare class TeslemetryVehicles extends Vehicle {
+  /** Class `create` instantiates; a subclass overrides it to supply its own vehicle type. */
+  static Vehicle: new (parent: Vehicle, vin: string) => TeslemetryVehicle;
+  parent: Teslemetry;
+  byVin: Map<string, TeslemetryVehicle>;
+  readonly createFleet: never;
+  readonly createSigned: never;
+  readonly specific: never;
+  readonly specificSigned: never;
+  /** Creates a vehicle, and records it by VIN. */
+  create(vin: string): TeslemetryVehicle;
+}
+export {};