@teslemetry/api 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs CHANGED
@@ -3115,8 +3115,8 @@ var TeslemetryStream = class extends events.EventEmitter {
3115
3115
  this.cloudCache = options.cache;
3116
3116
  this.localCache = options.cache;
3117
3117
  } else {
3118
- this.cloudCache = options?.cache?.cloud;
3119
- this.localCache = options?.cache?.local;
3118
+ this.cloudCache = options?.cache?.cloud ?? true;
3119
+ this.localCache = options?.cache?.local ?? true;
3120
3120
  }
3121
3121
  this.logger = root.logger;
3122
3122
  if (this.vin) this.getVehicle(this.vin);
@@ -5045,7 +5045,7 @@ const consoleLogger = {
5045
5045
 
5046
5046
  //#endregion
5047
5047
  //#region package.json
5048
- var version = "0.5.1";
5048
+ var version = "0.5.2";
5049
5049
 
5050
5050
  //#endregion
5051
5051
  //#region src/Teslemetry.ts
package/dist/index.d.cts CHANGED
@@ -7988,86 +7988,192 @@ type GetApi1EnergySitesByIdSiteInfoResponses = {
7988
7988
  * Default Response
7989
7989
  */
7990
7990
  200: {
7991
- response?: {
7992
- id?: string;
7991
+ response: {
7992
+ id: string;
7993
7993
  site_name?: string;
7994
- site_number?: string;
7995
7994
  backup_reserve_percent?: number;
7996
7995
  default_real_mode?: string;
7997
- installation_date?: string;
7998
- user_settings?: {
7999
- go_off_grid_test_banner_enabled?: null | boolean;
8000
- storm_mode_enabled?: null | boolean;
8001
- powerwall_onboarding_settings_set?: null | boolean;
8002
- powerwall_tesla_electric_interested_in?: null | boolean;
8003
- vpp_tour_enabled?: null | boolean;
8004
- off_grid_vehicle_charging_enabled?: null | boolean;
8005
- };
8006
- components?: {
8007
- solar?: boolean;
7996
+ installation_date: string;
7997
+ user_settings: {
7998
+ go_off_grid_test_banner_enabled: null | boolean;
7999
+ storm_mode_enabled: null | boolean;
8000
+ powerwall_onboarding_settings_set: null | boolean;
8001
+ powerwall_tesla_electric_interested_in: null | boolean;
8002
+ vpp_tour_enabled: null | boolean;
8003
+ off_grid_vehicle_charging_enabled: null | boolean;
8004
+ };
8005
+ components: {
8006
+ solar: boolean;
8008
8007
  solar_type?: string;
8009
- battery?: boolean;
8010
- grid?: boolean;
8011
- backup?: boolean;
8012
- gateway?: string;
8013
- load_meter?: boolean;
8014
- tou_capable?: boolean;
8015
- storm_mode_capable?: boolean;
8016
- off_grid_vehicle_charging_reserve_supported?: boolean;
8017
- vehicle_charging_performance_view_enabled?: boolean;
8018
- vehicle_charging_solar_offset_view_enabled?: boolean;
8019
- battery_solar_offset_view_enabled?: boolean;
8020
- energy_service_self_scheduling_enabled?: boolean;
8008
+ battery: boolean;
8009
+ grid: boolean;
8010
+ backup: boolean;
8011
+ gateway: string;
8012
+ load_meter: boolean;
8013
+ tou_capable: boolean;
8014
+ storm_mode_capable: boolean;
8015
+ off_grid_vehicle_charging_reserve_supported: boolean;
8016
+ vehicle_charging_performance_view_enabled: boolean;
8017
+ vehicle_charging_solar_offset_view_enabled: boolean;
8018
+ battery_solar_offset_view_enabled: boolean;
8019
+ solar_value_enabled?: boolean;
8020
+ energy_value_header?: string;
8021
+ energy_value_subheader?: string;
8022
+ energy_service_self_scheduling_enabled: boolean;
8023
+ show_battery_soe_graph?: boolean;
8024
+ show_grid_import_battery_source_cards?: boolean;
8025
+ set_islanding_mode_enabled?: boolean;
8026
+ wifi_commissioning_enabled?: boolean;
8027
+ backup_time_remaining_enabled?: boolean;
8028
+ battery_type?: string;
8029
+ configurable?: boolean;
8030
+ grid_services_enabled?: boolean;
8031
+ gateways?: Array<{
8032
+ device_id: string;
8033
+ din: string;
8034
+ serial_number: string;
8035
+ part_number: string;
8036
+ part_type: number;
8037
+ part_name: string;
8038
+ is_active: boolean;
8039
+ site_id: string;
8040
+ firmware_version: string;
8041
+ updated_datetime: string;
8042
+ leader_device_id?: string;
8043
+ }>;
8044
+ customer_preferred_export_rule?: string;
8045
+ edit_setting_permission_to_export?: boolean;
8046
+ edit_setting_grid_charging?: boolean;
8047
+ edit_setting_energy_exports?: boolean;
8048
+ system_alerts_enabled?: boolean;
8049
+ service_mode_enabled?: boolean;
8050
+ support_manual_backup?: boolean;
8051
+ rate_tariff_service_options: {
8052
+ rate_plan_configured_by_rts: boolean;
8053
+ rate_tariff_service_enabled: boolean;
8054
+ request_export_tariff: boolean;
8055
+ request_network_fees: boolean;
8056
+ };
8021
8057
  wall_connectors?: Array<{
8022
- device_id?: string;
8023
- din?: string;
8024
- serial_number?: string;
8025
- part_number?: string;
8058
+ device_id: string;
8059
+ din: string;
8060
+ serial_number: string;
8061
+ part_number: string;
8062
+ part_type: number;
8063
+ part_name: string;
8064
+ is_active: boolean;
8065
+ }>;
8066
+ net_meter_mode?: string;
8067
+ batteries?: Array<{
8068
+ device_id: string;
8069
+ din: string;
8070
+ serial_number: string;
8071
+ part_number: string;
8026
8072
  part_type?: number;
8027
8073
  part_name?: string;
8028
- is_active?: boolean;
8074
+ nameplate_max_charge_power: number;
8075
+ nameplate_max_discharge_power: number;
8076
+ nameplate_energy: number;
8077
+ is_active: boolean;
8029
8078
  }>;
8030
- nbt_supported?: boolean;
8031
- system_alerts_enabled?: boolean;
8032
- rate_tariff_service_options?: {
8033
- rate_plan_configured_by_rts?: boolean;
8034
- rate_tariff_service_enabled?: boolean;
8035
- request_export_tariff?: boolean;
8036
- request_network_fees?: boolean;
8079
+ non_export_configured?: boolean;
8080
+ disallow_charge_from_grid_with_solar_installed?: boolean;
8081
+ ITC_cliff?: number;
8082
+ sunrun_options?: {
8083
+ my_home_info_deeplink_enabled: boolean;
8084
+ support_screen_deeplink_enabled: boolean;
8037
8085
  };
8038
- solar_value_enabled?: boolean;
8039
- set_islanding_mode_enabled?: boolean;
8040
- battery_type?: string;
8041
- configurable?: boolean;
8086
+ inverters?: Array<{
8087
+ device_id: string;
8088
+ din: string;
8089
+ serial_number: string;
8090
+ part_number: string;
8091
+ part_type: number;
8092
+ part_name: string;
8093
+ is_active: boolean;
8094
+ site_id: string;
8095
+ firmware_version?: string;
8096
+ }>;
8097
+ nbt_supported?: boolean;
8098
+ local_offline_monitoring_enabled?: boolean;
8099
+ hide_time_of_use_card?: boolean;
8042
8100
  };
8043
8101
  version?: string;
8044
8102
  battery_count?: number;
8103
+ /**
8104
+ * See https://digitalassets-energy.tesla.com/raw/upload/app/fleet-api/example-tariff/PGE-EV2-A.json for example
8105
+ */
8106
+ tariff_content?: {
8107
+ [key: string]: unknown;
8108
+ };
8045
8109
  nameplate_power?: number;
8046
- nameplate_energy?: number;
8047
8110
  installation_time_zone?: string;
8048
8111
  max_site_meter_power_ac?: number;
8049
8112
  min_site_meter_power_ac?: number;
8113
+ /**
8114
+ * See https://digitalassets-energy.tesla.com/raw/upload/app/fleet-api/example-tariff/PGE-EV2-A.json for example
8115
+ */
8050
8116
  tariff_content_v2?: {
8051
- name?: string;
8052
- utility?: string;
8053
- version?: number;
8054
- daily_charges?: Array<{
8055
- name?: string;
8117
+ [key: string]: unknown;
8118
+ };
8119
+ vpp_backup_reserve_percent?: number;
8120
+ utility?: string;
8121
+ island_config?: {
8122
+ low_soe_limit?: number;
8123
+ jump_start_soe_threshold?: number;
8124
+ wait_for_solar_retry_soe?: number;
8125
+ max_frequency_shift_hz?: number;
8126
+ wait_for_solar_soe_threshold?: number;
8127
+ microgrid_not_ok_timeout?: number;
8128
+ manual_backup?: boolean;
8129
+ neutral_balancer_type?: string;
8130
+ };
8131
+ vehicle_charging_settings?: {
8132
+ evses: Array<{
8133
+ din: string;
8134
+ smart_charging?: {
8135
+ enable?: boolean;
8136
+ schedules?: Array<{
8137
+ time: string;
8138
+ }>;
8139
+ min_hours_charging?: number;
8140
+ };
8141
+ modbus_id?: number;
8056
8142
  }>;
8057
- demand_charges?: {
8058
- [key: string]: unknown;
8059
- };
8060
- energy_charges?: {
8061
- [key: string]: unknown;
8062
- };
8063
- seasons?: {
8064
- [key: string]: unknown;
8065
- };
8066
- sell_tariff?: {
8067
- [key: string]: unknown;
8143
+ };
8144
+ nameplate_energy?: number;
8145
+ off_grid_vehicle_charging_reserve_percent?: number;
8146
+ tariff_id?: string;
8147
+ site_number?: string;
8148
+ time_zone_offset?: number;
8149
+ app_settings?: {
8150
+ live_status_local_refresh_s: number;
8151
+ };
8152
+ csip?: {
8153
+ dcap_url: string;
8154
+ device_certificate: string;
8155
+ csip_australia: {
8156
+ national_meter_identifier: string;
8068
8157
  };
8069
8158
  };
8159
+ external_switch?: {
8160
+ input_type: string;
8161
+ control_behavior: string;
8162
+ };
8163
+ aggregation_program?: {
8164
+ name: string;
8165
+ description: string;
8166
+ link_name: string;
8167
+ link_url: string;
8168
+ };
8169
+ tesla_electric_billing_periods?: Array<{
8170
+ start_time: string;
8171
+ end_time: string;
8172
+ }>;
8070
8173
  };
8174
+ error?: string;
8175
+ error_description?: string;
8176
+ txid?: string;
8071
8177
  };
8072
8178
  };
8073
8179
  type GetApi1EnergySitesByIdSiteInfoResponse = GetApi1EnergySitesByIdSiteInfoResponses[keyof GetApi1EnergySitesByIdSiteInfoResponses];
@@ -10115,86 +10221,186 @@ declare class TeslemetryEnergyApi extends EventEmitter {
10115
10221
  * @return Promise to an object with response containing detailed information about the energy site
10116
10222
  */
10117
10223
  getSiteInfo(): Promise<{
10118
- response?: {
10119
- id?: string;
10224
+ response: {
10225
+ id: string;
10120
10226
  site_name?: string;
10121
- site_number?: string;
10122
10227
  backup_reserve_percent?: number;
10123
10228
  default_real_mode?: string;
10124
- installation_date?: string;
10125
- user_settings?: {
10126
- go_off_grid_test_banner_enabled?: null | boolean;
10127
- storm_mode_enabled?: null | boolean;
10128
- powerwall_onboarding_settings_set?: null | boolean;
10129
- powerwall_tesla_electric_interested_in?: null | boolean;
10130
- vpp_tour_enabled?: null | boolean;
10131
- off_grid_vehicle_charging_enabled?: null | boolean;
10132
- };
10133
- components?: {
10134
- solar?: boolean;
10229
+ installation_date: string;
10230
+ user_settings: {
10231
+ go_off_grid_test_banner_enabled: null | boolean;
10232
+ storm_mode_enabled: null | boolean;
10233
+ powerwall_onboarding_settings_set: null | boolean;
10234
+ powerwall_tesla_electric_interested_in: null | boolean;
10235
+ vpp_tour_enabled: null | boolean;
10236
+ off_grid_vehicle_charging_enabled: null | boolean;
10237
+ };
10238
+ components: {
10239
+ solar: boolean;
10135
10240
  solar_type?: string;
10136
- battery?: boolean;
10137
- grid?: boolean;
10138
- backup?: boolean;
10139
- gateway?: string;
10140
- load_meter?: boolean;
10141
- tou_capable?: boolean;
10142
- storm_mode_capable?: boolean;
10143
- off_grid_vehicle_charging_reserve_supported?: boolean;
10144
- vehicle_charging_performance_view_enabled?: boolean;
10145
- vehicle_charging_solar_offset_view_enabled?: boolean;
10146
- battery_solar_offset_view_enabled?: boolean;
10147
- energy_service_self_scheduling_enabled?: boolean;
10241
+ battery: boolean;
10242
+ grid: boolean;
10243
+ backup: boolean;
10244
+ gateway: string;
10245
+ load_meter: boolean;
10246
+ tou_capable: boolean;
10247
+ storm_mode_capable: boolean;
10248
+ off_grid_vehicle_charging_reserve_supported: boolean;
10249
+ vehicle_charging_performance_view_enabled: boolean;
10250
+ vehicle_charging_solar_offset_view_enabled: boolean;
10251
+ battery_solar_offset_view_enabled: boolean;
10252
+ solar_value_enabled?: boolean;
10253
+ energy_value_header?: string;
10254
+ energy_value_subheader?: string;
10255
+ energy_service_self_scheduling_enabled: boolean;
10256
+ show_battery_soe_graph?: boolean;
10257
+ show_grid_import_battery_source_cards?: boolean;
10258
+ set_islanding_mode_enabled?: boolean;
10259
+ wifi_commissioning_enabled?: boolean;
10260
+ backup_time_remaining_enabled?: boolean;
10261
+ battery_type?: string;
10262
+ configurable?: boolean;
10263
+ grid_services_enabled?: boolean;
10264
+ gateways?: Array<{
10265
+ device_id: string;
10266
+ din: string;
10267
+ serial_number: string;
10268
+ part_number: string;
10269
+ part_type: number;
10270
+ part_name: string;
10271
+ is_active: boolean;
10272
+ site_id: string;
10273
+ firmware_version: string;
10274
+ updated_datetime: string;
10275
+ leader_device_id?: string;
10276
+ }>;
10277
+ customer_preferred_export_rule?: string;
10278
+ edit_setting_permission_to_export?: boolean;
10279
+ edit_setting_grid_charging?: boolean;
10280
+ edit_setting_energy_exports?: boolean;
10281
+ system_alerts_enabled?: boolean;
10282
+ service_mode_enabled?: boolean;
10283
+ support_manual_backup?: boolean;
10284
+ rate_tariff_service_options: {
10285
+ rate_plan_configured_by_rts: boolean;
10286
+ rate_tariff_service_enabled: boolean;
10287
+ request_export_tariff: boolean;
10288
+ request_network_fees: boolean;
10289
+ };
10148
10290
  wall_connectors?: Array<{
10149
- device_id?: string;
10150
- din?: string;
10151
- serial_number?: string;
10152
- part_number?: string;
10291
+ device_id: string;
10292
+ din: string;
10293
+ serial_number: string;
10294
+ part_number: string;
10295
+ part_type: number;
10296
+ part_name: string;
10297
+ is_active: boolean;
10298
+ }>;
10299
+ net_meter_mode?: string;
10300
+ batteries?: Array<{
10301
+ device_id: string;
10302
+ din: string;
10303
+ serial_number: string;
10304
+ part_number: string;
10153
10305
  part_type?: number;
10154
10306
  part_name?: string;
10155
- is_active?: boolean;
10307
+ nameplate_max_charge_power: number;
10308
+ nameplate_max_discharge_power: number;
10309
+ nameplate_energy: number;
10310
+ is_active: boolean;
10156
10311
  }>;
10157
- nbt_supported?: boolean;
10158
- system_alerts_enabled?: boolean;
10159
- rate_tariff_service_options?: {
10160
- rate_plan_configured_by_rts?: boolean;
10161
- rate_tariff_service_enabled?: boolean;
10162
- request_export_tariff?: boolean;
10163
- request_network_fees?: boolean;
10312
+ non_export_configured?: boolean;
10313
+ disallow_charge_from_grid_with_solar_installed?: boolean;
10314
+ ITC_cliff?: number;
10315
+ sunrun_options?: {
10316
+ my_home_info_deeplink_enabled: boolean;
10317
+ support_screen_deeplink_enabled: boolean;
10164
10318
  };
10165
- solar_value_enabled?: boolean;
10166
- set_islanding_mode_enabled?: boolean;
10167
- battery_type?: string;
10168
- configurable?: boolean;
10319
+ inverters?: Array<{
10320
+ device_id: string;
10321
+ din: string;
10322
+ serial_number: string;
10323
+ part_number: string;
10324
+ part_type: number;
10325
+ part_name: string;
10326
+ is_active: boolean;
10327
+ site_id: string;
10328
+ firmware_version?: string;
10329
+ }>;
10330
+ nbt_supported?: boolean;
10331
+ local_offline_monitoring_enabled?: boolean;
10332
+ hide_time_of_use_card?: boolean;
10169
10333
  };
10170
10334
  version?: string;
10171
10335
  battery_count?: number;
10336
+ tariff_content?: {
10337
+ [key: string]: unknown;
10338
+ };
10172
10339
  nameplate_power?: number;
10173
- nameplate_energy?: number;
10174
10340
  installation_time_zone?: string;
10175
10341
  max_site_meter_power_ac?: number;
10176
10342
  min_site_meter_power_ac?: number;
10177
10343
  tariff_content_v2?: {
10178
- name?: string;
10179
- utility?: string;
10180
- version?: number;
10181
- daily_charges?: Array<{
10182
- name?: string;
10344
+ [key: string]: unknown;
10345
+ };
10346
+ vpp_backup_reserve_percent?: number;
10347
+ utility?: string;
10348
+ island_config?: {
10349
+ low_soe_limit?: number;
10350
+ jump_start_soe_threshold?: number;
10351
+ wait_for_solar_retry_soe?: number;
10352
+ max_frequency_shift_hz?: number;
10353
+ wait_for_solar_soe_threshold?: number;
10354
+ microgrid_not_ok_timeout?: number;
10355
+ manual_backup?: boolean;
10356
+ neutral_balancer_type?: string;
10357
+ };
10358
+ vehicle_charging_settings?: {
10359
+ evses: Array<{
10360
+ din: string;
10361
+ smart_charging?: {
10362
+ enable?: boolean;
10363
+ schedules?: Array<{
10364
+ time: string;
10365
+ }>;
10366
+ min_hours_charging?: number;
10367
+ };
10368
+ modbus_id?: number;
10183
10369
  }>;
10184
- demand_charges?: {
10185
- [key: string]: unknown;
10186
- };
10187
- energy_charges?: {
10188
- [key: string]: unknown;
10189
- };
10190
- seasons?: {
10191
- [key: string]: unknown;
10192
- };
10193
- sell_tariff?: {
10194
- [key: string]: unknown;
10370
+ };
10371
+ nameplate_energy?: number;
10372
+ off_grid_vehicle_charging_reserve_percent?: number;
10373
+ tariff_id?: string;
10374
+ site_number?: string;
10375
+ time_zone_offset?: number;
10376
+ app_settings?: {
10377
+ live_status_local_refresh_s: number;
10378
+ };
10379
+ csip?: {
10380
+ dcap_url: string;
10381
+ device_certificate: string;
10382
+ csip_australia: {
10383
+ national_meter_identifier: string;
10195
10384
  };
10196
10385
  };
10386
+ external_switch?: {
10387
+ input_type: string;
10388
+ control_behavior: string;
10389
+ };
10390
+ aggregation_program?: {
10391
+ name: string;
10392
+ description: string;
10393
+ link_name: string;
10394
+ link_url: string;
10395
+ };
10396
+ tesla_electric_billing_periods?: Array<{
10397
+ start_time: string;
10398
+ end_time: string;
10399
+ }>;
10197
10400
  };
10401
+ error?: string;
10402
+ error_description?: string;
10403
+ txid?: string;
10198
10404
  }>;
10199
10405
  /**
10200
10406
  * Adjust the site's off-grid vehicle charging backup reserve.
package/dist/index.d.mts CHANGED
@@ -7988,86 +7988,192 @@ type GetApi1EnergySitesByIdSiteInfoResponses = {
7988
7988
  * Default Response
7989
7989
  */
7990
7990
  200: {
7991
- response?: {
7992
- id?: string;
7991
+ response: {
7992
+ id: string;
7993
7993
  site_name?: string;
7994
- site_number?: string;
7995
7994
  backup_reserve_percent?: number;
7996
7995
  default_real_mode?: string;
7997
- installation_date?: string;
7998
- user_settings?: {
7999
- go_off_grid_test_banner_enabled?: null | boolean;
8000
- storm_mode_enabled?: null | boolean;
8001
- powerwall_onboarding_settings_set?: null | boolean;
8002
- powerwall_tesla_electric_interested_in?: null | boolean;
8003
- vpp_tour_enabled?: null | boolean;
8004
- off_grid_vehicle_charging_enabled?: null | boolean;
8005
- };
8006
- components?: {
8007
- solar?: boolean;
7996
+ installation_date: string;
7997
+ user_settings: {
7998
+ go_off_grid_test_banner_enabled: null | boolean;
7999
+ storm_mode_enabled: null | boolean;
8000
+ powerwall_onboarding_settings_set: null | boolean;
8001
+ powerwall_tesla_electric_interested_in: null | boolean;
8002
+ vpp_tour_enabled: null | boolean;
8003
+ off_grid_vehicle_charging_enabled: null | boolean;
8004
+ };
8005
+ components: {
8006
+ solar: boolean;
8008
8007
  solar_type?: string;
8009
- battery?: boolean;
8010
- grid?: boolean;
8011
- backup?: boolean;
8012
- gateway?: string;
8013
- load_meter?: boolean;
8014
- tou_capable?: boolean;
8015
- storm_mode_capable?: boolean;
8016
- off_grid_vehicle_charging_reserve_supported?: boolean;
8017
- vehicle_charging_performance_view_enabled?: boolean;
8018
- vehicle_charging_solar_offset_view_enabled?: boolean;
8019
- battery_solar_offset_view_enabled?: boolean;
8020
- energy_service_self_scheduling_enabled?: boolean;
8008
+ battery: boolean;
8009
+ grid: boolean;
8010
+ backup: boolean;
8011
+ gateway: string;
8012
+ load_meter: boolean;
8013
+ tou_capable: boolean;
8014
+ storm_mode_capable: boolean;
8015
+ off_grid_vehicle_charging_reserve_supported: boolean;
8016
+ vehicle_charging_performance_view_enabled: boolean;
8017
+ vehicle_charging_solar_offset_view_enabled: boolean;
8018
+ battery_solar_offset_view_enabled: boolean;
8019
+ solar_value_enabled?: boolean;
8020
+ energy_value_header?: string;
8021
+ energy_value_subheader?: string;
8022
+ energy_service_self_scheduling_enabled: boolean;
8023
+ show_battery_soe_graph?: boolean;
8024
+ show_grid_import_battery_source_cards?: boolean;
8025
+ set_islanding_mode_enabled?: boolean;
8026
+ wifi_commissioning_enabled?: boolean;
8027
+ backup_time_remaining_enabled?: boolean;
8028
+ battery_type?: string;
8029
+ configurable?: boolean;
8030
+ grid_services_enabled?: boolean;
8031
+ gateways?: Array<{
8032
+ device_id: string;
8033
+ din: string;
8034
+ serial_number: string;
8035
+ part_number: string;
8036
+ part_type: number;
8037
+ part_name: string;
8038
+ is_active: boolean;
8039
+ site_id: string;
8040
+ firmware_version: string;
8041
+ updated_datetime: string;
8042
+ leader_device_id?: string;
8043
+ }>;
8044
+ customer_preferred_export_rule?: string;
8045
+ edit_setting_permission_to_export?: boolean;
8046
+ edit_setting_grid_charging?: boolean;
8047
+ edit_setting_energy_exports?: boolean;
8048
+ system_alerts_enabled?: boolean;
8049
+ service_mode_enabled?: boolean;
8050
+ support_manual_backup?: boolean;
8051
+ rate_tariff_service_options: {
8052
+ rate_plan_configured_by_rts: boolean;
8053
+ rate_tariff_service_enabled: boolean;
8054
+ request_export_tariff: boolean;
8055
+ request_network_fees: boolean;
8056
+ };
8021
8057
  wall_connectors?: Array<{
8022
- device_id?: string;
8023
- din?: string;
8024
- serial_number?: string;
8025
- part_number?: string;
8058
+ device_id: string;
8059
+ din: string;
8060
+ serial_number: string;
8061
+ part_number: string;
8062
+ part_type: number;
8063
+ part_name: string;
8064
+ is_active: boolean;
8065
+ }>;
8066
+ net_meter_mode?: string;
8067
+ batteries?: Array<{
8068
+ device_id: string;
8069
+ din: string;
8070
+ serial_number: string;
8071
+ part_number: string;
8026
8072
  part_type?: number;
8027
8073
  part_name?: string;
8028
- is_active?: boolean;
8074
+ nameplate_max_charge_power: number;
8075
+ nameplate_max_discharge_power: number;
8076
+ nameplate_energy: number;
8077
+ is_active: boolean;
8029
8078
  }>;
8030
- nbt_supported?: boolean;
8031
- system_alerts_enabled?: boolean;
8032
- rate_tariff_service_options?: {
8033
- rate_plan_configured_by_rts?: boolean;
8034
- rate_tariff_service_enabled?: boolean;
8035
- request_export_tariff?: boolean;
8036
- request_network_fees?: boolean;
8079
+ non_export_configured?: boolean;
8080
+ disallow_charge_from_grid_with_solar_installed?: boolean;
8081
+ ITC_cliff?: number;
8082
+ sunrun_options?: {
8083
+ my_home_info_deeplink_enabled: boolean;
8084
+ support_screen_deeplink_enabled: boolean;
8037
8085
  };
8038
- solar_value_enabled?: boolean;
8039
- set_islanding_mode_enabled?: boolean;
8040
- battery_type?: string;
8041
- configurable?: boolean;
8086
+ inverters?: Array<{
8087
+ device_id: string;
8088
+ din: string;
8089
+ serial_number: string;
8090
+ part_number: string;
8091
+ part_type: number;
8092
+ part_name: string;
8093
+ is_active: boolean;
8094
+ site_id: string;
8095
+ firmware_version?: string;
8096
+ }>;
8097
+ nbt_supported?: boolean;
8098
+ local_offline_monitoring_enabled?: boolean;
8099
+ hide_time_of_use_card?: boolean;
8042
8100
  };
8043
8101
  version?: string;
8044
8102
  battery_count?: number;
8103
+ /**
8104
+ * See https://digitalassets-energy.tesla.com/raw/upload/app/fleet-api/example-tariff/PGE-EV2-A.json for example
8105
+ */
8106
+ tariff_content?: {
8107
+ [key: string]: unknown;
8108
+ };
8045
8109
  nameplate_power?: number;
8046
- nameplate_energy?: number;
8047
8110
  installation_time_zone?: string;
8048
8111
  max_site_meter_power_ac?: number;
8049
8112
  min_site_meter_power_ac?: number;
8113
+ /**
8114
+ * See https://digitalassets-energy.tesla.com/raw/upload/app/fleet-api/example-tariff/PGE-EV2-A.json for example
8115
+ */
8050
8116
  tariff_content_v2?: {
8051
- name?: string;
8052
- utility?: string;
8053
- version?: number;
8054
- daily_charges?: Array<{
8055
- name?: string;
8117
+ [key: string]: unknown;
8118
+ };
8119
+ vpp_backup_reserve_percent?: number;
8120
+ utility?: string;
8121
+ island_config?: {
8122
+ low_soe_limit?: number;
8123
+ jump_start_soe_threshold?: number;
8124
+ wait_for_solar_retry_soe?: number;
8125
+ max_frequency_shift_hz?: number;
8126
+ wait_for_solar_soe_threshold?: number;
8127
+ microgrid_not_ok_timeout?: number;
8128
+ manual_backup?: boolean;
8129
+ neutral_balancer_type?: string;
8130
+ };
8131
+ vehicle_charging_settings?: {
8132
+ evses: Array<{
8133
+ din: string;
8134
+ smart_charging?: {
8135
+ enable?: boolean;
8136
+ schedules?: Array<{
8137
+ time: string;
8138
+ }>;
8139
+ min_hours_charging?: number;
8140
+ };
8141
+ modbus_id?: number;
8056
8142
  }>;
8057
- demand_charges?: {
8058
- [key: string]: unknown;
8059
- };
8060
- energy_charges?: {
8061
- [key: string]: unknown;
8062
- };
8063
- seasons?: {
8064
- [key: string]: unknown;
8065
- };
8066
- sell_tariff?: {
8067
- [key: string]: unknown;
8143
+ };
8144
+ nameplate_energy?: number;
8145
+ off_grid_vehicle_charging_reserve_percent?: number;
8146
+ tariff_id?: string;
8147
+ site_number?: string;
8148
+ time_zone_offset?: number;
8149
+ app_settings?: {
8150
+ live_status_local_refresh_s: number;
8151
+ };
8152
+ csip?: {
8153
+ dcap_url: string;
8154
+ device_certificate: string;
8155
+ csip_australia: {
8156
+ national_meter_identifier: string;
8068
8157
  };
8069
8158
  };
8159
+ external_switch?: {
8160
+ input_type: string;
8161
+ control_behavior: string;
8162
+ };
8163
+ aggregation_program?: {
8164
+ name: string;
8165
+ description: string;
8166
+ link_name: string;
8167
+ link_url: string;
8168
+ };
8169
+ tesla_electric_billing_periods?: Array<{
8170
+ start_time: string;
8171
+ end_time: string;
8172
+ }>;
8070
8173
  };
8174
+ error?: string;
8175
+ error_description?: string;
8176
+ txid?: string;
8071
8177
  };
8072
8178
  };
8073
8179
  type GetApi1EnergySitesByIdSiteInfoResponse = GetApi1EnergySitesByIdSiteInfoResponses[keyof GetApi1EnergySitesByIdSiteInfoResponses];
@@ -10115,86 +10221,186 @@ declare class TeslemetryEnergyApi extends EventEmitter {
10115
10221
  * @return Promise to an object with response containing detailed information about the energy site
10116
10222
  */
10117
10223
  getSiteInfo(): Promise<{
10118
- response?: {
10119
- id?: string;
10224
+ response: {
10225
+ id: string;
10120
10226
  site_name?: string;
10121
- site_number?: string;
10122
10227
  backup_reserve_percent?: number;
10123
10228
  default_real_mode?: string;
10124
- installation_date?: string;
10125
- user_settings?: {
10126
- go_off_grid_test_banner_enabled?: null | boolean;
10127
- storm_mode_enabled?: null | boolean;
10128
- powerwall_onboarding_settings_set?: null | boolean;
10129
- powerwall_tesla_electric_interested_in?: null | boolean;
10130
- vpp_tour_enabled?: null | boolean;
10131
- off_grid_vehicle_charging_enabled?: null | boolean;
10132
- };
10133
- components?: {
10134
- solar?: boolean;
10229
+ installation_date: string;
10230
+ user_settings: {
10231
+ go_off_grid_test_banner_enabled: null | boolean;
10232
+ storm_mode_enabled: null | boolean;
10233
+ powerwall_onboarding_settings_set: null | boolean;
10234
+ powerwall_tesla_electric_interested_in: null | boolean;
10235
+ vpp_tour_enabled: null | boolean;
10236
+ off_grid_vehicle_charging_enabled: null | boolean;
10237
+ };
10238
+ components: {
10239
+ solar: boolean;
10135
10240
  solar_type?: string;
10136
- battery?: boolean;
10137
- grid?: boolean;
10138
- backup?: boolean;
10139
- gateway?: string;
10140
- load_meter?: boolean;
10141
- tou_capable?: boolean;
10142
- storm_mode_capable?: boolean;
10143
- off_grid_vehicle_charging_reserve_supported?: boolean;
10144
- vehicle_charging_performance_view_enabled?: boolean;
10145
- vehicle_charging_solar_offset_view_enabled?: boolean;
10146
- battery_solar_offset_view_enabled?: boolean;
10147
- energy_service_self_scheduling_enabled?: boolean;
10241
+ battery: boolean;
10242
+ grid: boolean;
10243
+ backup: boolean;
10244
+ gateway: string;
10245
+ load_meter: boolean;
10246
+ tou_capable: boolean;
10247
+ storm_mode_capable: boolean;
10248
+ off_grid_vehicle_charging_reserve_supported: boolean;
10249
+ vehicle_charging_performance_view_enabled: boolean;
10250
+ vehicle_charging_solar_offset_view_enabled: boolean;
10251
+ battery_solar_offset_view_enabled: boolean;
10252
+ solar_value_enabled?: boolean;
10253
+ energy_value_header?: string;
10254
+ energy_value_subheader?: string;
10255
+ energy_service_self_scheduling_enabled: boolean;
10256
+ show_battery_soe_graph?: boolean;
10257
+ show_grid_import_battery_source_cards?: boolean;
10258
+ set_islanding_mode_enabled?: boolean;
10259
+ wifi_commissioning_enabled?: boolean;
10260
+ backup_time_remaining_enabled?: boolean;
10261
+ battery_type?: string;
10262
+ configurable?: boolean;
10263
+ grid_services_enabled?: boolean;
10264
+ gateways?: Array<{
10265
+ device_id: string;
10266
+ din: string;
10267
+ serial_number: string;
10268
+ part_number: string;
10269
+ part_type: number;
10270
+ part_name: string;
10271
+ is_active: boolean;
10272
+ site_id: string;
10273
+ firmware_version: string;
10274
+ updated_datetime: string;
10275
+ leader_device_id?: string;
10276
+ }>;
10277
+ customer_preferred_export_rule?: string;
10278
+ edit_setting_permission_to_export?: boolean;
10279
+ edit_setting_grid_charging?: boolean;
10280
+ edit_setting_energy_exports?: boolean;
10281
+ system_alerts_enabled?: boolean;
10282
+ service_mode_enabled?: boolean;
10283
+ support_manual_backup?: boolean;
10284
+ rate_tariff_service_options: {
10285
+ rate_plan_configured_by_rts: boolean;
10286
+ rate_tariff_service_enabled: boolean;
10287
+ request_export_tariff: boolean;
10288
+ request_network_fees: boolean;
10289
+ };
10148
10290
  wall_connectors?: Array<{
10149
- device_id?: string;
10150
- din?: string;
10151
- serial_number?: string;
10152
- part_number?: string;
10291
+ device_id: string;
10292
+ din: string;
10293
+ serial_number: string;
10294
+ part_number: string;
10295
+ part_type: number;
10296
+ part_name: string;
10297
+ is_active: boolean;
10298
+ }>;
10299
+ net_meter_mode?: string;
10300
+ batteries?: Array<{
10301
+ device_id: string;
10302
+ din: string;
10303
+ serial_number: string;
10304
+ part_number: string;
10153
10305
  part_type?: number;
10154
10306
  part_name?: string;
10155
- is_active?: boolean;
10307
+ nameplate_max_charge_power: number;
10308
+ nameplate_max_discharge_power: number;
10309
+ nameplate_energy: number;
10310
+ is_active: boolean;
10156
10311
  }>;
10157
- nbt_supported?: boolean;
10158
- system_alerts_enabled?: boolean;
10159
- rate_tariff_service_options?: {
10160
- rate_plan_configured_by_rts?: boolean;
10161
- rate_tariff_service_enabled?: boolean;
10162
- request_export_tariff?: boolean;
10163
- request_network_fees?: boolean;
10312
+ non_export_configured?: boolean;
10313
+ disallow_charge_from_grid_with_solar_installed?: boolean;
10314
+ ITC_cliff?: number;
10315
+ sunrun_options?: {
10316
+ my_home_info_deeplink_enabled: boolean;
10317
+ support_screen_deeplink_enabled: boolean;
10164
10318
  };
10165
- solar_value_enabled?: boolean;
10166
- set_islanding_mode_enabled?: boolean;
10167
- battery_type?: string;
10168
- configurable?: boolean;
10319
+ inverters?: Array<{
10320
+ device_id: string;
10321
+ din: string;
10322
+ serial_number: string;
10323
+ part_number: string;
10324
+ part_type: number;
10325
+ part_name: string;
10326
+ is_active: boolean;
10327
+ site_id: string;
10328
+ firmware_version?: string;
10329
+ }>;
10330
+ nbt_supported?: boolean;
10331
+ local_offline_monitoring_enabled?: boolean;
10332
+ hide_time_of_use_card?: boolean;
10169
10333
  };
10170
10334
  version?: string;
10171
10335
  battery_count?: number;
10336
+ tariff_content?: {
10337
+ [key: string]: unknown;
10338
+ };
10172
10339
  nameplate_power?: number;
10173
- nameplate_energy?: number;
10174
10340
  installation_time_zone?: string;
10175
10341
  max_site_meter_power_ac?: number;
10176
10342
  min_site_meter_power_ac?: number;
10177
10343
  tariff_content_v2?: {
10178
- name?: string;
10179
- utility?: string;
10180
- version?: number;
10181
- daily_charges?: Array<{
10182
- name?: string;
10344
+ [key: string]: unknown;
10345
+ };
10346
+ vpp_backup_reserve_percent?: number;
10347
+ utility?: string;
10348
+ island_config?: {
10349
+ low_soe_limit?: number;
10350
+ jump_start_soe_threshold?: number;
10351
+ wait_for_solar_retry_soe?: number;
10352
+ max_frequency_shift_hz?: number;
10353
+ wait_for_solar_soe_threshold?: number;
10354
+ microgrid_not_ok_timeout?: number;
10355
+ manual_backup?: boolean;
10356
+ neutral_balancer_type?: string;
10357
+ };
10358
+ vehicle_charging_settings?: {
10359
+ evses: Array<{
10360
+ din: string;
10361
+ smart_charging?: {
10362
+ enable?: boolean;
10363
+ schedules?: Array<{
10364
+ time: string;
10365
+ }>;
10366
+ min_hours_charging?: number;
10367
+ };
10368
+ modbus_id?: number;
10183
10369
  }>;
10184
- demand_charges?: {
10185
- [key: string]: unknown;
10186
- };
10187
- energy_charges?: {
10188
- [key: string]: unknown;
10189
- };
10190
- seasons?: {
10191
- [key: string]: unknown;
10192
- };
10193
- sell_tariff?: {
10194
- [key: string]: unknown;
10370
+ };
10371
+ nameplate_energy?: number;
10372
+ off_grid_vehicle_charging_reserve_percent?: number;
10373
+ tariff_id?: string;
10374
+ site_number?: string;
10375
+ time_zone_offset?: number;
10376
+ app_settings?: {
10377
+ live_status_local_refresh_s: number;
10378
+ };
10379
+ csip?: {
10380
+ dcap_url: string;
10381
+ device_certificate: string;
10382
+ csip_australia: {
10383
+ national_meter_identifier: string;
10195
10384
  };
10196
10385
  };
10386
+ external_switch?: {
10387
+ input_type: string;
10388
+ control_behavior: string;
10389
+ };
10390
+ aggregation_program?: {
10391
+ name: string;
10392
+ description: string;
10393
+ link_name: string;
10394
+ link_url: string;
10395
+ };
10396
+ tesla_electric_billing_periods?: Array<{
10397
+ start_time: string;
10398
+ end_time: string;
10399
+ }>;
10197
10400
  };
10401
+ error?: string;
10402
+ error_description?: string;
10403
+ txid?: string;
10198
10404
  }>;
10199
10405
  /**
10200
10406
  * Adjust the site's off-grid vehicle charging backup reserve.
package/dist/index.mjs CHANGED
@@ -3115,8 +3115,8 @@ var TeslemetryStream = class extends EventEmitter {
3115
3115
  this.cloudCache = options.cache;
3116
3116
  this.localCache = options.cache;
3117
3117
  } else {
3118
- this.cloudCache = options?.cache?.cloud;
3119
- this.localCache = options?.cache?.local;
3118
+ this.cloudCache = options?.cache?.cloud ?? true;
3119
+ this.localCache = options?.cache?.local ?? true;
3120
3120
  }
3121
3121
  this.logger = root.logger;
3122
3122
  if (this.vin) this.getVehicle(this.vin);
@@ -5045,7 +5045,7 @@ const consoleLogger = {
5045
5045
 
5046
5046
  //#endregion
5047
5047
  //#region package.json
5048
- var version = "0.5.1";
5048
+ var version = "0.5.2";
5049
5049
 
5050
5050
  //#endregion
5051
5051
  //#region src/Teslemetry.ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teslemetry/api",
3
- "version": "0.5.1",
3
+ "version": "0.5.2",
4
4
  "description": "API client for Teslemetry",
5
5
  "main": "dist/index.cjs",
6
6
  "module": "dist/index.mjs",