tesla-fleet-api 0.3.0 → 0.5.0

package/dist/energy.cjs

@@ -0,0 +1,142 @@
+const require_energyspecific = require("./energyspecific.cjs");
+// src/energy.ts
+var Energy = class {
+	/** Class `create` instantiates; a subclass overrides it to supply its own site type. */
+	static Site = require_energyspecific.default;
+	parent;
+	/** Every site created by this factory, keyed by `energy_site_id`; the latest `create` call wins. */
+	byId = /* @__PURE__ */ new Map();
+	constructor(parent) {
+		this.parent = parent;
+	}
+	/**
+	* Create an Energy class for a specific site.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param private_key RSA key `VERIFIED` on this gateway, for client-signed device commands. Requires `din`. Without one the site is unsigned: unlike vehicles, there is no fallback to the parent's key.
+	* @param din Gateway DIN (the energy site's `gateway_id` in `products`).
+	* @returns `EnergySpecific` class
+	*/
+	create(energy_site_id, private_key, din) {
+		const site = new this.constructor.Site(this, energy_site_id, private_key, din);
+		this.byId.set(energy_site_id, site);
+		return site;
+	}
+	/**
+	* Adjust the site's backup reserve.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.ID field of an energy site from /api/1/products endpoint.
+	* @param backup_reserve_percent The desired backup reserve percent.
+	* @returns
+	*/
+	async backup(energy_site_id, backup_reserve_percent) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/backup`, null, { backup_reserve_percent });
+	}
+	/**
+	* Returns the backup (off-grid) event history of the site in duration of seconds.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+	* @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+	* @returns
+	*/
+	async backup_history(energy_site_id, period, start_date, end_date, time_zone) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/calendar_history`, {
+			kind: "backup",
+			start_date,
+			end_date,
+			period,
+			time_zone
+		});
+	}
+	/**
+	* Returns the charging history of a wall connector.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param start_date Start date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param end_date End date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+	* @returns
+	*/
+	async charge_history(energy_site_id, start_date, end_date, time_zone) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/telemetry_history`, {
+			kind: "charge",
+			start_date,
+			end_date,
+			time_zone
+		});
+	}
+	/**
+	* Returns the energy measurements of the site, aggregated to the requested period.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param period Period of the window to retrieve energy measurements. This can be day, week, month, year, lifetime and should align with the window requested.
+	* @param start_date Start date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param end_date End date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+	* @returns
+	*/
+	async energy_history(energy_site_id, period, start_date, end_date, time_zone) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/calendar_history`, {
+			kind: "energy",
+			start_date,
+			end_date,
+			period,
+			time_zone
+		});
+	}
+	/**
+	* Allow/disallow charging from the grid and exporting energy to the grid.
+	* @param energy_site_id
+	* @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+	* @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+	* @returns
+	*/
+	async grid_import_export(energy_site_id, disallow_charge_from_grid_with_solar_installed = null, customer_preferred_export_rule = null) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/grid_import_export`, null, {
+			disallow_charge_from_grid_with_solar_installed,
+			customer_preferred_export_rule
+		});
+	}
+	/**
+	* Returns the live status of the site (power, state of energy, grid status, storm mode).
+	* @param energy_site_id
+	* @returns
+	*/
+	async live_status(energy_site_id) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/live_status`);
+	}
+	/**
+	* Adjust the site's off-grid vehicle charging backup reserve.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+	* @returns
+	*/
+	async off_grid_vehicle_charging_reserve(energy_site_id, off_grid_vehicle_charging_reserve_percent) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/off_grid_vehicle_charging_reserve`, null, { off_grid_vehicle_charging_reserve_percent });
+	}
+	/**
+	* Set the site's mode.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param default_real_mode The desired operation mode. Use autonomous for time-based control and self_consumption for self-powered mode.
+	* @returns
+	*/
+	async operation(energy_site_id, default_real_mode) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/operation`, null, { default_real_mode });
+	}
+	/**
+	* Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @returns
+	*/
+	async site_info(energy_site_id) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/site_info`);
+	}
+	/**
+	* Update storm watch participation.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param enabled The storm mode participation value to set.
+	* @returns
+	*/
+	async storm_mode(energy_site_id, enabled) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/storm_mode`, null, { enabled });
+	}
+};
+exports.default = Energy;

package/dist/energy.d.cts

@@ -0,0 +1,101 @@
+import { TeslaEnergyPeriod } from "./const.cjs";
+import EnergySpecific from "./energyspecific.cjs";
+import TeslaFleetApi from "./teslafleetapi.cjs";
+import { LiveStatusResponse } from "./types/live_status.cjs";
+import { ResponseEnvelope } from "./types/responses.cjs";
+import { SiteInfoResponse } from "./types/site_info.cjs";
+import { KeyObject } from "crypto";
+declare class Energy {
+  /** Class `create` instantiates; a subclass overrides it to supply its own site type. */
+  static Site: new (parent: Energy, energy_site_id: number, private_key?: KeyObject, din?: string) => EnergySpecific;
+  parent: TeslaFleetApi;
+  /** Every site created by this factory, keyed by `energy_site_id`; the latest `create` call wins. */
+  byId: Map<number, EnergySpecific>;
+  constructor(parent: TeslaFleetApi);
+  /**
+   * Create an Energy class for a specific site.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param private_key RSA key `VERIFIED` on this gateway, for client-signed device commands. Requires `din`. Without one the site is unsigned: unlike vehicles, there is no fallback to the parent's key.
+   * @param din Gateway DIN (the energy site's `gateway_id` in `products`).
+   * @returns `EnergySpecific` class
+   */
+  create(energy_site_id: number, private_key?: KeyObject, din?: string): EnergySpecific;
+  /**
+   * Adjust the site's backup reserve.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.ID field of an energy site from /api/1/products endpoint.
+   * @param backup_reserve_percent The desired backup reserve percent.
+   * @returns
+   */
+  backup(energy_site_id: number, backup_reserve_percent: number): Promise<Record<string, any>>;
+  /**
+   * Returns the backup (off-grid) event history of the site in duration of seconds.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+   * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+   * @returns
+   */
+  backup_history(energy_site_id: number, period: TeslaEnergyPeriod | string | null, start_date?: string | null, end_date?: string | null, time_zone?: string | null): Promise<Record<string, any>>;
+  /**
+   * Returns the charging history of a wall connector.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param start_date Start date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param end_date End date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+   * @returns
+   */
+  charge_history(energy_site_id: number, start_date: string, end_date: string, time_zone?: string | null): Promise<Record<string, any>>;
+  /**
+   * Returns the energy measurements of the site, aggregated to the requested period.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param period Period of the window to retrieve energy measurements. This can be day, week, month, year, lifetime and should align with the window requested.
+   * @param start_date Start date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param end_date End date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+   * @returns
+   */
+  energy_history(energy_site_id: number, period: TeslaEnergyPeriod | string | null, start_date?: string | null, end_date?: string | null, time_zone?: string | null): Promise<Record<string, any>>;
+  /**
+   * Allow/disallow charging from the grid and exporting energy to the grid.
+   * @param energy_site_id
+   * @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+   * @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+   * @returns
+   */
+  grid_import_export(energy_site_id: number, disallow_charge_from_grid_with_solar_installed?: boolean | null, customer_preferred_export_rule?: string | null): Promise<Record<string, any>>;
+  /**
+   * Returns the live status of the site (power, state of energy, grid status, storm mode).
+   * @param energy_site_id
+   * @returns
+   */
+  live_status(energy_site_id: number): Promise<ResponseEnvelope<LiveStatusResponse>>;
+  /**
+   * Adjust the site's off-grid vehicle charging backup reserve.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+   * @returns
+   */
+  off_grid_vehicle_charging_reserve(energy_site_id: number, off_grid_vehicle_charging_reserve_percent: number): Promise<Record<string, any>>;
+  /**
+   * Set the site's mode.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param default_real_mode The desired operation mode. Use autonomous for time-based control and self_consumption for self-powered mode.
+   * @returns
+   */
+  operation(energy_site_id: number, default_real_mode: string): Promise<Record<string, any>>;
+  /**
+   * Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @returns
+   */
+  site_info(energy_site_id: number): Promise<ResponseEnvelope<SiteInfoResponse>>;
+  /**
+   * Update storm watch participation.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param enabled The storm mode participation value to set.
+   * @returns
+   */
+  storm_mode(energy_site_id: number, enabled: boolean): Promise<Record<string, any>>;
+}
+export = Energy;

package/dist/energy.d.mts

@@ -0,0 +1,100 @@
+import { TeslaEnergyPeriod } from "./const.mjs";
+import EnergySpecific from "./energyspecific.mjs";
+import TeslaFleetApi from "./teslafleetapi.mjs";
+import { LiveStatusResponse } from "./types/live_status.mjs";
+import { ResponseEnvelope } from "./types/responses.mjs";
+import { SiteInfoResponse } from "./types/site_info.mjs";
+import { KeyObject } from "crypto";
+export default class Energy {
+  /** Class `create` instantiates; a subclass overrides it to supply its own site type. */
+  static Site: new (parent: Energy, energy_site_id: number, private_key?: KeyObject, din?: string) => EnergySpecific;
+  parent: TeslaFleetApi;
+  /** Every site created by this factory, keyed by `energy_site_id`; the latest `create` call wins. */
+  byId: Map<number, EnergySpecific>;
+  constructor(parent: TeslaFleetApi);
+  /**
+   * Create an Energy class for a specific site.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param private_key RSA key `VERIFIED` on this gateway, for client-signed device commands. Requires `din`. Without one the site is unsigned: unlike vehicles, there is no fallback to the parent's key.
+   * @param din Gateway DIN (the energy site's `gateway_id` in `products`).
+   * @returns `EnergySpecific` class
+   */
+  create(energy_site_id: number, private_key?: KeyObject, din?: string): EnergySpecific;
+  /**
+   * Adjust the site's backup reserve.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.ID field of an energy site from /api/1/products endpoint.
+   * @param backup_reserve_percent The desired backup reserve percent.
+   * @returns
+   */
+  backup(energy_site_id: number, backup_reserve_percent: number): Promise<Record<string, any>>;
+  /**
+   * Returns the backup (off-grid) event history of the site in duration of seconds.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+   * @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+   * @returns
+   */
+  backup_history(energy_site_id: number, period: TeslaEnergyPeriod | string | null, start_date?: string | null, end_date?: string | null, time_zone?: string | null): Promise<Record<string, any>>;
+  /**
+   * Returns the charging history of a wall connector.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param start_date Start date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param end_date End date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+   * @returns
+   */
+  charge_history(energy_site_id: number, start_date: string, end_date: string, time_zone?: string | null): Promise<Record<string, any>>;
+  /**
+   * Returns the energy measurements of the site, aggregated to the requested period.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param period Period of the window to retrieve energy measurements. This can be day, week, month, year, lifetime and should align with the window requested.
+   * @param start_date Start date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param end_date End date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+   * @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+   * @returns
+   */
+  energy_history(energy_site_id: number, period: TeslaEnergyPeriod | string | null, start_date?: string | null, end_date?: string | null, time_zone?: string | null): Promise<Record<string, any>>;
+  /**
+   * Allow/disallow charging from the grid and exporting energy to the grid.
+   * @param energy_site_id
+   * @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+   * @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+   * @returns
+   */
+  grid_import_export(energy_site_id: number, disallow_charge_from_grid_with_solar_installed?: boolean | null, customer_preferred_export_rule?: string | null): Promise<Record<string, any>>;
+  /**
+   * Returns the live status of the site (power, state of energy, grid status, storm mode).
+   * @param energy_site_id
+   * @returns
+   */
+  live_status(energy_site_id: number): Promise<ResponseEnvelope<LiveStatusResponse>>;
+  /**
+   * Adjust the site's off-grid vehicle charging backup reserve.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+   * @returns
+   */
+  off_grid_vehicle_charging_reserve(energy_site_id: number, off_grid_vehicle_charging_reserve_percent: number): Promise<Record<string, any>>;
+  /**
+   * Set the site's mode.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param default_real_mode The desired operation mode. Use autonomous for time-based control and self_consumption for self-powered mode.
+   * @returns
+   */
+  operation(energy_site_id: number, default_real_mode: string): Promise<Record<string, any>>;
+  /**
+   * Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @returns
+   */
+  site_info(energy_site_id: number): Promise<ResponseEnvelope<SiteInfoResponse>>;
+  /**
+   * Update storm watch participation.
+   * @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+   * @param enabled The storm mode participation value to set.
+   * @returns
+   */
+  storm_mode(energy_site_id: number, enabled: boolean): Promise<Record<string, any>>;
+}

package/dist/energy.mjs

@@ -0,0 +1,142 @@
+import EnergySpecific from "./energyspecific.mjs";
+// src/energy.ts
+var Energy = class {
+	/** Class `create` instantiates; a subclass overrides it to supply its own site type. */
+	static Site = EnergySpecific;
+	parent;
+	/** Every site created by this factory, keyed by `energy_site_id`; the latest `create` call wins. */
+	byId = /* @__PURE__ */ new Map();
+	constructor(parent) {
+		this.parent = parent;
+	}
+	/**
+	* Create an Energy class for a specific site.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param private_key RSA key `VERIFIED` on this gateway, for client-signed device commands. Requires `din`. Without one the site is unsigned: unlike vehicles, there is no fallback to the parent's key.
+	* @param din Gateway DIN (the energy site's `gateway_id` in `products`).
+	* @returns `EnergySpecific` class
+	*/
+	create(energy_site_id, private_key, din) {
+		const site = new this.constructor.Site(this, energy_site_id, private_key, din);
+		this.byId.set(energy_site_id, site);
+		return site;
+	}
+	/**
+	* Adjust the site's backup reserve.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.ID field of an energy site from /api/1/products endpoint.
+	* @param backup_reserve_percent The desired backup reserve percent.
+	* @returns
+	*/
+	async backup(energy_site_id, backup_reserve_percent) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/backup`, null, { backup_reserve_percent });
+	}
+	/**
+	* Returns the backup (off-grid) event history of the site in duration of seconds.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param period Period of the window to retrieve backup events. This can be day, week, month, year, lifetime and should align with the window requested.
+	* @param start_date Start date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param end_date End date of the window to retrieve backup events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+	* @returns
+	*/
+	async backup_history(energy_site_id, period, start_date, end_date, time_zone) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/calendar_history`, {
+			kind: "backup",
+			start_date,
+			end_date,
+			period,
+			time_zone
+		});
+	}
+	/**
+	* Returns the charging history of a wall connector.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param start_date Start date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param end_date End date of the window to retrieve charging events in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+	* @returns
+	*/
+	async charge_history(energy_site_id, start_date, end_date, time_zone) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/telemetry_history`, {
+			kind: "charge",
+			start_date,
+			end_date,
+			time_zone
+		});
+	}
+	/**
+	* Returns the energy measurements of the site, aggregated to the requested period.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param period Period of the window to retrieve energy measurements. This can be day, week, month, year, lifetime and should align with the window requested.
+	* @param start_date Start date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param end_date End date of the window to retrieve energy measurements in RFC3339 format. i.e. 2023-01-01T00:00:00-08:00
+	* @param time_zone Timezone of the requested window in IANA name format. i.e. 'America/Los_Angeles'
+	* @returns
+	*/
+	async energy_history(energy_site_id, period, start_date, end_date, time_zone) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/calendar_history`, {
+			kind: "energy",
+			start_date,
+			end_date,
+			period,
+			time_zone
+		});
+	}
+	/**
+	* Allow/disallow charging from the grid and exporting energy to the grid.
+	* @param energy_site_id
+	* @param disallow_charge_from_grid_with_solar_installed The desired behavior towards importing from the grid. Charging from the grid is disabled when set to true and enabled when set to false.
+	* @param customer_preferred_export_rule The desired behavior for grid exporting. The available options are battery_ok, pv_only, and never.
+	* @returns
+	*/
+	async grid_import_export(energy_site_id, disallow_charge_from_grid_with_solar_installed = null, customer_preferred_export_rule = null) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/grid_import_export`, null, {
+			disallow_charge_from_grid_with_solar_installed,
+			customer_preferred_export_rule
+		});
+	}
+	/**
+	* Returns the live status of the site (power, state of energy, grid status, storm mode).
+	* @param energy_site_id
+	* @returns
+	*/
+	async live_status(energy_site_id) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/live_status`);
+	}
+	/**
+	* Adjust the site's off-grid vehicle charging backup reserve.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param off_grid_vehicle_charging_reserve_percent The desired off grid vehicle charging reserve percent.
+	* @returns
+	*/
+	async off_grid_vehicle_charging_reserve(energy_site_id, off_grid_vehicle_charging_reserve_percent) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/off_grid_vehicle_charging_reserve`, null, { off_grid_vehicle_charging_reserve_percent });
+	}
+	/**
+	* Set the site's mode.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param default_real_mode The desired operation mode. Use autonomous for time-based control and self_consumption for self-powered mode.
+	* @returns
+	*/
+	async operation(energy_site_id, default_real_mode) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/operation`, null, { default_real_mode });
+	}
+	/**
+	* Returns information about the site. Things like assets (has solar, etc), settings (backup reserve, etc), and features (storm_mode_capable, etc).
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @returns
+	*/
+	async site_info(energy_site_id) {
+		return this.parent._request("GET", `api/1/energy_sites/${energy_site_id}/site_info`);
+	}
+	/**
+	* Update storm watch participation.
+	* @param energy_site_id ID field of an energy site from /api/1/products endpoint.
+	* @param enabled The storm mode participation value to set.
+	* @returns
+	*/
+	async storm_mode(energy_site_id, enabled) {
+		return this.parent._request("POST", `api/1/energy_sites/${energy_site_id}/storm_mode`, null, { enabled });
+	}
+};
+export { Energy as default };

package/dist/energyisland.cjs

@@ -0,0 +1,38 @@
+const require_const = require("./const.cjs");
+let _teslemetry_tesla_protocol_energy_device_teg_api = require("@teslemetry/tesla-protocol/energy_device/teg_api");
+// src/energyisland.ts
+/** The `TEGSetIslandModeResult` values that mean the gateway refused. */
+const REJECTIONS = [
+	_teslemetry_tesla_protocol_energy_device_teg_api.TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_NOT_READY_FOR_ISLANDING,
+	_teslemetry_tesla_protocol_energy_device_teg_api.TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_LOAD_DROP_EXPECTED,
+	_teslemetry_tesla_protocol_energy_device_teg_api.TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_LOW_ENERGY,
+	_teslemetry_tesla_protocol_energy_device_teg_api.TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_EXCESSIVE_SOLAR
+];
+/**
+* The refusal a `setIslandModeResponse.result` reports, or `null` for anything
+* else, which is not guessed at. Takes the enum's number or its name, because a
+* JSON route may carry either.
+*/
+function island_mode_rejection(result) {
+	for (const code of REJECTIONS) {
+		const name = (0, _teslemetry_tesla_protocol_energy_device_teg_api.tEGSetIslandModeResultToJSON)(code);
+		if (result === code || result === name) return {
+			code,
+			name
+		};
+	}
+	return null;
+}
+/**
+* Check an island command before it is signed. A contactor command takes only the
+* two modes Python's `go_off_grid` and `reconnect_grid` use: `ON_GRID` (1) and
+* `OFF_GRID` (6). There is no coercion and no default, because `"6"` or a missing
+* mode could otherwise close the contactor when the caller meant to open it.
+* @throws TypeError on any other mode, or a `force` that is not a boolean.
+*/
+function validate_island_mode(mode, force) {
+	if (mode !== require_const.EnergyIslandMode.ON_GRID && mode !== require_const.EnergyIslandMode.OFF_GRID) throw new TypeError("mode must be EnergyIslandMode.ON_GRID (1) or EnergyIslandMode.OFF_GRID (6)");
+	if (force !== void 0 && force !== null && typeof force !== "boolean") throw new TypeError("force must be a boolean");
+}
+exports.island_mode_rejection = island_mode_rejection;
+exports.validate_island_mode = validate_island_mode;

package/dist/energyisland.mjs

@@ -0,0 +1,37 @@
+import { EnergyIslandMode } from "./const.mjs";
+import { TEGSetIslandModeResult, tEGSetIslandModeResultToJSON } from "@teslemetry/tesla-protocol/energy_device/teg_api";
+// src/energyisland.ts
+/** The `TEGSetIslandModeResult` values that mean the gateway refused. */
+const REJECTIONS = [
+	TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_NOT_READY_FOR_ISLANDING,
+	TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_LOAD_DROP_EXPECTED,
+	TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_LOW_ENERGY,
+	TEGSetIslandModeResult.TEG_SET_ISLAND_MODE_RESULT_REJECTED_EXCESSIVE_SOLAR
+];
+/**
+* The refusal a `setIslandModeResponse.result` reports, or `null` for anything
+* else, which is not guessed at. Takes the enum's number or its name, because a
+* JSON route may carry either.
+*/
+function island_mode_rejection(result) {
+	for (const code of REJECTIONS) {
+		const name = tEGSetIslandModeResultToJSON(code);
+		if (result === code || result === name) return {
+			code,
+			name
+		};
+	}
+	return null;
+}
+/**
+* Check an island command before it is signed. A contactor command takes only the
+* two modes Python's `go_off_grid` and `reconnect_grid` use: `ON_GRID` (1) and
+* `OFF_GRID` (6). There is no coercion and no default, because `"6"` or a missing
+* mode could otherwise close the contactor when the caller meant to open it.
+* @throws TypeError on any other mode, or a `force` that is not a boolean.
+*/
+function validate_island_mode(mode, force) {
+	if (mode !== EnergyIslandMode.ON_GRID && mode !== EnergyIslandMode.OFF_GRID) throw new TypeError("mode must be EnergyIslandMode.ON_GRID (1) or EnergyIslandMode.OFF_GRID (6)");
+	if (force !== void 0 && force !== null && typeof force !== "boolean") throw new TypeError("force must be a boolean");
+}
+export { island_mode_rejection, validate_island_mode };