tesla-fleet-api 0.0.10 → 0.0.12

package/src/teslafleetapi.ts

@@ -4,9 +4,10 @@ import Partner from "./partner.js";
 import User from "./user.js";
 import Vehicle from "./vehicle.js";
 
-import { Method } from "./types.js";
+import { ProductsResponse } from "./types/products.js";
 
-export type Region = "na" | "eu" | "cn";
+type Region = "na" | "eu" | "cn";
+type Method = "GET" | "POST" | "PUT" | "DELETE";
 
 const servers: Record<Region, string> = {
     na: "https://fleet-api.prd.na.vn.cloud.tesla.com",
@@ -116,7 +117,7 @@ export default class TeslaFleetApi {
         });
     }
 
-    async products(): Promise<Record<string, any>> {
-        return this._request("GET", "api/1/products");
+    async products(): Promise<ProductsResponse> {
+        return this._request("GET", "api/1/products").then(({ data }) => data.response);
     }
 }

package/src/teslemetry.ts

@@ -1,7 +1,17 @@
 import TeslaFleetApi from "./teslafleetapi.js";
+import { Scope } from "./types/commands.js";
 
 type Region = "na" | "eu" | "api";
 
+type Test = { response: boolean };
+
+type Metadata = {
+    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 });
@@ -10,18 +20,18 @@ export default class Telemetry extends TeslaFleetApi {
     /**
      * Test the connection to Teslemetry
      */
-    async test() {
-        return this._request("GET", "/api/test");
+    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) {
-        this._request("GET", "/api/metadata").then((metadata) => {
+    async metadata(update_region = true): Promise<Metadata> {
+        return this._request("GET", "/api/metadata").then((metadata) => {
             if (update_region) {
-                this.server = `https://${metadata.region}.teslemetry.com`;
+                this.server = `https://${metadata.region.toLowerCase()}.teslemetry.com`;
             }
             return metadata;
         });

package/src/tessie.ts

@@ -1,5 +1,5 @@
 import TeslaFleetApi from "./teslafleetapi.js";
-import { Scope } from "./types.js";
+import { Scope } from "./types/commands.js";
 
 export default class Telemetry extends TeslaFleetApi {
     constructor(accessToken: string) {

package/src/{types.ts → types/commands.ts}

@@ -3,7 +3,7 @@ export interface CommandResponse {
         result: boolean;
         reason: string;
     };
-    error: string;
+    error?: string;
 }
 
 export type Scope =
@@ -15,11 +15,6 @@ export type Scope =
     | "energy_cmds"
     | "offline_access"
     | "openid";
-export type Method = "GET" | "POST" | "PUT" | "DELETE";
-
-export interface RequestFunction {
-    (method: Method, endpoint: string, data?: Record<string, any>): Promise<Record<string, any>>;
-}
 
 // Vehicles
 

package/src/types/live_status.ts

@@ -0,0 +1,27 @@
+export type LiveStatusResponse = {
+    solar_power?: number;
+    energy_left?: number;
+    total_pack_energy?: number;
+    percentage_charged?: number;
+    backup_capable?: boolean;
+    battery_power?: number;
+    load_power?: number;
+    grid_status?: string;
+    grid_services_active?: boolean;
+    grid_power?: number;
+    grid_services_power?: number;
+    generator_power?: number;
+    island_status?: string;
+    storm_mode_active?: boolean;
+    timestamp: Date;
+    wall_connectors?: WallConnector[];
+};
+
+export type WallConnector = {
+    din: string;
+    vin?: string;
+    wall_connector_state: number;
+    wall_connector_fault_state: number;
+    wall_connector_power: number;
+    ocpp_status: number;
+};

package/src/types/products.ts

@@ -0,0 +1,59 @@
+import { VehicleResponse } from "./vehicle.js";
+import { VehicleConfig } from "./vehicle_data.js";
+
+export type ProductsResponse = {
+    response: (VehicleProduct | EnergyProduct)[];
+    count: number;
+};
+
+export type VehicleProduct = VehicleResponse & {
+    vehicle_config: VehicleConfig;
+    command_signing: string;
+    release_notes_supported: boolean;
+};
+
+export type EnergyProduct = {
+    energy_site_id: number;
+    resource_type: string;
+    site_name: string;
+    id: string;
+    gateway_id: string;
+    asset_site_id: string;
+    warp_site_number: string;
+    energy_left: number;
+    total_pack_energy: number;
+    percentage_charged: number;
+    battery_type: string;
+    backup_capable: boolean;
+    battery_power: number;
+    go_off_grid_test_banner_enabled: null | boolean;
+    storm_mode_enabled: boolean;
+    powerwall_onboarding_settings_set: boolean;
+    powerwall_tesla_electric_interested_in: null | boolean;
+    vpp_tour_enabled: null | boolean;
+    sync_grid_alert_enabled: boolean;
+    breaker_alert_enabled: boolean;
+    components: Components;
+    features: Features;
+};
+
+export type Components = {
+    battery: boolean;
+    battery_type: string;
+    solar: boolean;
+    solar_type: string;
+    grid: boolean;
+    load_meter: boolean;
+    market_type: string;
+    wall_connectors: WallConnector[];
+};
+
+export type WallConnector = {
+    device_id: string;
+    din: string;
+    is_active: boolean;
+};
+
+export type Features = {
+    rate_plan_manager_no_pricing_constraint: boolean;
+};

package/src/types/responses.ts

@@ -0,0 +1 @@
+export type OptionsResponse = { code: string; displayName: string; isActive: boolean }[];

package/src/types/site_info.ts

@@ -0,0 +1,129 @@
+export type SiteInfoResponse = {
+    id: string;
+    site_name: string;
+    backup_reserve_percent: number;
+    default_real_mode: string;
+    installation_date: Date;
+    user_settings: UserSettings;
+    components: Components;
+    version?: string;
+    battery_count?: number;
+    tou_settings?: TouSettings;
+    nameplate_power?: number;
+    nameplate_energy?: number;
+    installation_time_zone: string;
+    max_site_meter_power_ac?: number;
+    min_site_meter_power_ac?: number;
+    vpp_backup_reserve_percent?: number;
+    tariff_content_v2?: TariffContentV2;
+};
+
+export type Components = {
+    solar: boolean;
+    solar_type?: string;
+    battery: boolean;
+    grid: boolean;
+    backup: boolean;
+    gateway: string;
+    load_meter: boolean;
+    tou_capable: boolean;
+    storm_mode_capable: boolean;
+    flex_energy_request_capable: boolean;
+    car_charging_data_supported: boolean;
+    off_grid_vehicle_charging_reserve_supported: boolean;
+    vehicle_charging_performance_view_enabled: boolean;
+    vehicle_charging_solar_offset_view_enabled: boolean;
+    battery_solar_offset_view_enabled: boolean;
+    solar_value_enabled?: boolean;
+    energy_value_header?: string;
+    energy_value_subheader?: string;
+    energy_service_self_scheduling_enabled: boolean;
+    show_grid_import_battery_source_cards?: boolean;
+    set_islanding_mode_enabled?: boolean;
+    wifi_commissioning_enabled?: boolean;
+    backup_time_remaining_enabled?: boolean;
+    battery_type?: string;
+    configurable?: boolean;
+    grid_services_enabled?: boolean;
+    gateways?: Gateway[];
+    batteries?: Battery[];
+    wall_connectors?: WallConnector[];
+    disallow_charge_from_grid_with_solar_installed?: boolean;
+    customer_preferred_export_rule?: string;
+    net_meter_mode?: string;
+    system_alerts_enabled?: boolean;
+    nbt_supported?: boolean;
+};
+
+export type Battery = {
+    device_id: string;
+    din: string;
+    serial_number: string;
+    part_number: string;
+    part_type: number;
+    part_name: string;
+    nameplate_max_charge_power: number;
+    nameplate_max_discharge_power: number;
+    nameplate_energy: number;
+};
+
+export type Gateway = {
+    device_id: string;
+    din: string;
+    serial_number: string;
+    part_number: string;
+    part_type: number;
+    part_name: string;
+    is_active: boolean;
+    site_id: string;
+    firmware_version: string;
+    updated_datetime: Date;
+};
+
+export type WallConnector = {
+    device_id: string;
+    din: string;
+    part_name: string;
+    is_active: boolean;
+};
+
+export type TouSettings = {
+    optimization_strategy: string;
+    schedule: Schedule[];
+};
+
+export type Schedule = {
+    target: string;
+    week_days: number[];
+    start_seconds: number;
+    end_seconds: number;
+};
+
+export type UserSettings = {
+    go_off_grid_test_banner_enabled: boolean;
+    storm_mode_enabled: boolean;
+    powerwall_onboarding_settings_set: boolean;
+    powerwall_tesla_electric_interested_in: boolean;
+    vpp_tour_enabled: boolean;
+    sync_grid_alert_enabled: boolean;
+    breaker_alert_enabled: boolean;
+    off_grid_vehicle_charging_enabled: boolean;
+};
+
+export type TariffContentV2 = {
+    version: 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>;
+    demand_charges: Record<string, any>;
+    energy_charges: Record<string, any>;
+    seasons: Record<string, any>[];
+    sell_tariff: Record<string, any>;
+};

package/src/types/vehicle.ts

@@ -0,0 +1,23 @@
+export type VehicleResponse = {
+    id: number;
+    vehicle_id: number;
+    vin: string;
+    color: null;
+    access_type: string;
+    display_name: string;
+    option_codes: null;
+    granular_access: GranularAccess;
+    tokens: string[];
+    state: string;
+    in_service: boolean;
+    id_s: string;
+    calendar_enabled: boolean;
+    api_version: number;
+    backseat_token: null;
+    backseat_token_updated_at: null;
+    ble_autopair_enrolled: boolean;
+};
+
+export type GranularAccess = {
+    hide_private: boolean;
+};

package/src/types/vehicle_data.ts

@@ -0,0 +1,286 @@
+import { VehicleResponse } from "./vehicle.js";
+
+export type VehicleDataResponse = VehicleResponse & {
+    charge_state: ChargeState;
+    climate_state: ClimateState;
+    drive_state: DriveState;
+    gui_settings: GUISettings;
+    vehicle_config: VehicleConfig;
+    vehicle_state: VehicleState;
+};
+
+export type ChargeState = {
+    battery_heater_on: boolean;
+    battery_level: number;
+    battery_range: number;
+    charge_amps: number;
+    charge_current_request: number;
+    charge_current_request_max: number;
+    charge_enable_request: boolean;
+    charge_energy_added: number;
+    charge_limit_soc: number;
+    charge_limit_soc_max: number;
+    charge_limit_soc_min: number;
+    charge_limit_soc_std: number;
+    charge_miles_added_ideal: number;
+    charge_miles_added_rated: number;
+    charge_port_cold_weather_mode: boolean;
+    charge_port_color: string;
+    charge_port_door_open: boolean;
+    charge_port_latch: string;
+    charge_rate: number;
+    charger_actual_current: number;
+    charger_phases: null;
+    charger_pilot_current: number;
+    charger_power: number;
+    charger_voltage: number;
+    charging_state: string;
+    conn_charge_cable: string;
+    est_battery_range: number;
+    fast_charger_brand: string;
+    fast_charger_present: boolean;
+    fast_charger_type: string;
+    ideal_battery_range: number;
+    max_range_charge_counter: number;
+    minutes_to_full_charge: number;
+    not_enough_power_to_heat: null;
+    off_peak_charging_enabled: boolean;
+    off_peak_charging_times: string;
+    off_peak_hours_end_time: number;
+    preconditioning_enabled: boolean;
+    preconditioning_times: string;
+    scheduled_charging_mode: string;
+    scheduled_charging_pending: boolean;
+    scheduled_charging_start_time: null;
+    scheduled_charging_start_time_app: number;
+    scheduled_departure_time: number;
+    scheduled_departure_time_minutes: number;
+    supercharger_session_trip_planner: boolean;
+    time_to_full_charge: number;
+    timestamp: number;
+    trip_charging: boolean;
+    usable_battery_level: number;
+    user_charge_enable_request: null;
+};
+
+export type ClimateState = {
+    allow_cabin_overheat_protection: boolean;
+    auto_seat_climate_left: boolean;
+    auto_seat_climate_right: boolean;
+    auto_steering_wheel_heat: boolean;
+    battery_heater: boolean;
+    battery_heater_no_power: null;
+    cabin_overheat_protection: string;
+    cabin_overheat_protection_actively_cooling: boolean;
+    climate_keeper_mode: string;
+    cop_activation_temperature: string;
+    defrost_mode: number;
+    driver_temp_setting: number;
+    fan_status: number;
+    hvac_auto_request: string;
+    inside_temp: number;
+    is_auto_conditioning_on: boolean;
+    is_climate_on: boolean;
+    is_front_defroster_on: boolean;
+    is_preconditioning: boolean;
+    is_rear_defroster_on: boolean;
+    left_temp_direction: number;
+    max_avail_temp: number;
+    min_avail_temp: number;
+    outside_temp: number;
+    passenger_temp_setting: number;
+    remote_heater_control_enabled: boolean;
+    right_temp_direction: number;
+    seat_heater_left: number;
+    seat_heater_rear_center: number;
+    seat_heater_rear_left: number;
+    seat_heater_rear_right: number;
+    seat_heater_right: number;
+    side_mirror_heaters: boolean;
+    steering_wheel_heat_level: number;
+    steering_wheel_heater: boolean;
+    supports_fan_only_cabin_overheat_protection: boolean;
+    timestamp: number;
+    wiper_blade_heater: boolean;
+};
+
+export type DriveState = {
+    active_route_latitude: number;
+    active_route_longitude: number;
+    active_route_miles_to_arrival: number;
+    active_route_minutes_to_arrival: number;
+    active_route_traffic_minutes_delay: number;
+    gps_as_of: number;
+    heading: number;
+    latitude: number;
+    longitude: number;
+    native_latitude: number;
+    native_location_supported: number;
+    native_longitude: number;
+    native_type: string;
+    power: number;
+    shift_state: null;
+    speed: null;
+    timestamp: number;
+};
+
+export type GranularAccess = {
+    hide_private: boolean;
+};
+
+export type GUISettings = {
+    gui_24_hour_time: boolean;
+    gui_charge_rate_units: string;
+    gui_distance_units: string;
+    gui_range_display: string;
+    gui_temperature_units: string;
+    gui_tirepressure_units: string;
+    show_range_units: boolean;
+    timestamp: number;
+};
+
+export type VehicleConfig = {
+    aux_park_lamps: string;
+    badge_version: number;
+    can_accept_navigation_requests: boolean;
+    can_actuate_trunks: boolean;
+    car_special_type: string;
+    car_type: string;
+    charge_port_type: string;
+    cop_user_set_temp_supported: boolean;
+    dashcam_clip_save_supported: boolean;
+    default_charge_to_max: boolean;
+    driver_assist: string;
+    ece_restrictions: boolean;
+    efficiency_package: string;
+    eu_vehicle: boolean;
+    exterior_color: string;
+    exterior_trim: string;
+    exterior_trim_override: string;
+    has_air_suspension: boolean;
+    has_ludicrous_mode: boolean;
+    has_seat_cooling: boolean;
+    headlamp_type: string;
+    interior_trim_type: string;
+    key_version: number;
+    motorized_charge_port: boolean;
+    paint_color_override: string;
+    performance_package: string;
+    plg: boolean;
+    pws: boolean;
+    rear_drive_unit: string;
+    rear_seat_heaters: number;
+    rear_seat_type: number;
+    rhd: boolean;
+    roof_color: string;
+    seat_type: null;
+    spoiler_type: string;
+    sun_roof_installed: null;
+    supports_qr_pairing: boolean;
+    third_row_seats: string;
+    timestamp: number;
+    trim_badging: string;
+    use_range_badging: boolean;
+    utc_offset: number;
+    webcam_selfie_supported: boolean;
+    webcam_supported: boolean;
+    wheel_type: string;
+};
+
+export type VehicleState = {
+    api_version: number;
+    autopark_state_v2: string;
+    calendar_supported: boolean;
+    car_version: string;
+    center_display_state: number;
+    dashcam_clip_save_available: boolean;
+    dashcam_state: string;
+    df: number;
+    dr: number;
+    fd_window: number;
+    feature_bitmask: string;
+    fp_window: number;
+    ft: number;
+    is_user_present: boolean;
+    locked: boolean;
+    media_info: MediaInfo;
+    media_state: MediaState;
+    notifications_supported: boolean;
+    odometer: number;
+    parsed_calendar_supported: boolean;
+    pf: number;
+    pr: number;
+    rd_window: number;
+    remote_start: boolean;
+    remote_start_enabled: boolean;
+    remote_start_supported: boolean;
+    rp_window: number;
+    rt: number;
+    santa_mode: number;
+    sentry_mode: boolean;
+    sentry_mode_available: boolean;
+    service_mode: boolean;
+    service_mode_plus: boolean;
+    software_update: SoftwareUpdate;
+    speed_limit_mode: SpeedLimitMode;
+    timestamp: number;
+    tpms_hard_warning_fl: boolean;
+    tpms_hard_warning_fr: boolean;
+    tpms_hard_warning_rl: boolean;
+    tpms_hard_warning_rr: boolean;
+    tpms_last_seen_pressure_time_fl: number;
+    tpms_last_seen_pressure_time_fr: number;
+    tpms_last_seen_pressure_time_rl: number;
+    tpms_last_seen_pressure_time_rr: number;
+    tpms_pressure_fl: number;
+    tpms_pressure_fr: number;
+    tpms_pressure_rl: number;
+    tpms_pressure_rr: number;
+    tpms_rcp_front_value: number;
+    tpms_rcp_rear_value: number;
+    tpms_soft_warning_fl: boolean;
+    tpms_soft_warning_fr: boolean;
+    tpms_soft_warning_rl: boolean;
+    tpms_soft_warning_rr: boolean;
+    valet_mode: boolean;
+    valet_pin_needed: boolean;
+    vehicle_name: string;
+    vehicle_self_test_progress: number;
+    vehicle_self_test_requested: boolean;
+    webcam_available: boolean;
+};
+
+export type MediaInfo = {
+    a2dp_source_name: string;
+    audio_volume: number;
+    audio_volume_increment: number;
+    audio_volume_max: number;
+    media_playback_status: string;
+    now_playing_album: string;
+    now_playing_artist: string;
+    now_playing_duration: number;
+    now_playing_elapsed: number;
+    now_playing_source: string;
+    now_playing_station: string;
+    now_playing_title: string;
+};
+
+export type MediaState = {
+    remote_control_enabled: boolean;
+};
+
+export type SoftwareUpdate = {
+    download_perc: number;
+    expected_duration_sec: number;
+    install_perc: number;
+    status: string;
+    version: string;
+};
+
+export type SpeedLimitMode = {
+    active: boolean;
+    current_limit_mph: number;
+    max_limit_mph: number;
+    min_limit_mph: number;
+    pin_code_set: boolean;
+};

package/src/user.ts

@@ -1,5 +1,5 @@
 import TeslaFleetApi from "./teslafleetapi.js";
-import { CommandResponse } from "./types.js";
+import { CommandResponse } from "./types/commands.js";
 
 export default class User {
     parent: TeslaFleetApi;

package/src/vehicle.ts

@@ -1,5 +1,8 @@
 import TeslaFleetApi from "./teslafleetapi.js";
-import { ClimateMode, ClimateModes, CommandResponse, FleetTelemetryConfig, Level, Seat, Seats, Trunk, VehicleDataEndpoint } from "./types.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 { VehicleDataResponse } from "./types/vehicle_data.js";
 import VehicleSpecific from "./vehiclespecific.js";
 
 const Models: Record<string, string> = {
@@ -671,8 +674,8 @@ export default class Vehicle {
      * Returns all allowed drivers for a vehicle. This endpoint is only available for the vehicle owner.
      * @param vehicle_tag VIN or id field of a vehicle
      */
-    async drivers(vehicle_tag: string | number): Promise<Record<string, any>> {
-        return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/drivers`);
+    async drivers(vehicle_tag: string | number): Promise<Record<string, any>[]> {
+        return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/drivers`).then(({ response }) => response);
     }
 
     /**
@@ -768,8 +771,8 @@ export default class Vehicle {
      * Returns vehicle option details.
      * @param vin Vehicle Identification Number
      */
-    async options(vin: string): Promise<Record<string, any>> {
-        return this.parent._request("GET", "api/1/dx/vehicles/options", { vin });
+    async options(vin: string): Promise<OptionsResponse> {
+        return this.parent._request("GET", "api/1/dx/vehicles/options", { vin }).then(({ codes }) => codes);
     }
 
     /**
@@ -845,8 +848,8 @@ export default class Vehicle {
      * Returns information about a vehicle.
      * @param vehicle_tag VIN or id field of a vehicle
      */
-    async vehicle(vehicle_tag: string | number): Promise<Record<string, any>> {
-        return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}`);
+    async vehicle(vehicle_tag: string | number): Promise<VehicleResponse> {
+        return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}`).then(({ data }) => data.response);
     }
 
     /**
@@ -854,9 +857,9 @@ export default class Vehicle {
      * @param vehicle_tag VIN or id field of a vehicle
      * @param endpoints
      */
-    async vehicle_data(vehicle_tag: string | number, endpoints?: VehicleDataEndpoint[] | string): Promise<Record<string, any>> {
+    async vehicle_data(vehicle_tag: string | number, endpoints?: VehicleDataEndpoint[] | string): Promise<VehicleDataResponse> {
         if (typeof endpoints === "object") endpoints = endpoints.join(";");
-        return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/vehicle_data`, { endpoints });
+        return this.parent._request("GET", `api/1/vehicles/${vehicle_tag}/vehicle_data`, { endpoints }).then(({ data }) => data.response);
     }
 
     /**