@enyo-energy/energy-app-sdk 0.0.34
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/README.md +216 -0
- package/dist/cjs/connect-ems-api.cjs +2 -0
- package/dist/cjs/connect-ems-api.d.cts +30 -0
- package/dist/cjs/connect-ems-permission.enum.cjs +7 -0
- package/dist/cjs/connect-ems-permission.enum.d.cts +3 -0
- package/dist/cjs/connect-ems-permission.type.cjs +2 -0
- package/dist/cjs/connect-ems-permission.type.d.cts +1 -0
- package/dist/cjs/connect-package-definition.cjs +14 -0
- package/dist/cjs/connect-package-definition.d.cts +57 -0
- package/dist/cjs/energy-app-appliance-type.enum.cjs +14 -0
- package/dist/cjs/energy-app-appliance-type.enum.d.cts +10 -0
- package/dist/cjs/energy-app-package-configuration.cjs +2 -0
- package/dist/cjs/energy-app-package-configuration.d.cts +30 -0
- package/dist/cjs/energy-app-package-definition.cjs +30 -0
- package/dist/cjs/energy-app-package-definition.d.cts +123 -0
- package/dist/cjs/energy-app-permission.type.cjs +21 -0
- package/dist/cjs/energy-app-permission.type.d.cts +18 -0
- package/dist/cjs/enyo-energy-app-sdk.cjs +12 -0
- package/dist/cjs/enyo-energy-app-sdk.d.cts +67 -0
- package/dist/cjs/hems-one-energy-app-sdk.cjs +12 -0
- package/dist/cjs/hems-one-energy-app-sdk.d.cts +64 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusBattery.cjs +388 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusBattery.d.cts +59 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusConnectionHealth.cjs +37 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusConnectionHealth.d.cts +15 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusDataTypeConverter.cjs +130 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusDataTypeConverter.d.cts +41 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusFaultTolerantReader.cjs +49 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusFaultTolerantReader.d.cts +10 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusInverter.cjs +348 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusInverter.d.cts +56 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusMeter.cjs +199 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusMeter.d.cts +26 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusRegisterMapper.cjs +98 -0
- package/dist/cjs/implementations/modbus/EnergyAppModbusRegisterMapper.d.cts +13 -0
- package/dist/cjs/implementations/modbus/interfaces.cjs +29 -0
- package/dist/cjs/implementations/modbus/interfaces.d.cts +202 -0
- package/dist/cjs/implementations/ocpp/ocpp-common.cjs +337 -0
- package/dist/cjs/implementations/ocpp/ocpp-common.d.cts +75 -0
- package/dist/cjs/implementations/ocpp/ocpp16.cjs +51 -0
- package/dist/cjs/implementations/ocpp/ocpp16.d.cts +137 -0
- package/dist/cjs/implementations/ocpp/ocpp201.cjs +84 -0
- package/dist/cjs/implementations/ocpp/ocpp201.d.cts +215 -0
- package/dist/cjs/index.cjs +117 -0
- package/dist/cjs/index.d.cts +56 -0
- package/dist/cjs/mockConnectEmsApi.cjs +167 -0
- package/dist/cjs/mockConnectEmsApi.d.cts +10 -0
- package/dist/cjs/packages/connect-appliance.cjs +2 -0
- package/dist/cjs/packages/connect-appliance.d.cts +24 -0
- package/dist/cjs/packages/connect-http-api.cjs +2 -0
- package/dist/cjs/packages/connect-http-api.d.cts +15 -0
- package/dist/cjs/packages/connect-interval.cjs +2 -0
- package/dist/cjs/packages/connect-interval.d.cts +15 -0
- package/dist/cjs/packages/connect-modbus.cjs +2 -0
- package/dist/cjs/packages/connect-modbus.d.cts +60 -0
- package/dist/cjs/packages/connect-network-devices.cjs +2 -0
- package/dist/cjs/packages/connect-network-devices.d.cts +40 -0
- package/dist/cjs/packages/connect-storage.cjs +2 -0
- package/dist/cjs/packages/connect-storage.d.cts +14 -0
- package/dist/cjs/packages/energy-app-appliance.cjs +2 -0
- package/dist/cjs/packages/energy-app-appliance.d.cts +17 -0
- package/dist/cjs/packages/energy-app-authentication.cjs +2 -0
- package/dist/cjs/packages/energy-app-authentication.d.cts +52 -0
- package/dist/cjs/packages/energy-app-charge.cjs +2 -0
- package/dist/cjs/packages/energy-app-charge.d.cts +13 -0
- package/dist/cjs/packages/energy-app-charging-card.cjs +2 -0
- package/dist/cjs/packages/energy-app-charging-card.d.cts +11 -0
- package/dist/cjs/packages/energy-app-data-bus.cjs +2 -0
- package/dist/cjs/packages/energy-app-data-bus.d.cts +12 -0
- package/dist/cjs/packages/energy-app-electricity-prices.cjs +2 -0
- package/dist/cjs/packages/energy-app-electricity-prices.d.cts +59 -0
- package/dist/cjs/packages/energy-app-interval.cjs +2 -0
- package/dist/cjs/packages/energy-app-interval.d.cts +15 -0
- package/dist/cjs/packages/energy-app-modbus.cjs +2 -0
- package/dist/cjs/packages/energy-app-modbus.d.cts +46 -0
- package/dist/cjs/packages/energy-app-network-device.cjs +2 -0
- package/dist/cjs/packages/energy-app-network-device.d.cts +25 -0
- package/dist/cjs/packages/energy-app-notification.cjs +2 -0
- package/dist/cjs/packages/energy-app-notification.d.cts +50 -0
- package/dist/cjs/packages/energy-app-ocpp.cjs +16 -0
- package/dist/cjs/packages/energy-app-ocpp.d.cts +52 -0
- package/dist/cjs/packages/energy-app-settings.cjs +2 -0
- package/dist/cjs/packages/energy-app-settings.d.cts +47 -0
- package/dist/cjs/packages/energy-app-storage.cjs +2 -0
- package/dist/cjs/packages/energy-app-storage.d.cts +14 -0
- package/dist/cjs/packages/energy-app-vehicle.cjs +2 -0
- package/dist/cjs/packages/energy-app-vehicle.d.cts +11 -0
- package/dist/cjs/permission-not-granted.cjs +18 -0
- package/dist/cjs/permission-not-granted.d.cts +8 -0
- package/dist/cjs/types/connect-appliance-type.enum.cjs +10 -0
- package/dist/cjs/types/connect-appliance-type.enum.d.cts +6 -0
- package/dist/cjs/types/energy-app-settings.cjs +2 -0
- package/dist/cjs/types/energy-app-settings.d.cts +74 -0
- package/dist/cjs/types/enyo-appliance.cjs +33 -0
- package/dist/cjs/types/enyo-appliance.d.cts +81 -0
- package/dist/cjs/types/enyo-authentication.cjs +9 -0
- package/dist/cjs/types/enyo-authentication.d.cts +69 -0
- package/dist/cjs/types/enyo-battery-appliance.cjs +2 -0
- package/dist/cjs/types/enyo-battery-appliance.d.cts +6 -0
- package/dist/cjs/types/enyo-charge.cjs +15 -0
- package/dist/cjs/types/enyo-charge.d.cts +82 -0
- package/dist/cjs/types/enyo-charger-appliance.cjs +41 -0
- package/dist/cjs/types/enyo-charger-appliance.d.cts +49 -0
- package/dist/cjs/types/enyo-charging-card.cjs +2 -0
- package/dist/cjs/types/enyo-charging-card.d.cts +11 -0
- package/dist/cjs/types/enyo-data-bus-value.cjs +78 -0
- package/dist/cjs/types/enyo-data-bus-value.d.cts +379 -0
- package/dist/cjs/types/enyo-electricity-prices.cjs +2 -0
- package/dist/cjs/types/enyo-electricity-prices.d.cts +63 -0
- package/dist/cjs/types/enyo-energy-tariff.cjs +2 -0
- package/dist/cjs/types/enyo-energy-tariff.d.cts +70 -0
- package/dist/cjs/types/enyo-heatpump-appliance.cjs +19 -0
- package/dist/cjs/types/enyo-heatpump-appliance.d.cts +34 -0
- package/dist/cjs/types/enyo-inverter-appliance.cjs +2 -0
- package/dist/cjs/types/enyo-inverter-appliance.d.cts +3 -0
- package/dist/cjs/types/enyo-meter-appliance.cjs +10 -0
- package/dist/cjs/types/enyo-meter-appliance.d.cts +10 -0
- package/dist/cjs/types/enyo-network-device.cjs +2 -0
- package/dist/cjs/types/enyo-network-device.d.cts +31 -0
- package/dist/cjs/types/enyo-notification.cjs +2 -0
- package/dist/cjs/types/enyo-notification.d.cts +48 -0
- package/dist/cjs/types/enyo-settings.cjs +2 -0
- package/dist/cjs/types/enyo-settings.d.cts +74 -0
- package/dist/cjs/types/enyo-source.enum.cjs +8 -0
- package/dist/cjs/types/enyo-source.enum.d.cts +4 -0
- package/dist/cjs/types/enyo-vehicle.cjs +2 -0
- package/dist/cjs/types/enyo-vehicle.d.cts +12 -0
- package/dist/cjs/types/enyo-websocket-connection.cjs +2 -0
- package/dist/cjs/types/enyo-websocket-connection.d.cts +8 -0
- package/dist/cjs/types/hems-one-appliance.cjs +33 -0
- package/dist/cjs/types/hems-one-appliance.d.cts +81 -0
- package/dist/cjs/types/hems-one-authentication.cjs +9 -0
- package/dist/cjs/types/hems-one-authentication.d.cts +69 -0
- package/dist/cjs/types/hems-one-battery-appliance.cjs +2 -0
- package/dist/cjs/types/hems-one-battery-appliance.d.cts +6 -0
- package/dist/cjs/types/hems-one-charge.cjs +15 -0
- package/dist/cjs/types/hems-one-charge.d.cts +82 -0
- package/dist/cjs/types/hems-one-charger-appliance.cjs +41 -0
- package/dist/cjs/types/hems-one-charger-appliance.d.cts +49 -0
- package/dist/cjs/types/hems-one-charging-card.cjs +2 -0
- package/dist/cjs/types/hems-one-charging-card.d.cts +11 -0
- package/dist/cjs/types/hems-one-data-bus-command.cjs +9 -0
- package/dist/cjs/types/hems-one-data-bus-command.d.cts +34 -0
- package/dist/cjs/types/hems-one-data-bus-value.cjs +78 -0
- package/dist/cjs/types/hems-one-data-bus-value.d.cts +379 -0
- package/dist/cjs/types/hems-one-electricity-prices.cjs +2 -0
- package/dist/cjs/types/hems-one-electricity-prices.d.cts +63 -0
- package/dist/cjs/types/hems-one-energy-tariff.cjs +2 -0
- package/dist/cjs/types/hems-one-energy-tariff.d.cts +70 -0
- package/dist/cjs/types/hems-one-heatpump-appliance.cjs +19 -0
- package/dist/cjs/types/hems-one-heatpump-appliance.d.cts +34 -0
- package/dist/cjs/types/hems-one-inverter-appliance.cjs +2 -0
- package/dist/cjs/types/hems-one-inverter-appliance.d.cts +3 -0
- package/dist/cjs/types/hems-one-meter-appliance.cjs +10 -0
- package/dist/cjs/types/hems-one-meter-appliance.d.cts +10 -0
- package/dist/cjs/types/hems-one-network-device.cjs +2 -0
- package/dist/cjs/types/hems-one-network-device.d.cts +31 -0
- package/dist/cjs/types/hems-one-source.enum.cjs +8 -0
- package/dist/cjs/types/hems-one-source.enum.d.cts +4 -0
- package/dist/cjs/types/hems-one-vehicle.cjs +2 -0
- package/dist/cjs/types/hems-one-vehicle.d.cts +12 -0
- package/dist/cjs/types/hems-one-websocket-connection.cjs +2 -0
- package/dist/cjs/types/hems-one-websocket-connection.d.cts +8 -0
- package/dist/cjs/version.cjs +19 -0
- package/dist/cjs/version.d.cts +13 -0
- package/dist/connect-ems-api.d.ts +30 -0
- package/dist/connect-ems-api.js +1 -0
- package/dist/connect-ems-permission.enum.d.ts +3 -0
- package/dist/connect-ems-permission.enum.js +4 -0
- package/dist/connect-ems-permission.type.d.ts +1 -0
- package/dist/connect-ems-permission.type.js +1 -0
- package/dist/connect-package-definition.d.ts +57 -0
- package/dist/connect-package-definition.js +10 -0
- package/dist/energy-app-appliance-type.enum.d.ts +10 -0
- package/dist/energy-app-appliance-type.enum.js +11 -0
- package/dist/energy-app-package-configuration.d.ts +30 -0
- package/dist/energy-app-package-configuration.js +1 -0
- package/dist/energy-app-package-definition.d.ts +123 -0
- package/dist/energy-app-package-definition.js +26 -0
- package/dist/energy-app-permission.type.d.ts +18 -0
- package/dist/energy-app-permission.type.js +18 -0
- package/dist/enyo-energy-app-sdk.d.ts +67 -0
- package/dist/enyo-energy-app-sdk.js +9 -0
- package/dist/hems-one-energy-app-sdk.d.ts +67 -0
- package/dist/hems-one-energy-app-sdk.js +9 -0
- package/dist/implementations/modbus/EnergyAppModbusBattery.d.ts +59 -0
- package/dist/implementations/modbus/EnergyAppModbusBattery.js +384 -0
- package/dist/implementations/modbus/EnergyAppModbusConnectionHealth.d.ts +15 -0
- package/dist/implementations/modbus/EnergyAppModbusConnectionHealth.js +33 -0
- package/dist/implementations/modbus/EnergyAppModbusDataTypeConverter.d.ts +41 -0
- package/dist/implementations/modbus/EnergyAppModbusDataTypeConverter.js +126 -0
- package/dist/implementations/modbus/EnergyAppModbusFaultTolerantReader.d.ts +10 -0
- package/dist/implementations/modbus/EnergyAppModbusFaultTolerantReader.js +45 -0
- package/dist/implementations/modbus/EnergyAppModbusInverter.d.ts +56 -0
- package/dist/implementations/modbus/EnergyAppModbusInverter.js +344 -0
- package/dist/implementations/modbus/EnergyAppModbusMeter.d.ts +26 -0
- package/dist/implementations/modbus/EnergyAppModbusMeter.js +195 -0
- package/dist/implementations/modbus/EnergyAppModbusRegisterMapper.d.ts +13 -0
- package/dist/implementations/modbus/EnergyAppModbusRegisterMapper.js +94 -0
- package/dist/implementations/modbus/interfaces.d.ts +202 -0
- package/dist/implementations/modbus/interfaces.js +23 -0
- package/dist/implementations/ocpp/ocpp-common.d.ts +75 -0
- package/dist/implementations/ocpp/ocpp-common.js +328 -0
- package/dist/implementations/ocpp/ocpp16.d.ts +137 -0
- package/dist/implementations/ocpp/ocpp16.js +48 -0
- package/dist/implementations/ocpp/ocpp201.d.ts +215 -0
- package/dist/implementations/ocpp/ocpp201.js +81 -0
- package/dist/index.d.ts +56 -0
- package/dist/index.js +99 -0
- package/dist/mockConnectEmsApi.d.ts +10 -0
- package/dist/mockConnectEmsApi.js +160 -0
- package/dist/packages/connect-appliance.d.ts +24 -0
- package/dist/packages/connect-appliance.js +1 -0
- package/dist/packages/connect-http-api.d.ts +15 -0
- package/dist/packages/connect-http-api.js +1 -0
- package/dist/packages/connect-interval.d.ts +15 -0
- package/dist/packages/connect-interval.js +1 -0
- package/dist/packages/connect-modbus.d.ts +60 -0
- package/dist/packages/connect-modbus.js +1 -0
- package/dist/packages/connect-network-devices.d.ts +40 -0
- package/dist/packages/connect-network-devices.js +1 -0
- package/dist/packages/connect-storage.d.ts +14 -0
- package/dist/packages/connect-storage.js +1 -0
- package/dist/packages/energy-app-appliance.d.ts +17 -0
- package/dist/packages/energy-app-appliance.js +1 -0
- package/dist/packages/energy-app-authentication.d.ts +52 -0
- package/dist/packages/energy-app-authentication.js +1 -0
- package/dist/packages/energy-app-charge.d.ts +13 -0
- package/dist/packages/energy-app-charge.js +1 -0
- package/dist/packages/energy-app-charging-card.d.ts +11 -0
- package/dist/packages/energy-app-charging-card.js +1 -0
- package/dist/packages/energy-app-data-bus.d.ts +12 -0
- package/dist/packages/energy-app-data-bus.js +1 -0
- package/dist/packages/energy-app-electricity-prices.d.ts +59 -0
- package/dist/packages/energy-app-electricity-prices.js +1 -0
- package/dist/packages/energy-app-interval.d.ts +15 -0
- package/dist/packages/energy-app-interval.js +1 -0
- package/dist/packages/energy-app-modbus.d.ts +46 -0
- package/dist/packages/energy-app-modbus.js +1 -0
- package/dist/packages/energy-app-network-device.d.ts +25 -0
- package/dist/packages/energy-app-network-device.js +1 -0
- package/dist/packages/energy-app-notification.d.ts +50 -0
- package/dist/packages/energy-app-notification.js +1 -0
- package/dist/packages/energy-app-ocpp.d.ts +52 -0
- package/dist/packages/energy-app-ocpp.js +13 -0
- package/dist/packages/energy-app-settings.d.ts +47 -0
- package/dist/packages/energy-app-settings.js +1 -0
- package/dist/packages/energy-app-storage.d.ts +14 -0
- package/dist/packages/energy-app-storage.js +1 -0
- package/dist/packages/energy-app-vehicle.d.ts +11 -0
- package/dist/packages/energy-app-vehicle.js +1 -0
- package/dist/permission-not-granted.d.ts +8 -0
- package/dist/permission-not-granted.js +14 -0
- package/dist/types/connect-appliance-type.enum.d.ts +6 -0
- package/dist/types/connect-appliance-type.enum.js +7 -0
- package/dist/types/energy-app-settings.d.ts +74 -0
- package/dist/types/energy-app-settings.js +1 -0
- package/dist/types/enyo-appliance.d.ts +81 -0
- package/dist/types/enyo-appliance.js +30 -0
- package/dist/types/enyo-authentication.d.ts +69 -0
- package/dist/types/enyo-authentication.js +6 -0
- package/dist/types/enyo-battery-appliance.d.ts +6 -0
- package/dist/types/enyo-battery-appliance.js +1 -0
- package/dist/types/enyo-charge.d.ts +82 -0
- package/dist/types/enyo-charge.js +12 -0
- package/dist/types/enyo-charger-appliance.d.ts +49 -0
- package/dist/types/enyo-charger-appliance.js +38 -0
- package/dist/types/enyo-charging-card.d.ts +11 -0
- package/dist/types/enyo-charging-card.js +1 -0
- package/dist/types/enyo-data-bus-value.d.ts +379 -0
- package/dist/types/enyo-data-bus-value.js +75 -0
- package/dist/types/enyo-electricity-prices.d.ts +63 -0
- package/dist/types/enyo-electricity-prices.js +1 -0
- package/dist/types/enyo-energy-tariff.d.ts +70 -0
- package/dist/types/enyo-energy-tariff.js +1 -0
- package/dist/types/enyo-heatpump-appliance.d.ts +34 -0
- package/dist/types/enyo-heatpump-appliance.js +16 -0
- package/dist/types/enyo-inverter-appliance.d.ts +3 -0
- package/dist/types/enyo-inverter-appliance.js +1 -0
- package/dist/types/enyo-meter-appliance.d.ts +10 -0
- package/dist/types/enyo-meter-appliance.js +7 -0
- package/dist/types/enyo-network-device.d.ts +31 -0
- package/dist/types/enyo-network-device.js +1 -0
- package/dist/types/enyo-notification.d.ts +48 -0
- package/dist/types/enyo-notification.js +1 -0
- package/dist/types/enyo-settings.d.ts +74 -0
- package/dist/types/enyo-settings.js +1 -0
- package/dist/types/enyo-source.enum.d.ts +4 -0
- package/dist/types/enyo-source.enum.js +5 -0
- package/dist/types/enyo-vehicle.d.ts +12 -0
- package/dist/types/enyo-vehicle.js +1 -0
- package/dist/types/enyo-websocket-connection.d.ts +8 -0
- package/dist/types/enyo-websocket-connection.js +1 -0
- package/dist/types/hems-one-appliance.d.ts +81 -0
- package/dist/types/hems-one-appliance.js +30 -0
- package/dist/types/hems-one-authentication.d.ts +69 -0
- package/dist/types/hems-one-authentication.js +6 -0
- package/dist/types/hems-one-battery-appliance.d.ts +6 -0
- package/dist/types/hems-one-battery-appliance.js +1 -0
- package/dist/types/hems-one-charge.d.ts +82 -0
- package/dist/types/hems-one-charge.js +12 -0
- package/dist/types/hems-one-charger-appliance.d.ts +49 -0
- package/dist/types/hems-one-charger-appliance.js +38 -0
- package/dist/types/hems-one-charging-card.d.ts +11 -0
- package/dist/types/hems-one-charging-card.js +1 -0
- package/dist/types/hems-one-data-bus-command.d.ts +34 -0
- package/dist/types/hems-one-data-bus-command.js +6 -0
- package/dist/types/hems-one-data-bus-value.d.ts +379 -0
- package/dist/types/hems-one-data-bus-value.js +75 -0
- package/dist/types/hems-one-electricity-prices.d.ts +63 -0
- package/dist/types/hems-one-electricity-prices.js +1 -0
- package/dist/types/hems-one-energy-tariff.d.ts +70 -0
- package/dist/types/hems-one-energy-tariff.js +1 -0
- package/dist/types/hems-one-heatpump-appliance.d.ts +34 -0
- package/dist/types/hems-one-heatpump-appliance.js +16 -0
- package/dist/types/hems-one-inverter-appliance.d.ts +3 -0
- package/dist/types/hems-one-inverter-appliance.js +1 -0
- package/dist/types/hems-one-meter-appliance.d.ts +10 -0
- package/dist/types/hems-one-meter-appliance.js +7 -0
- package/dist/types/hems-one-network-device.d.ts +31 -0
- package/dist/types/hems-one-network-device.js +1 -0
- package/dist/types/hems-one-source.enum.d.ts +4 -0
- package/dist/types/hems-one-source.enum.js +5 -0
- package/dist/types/hems-one-vehicle.d.ts +12 -0
- package/dist/types/hems-one-vehicle.js +1 -0
- package/dist/types/hems-one-websocket-connection.d.ts +8 -0
- package/dist/types/hems-one-websocket-connection.js +1 -0
- package/dist/version.d.ts +13 -0
- package/dist/version.js +15 -0
- package/package.json +43 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export declare enum HemsOneHeatpumpApplianceAvailableFeaturesEnum {
|
|
2
|
+
/** If the heatpump is capable of domestic hot water*/
|
|
3
|
+
DomesticHotWater = "DomesticHotWater",
|
|
4
|
+
/** If the heatpump is capable of domestic hot water boost to use more pv energy*/
|
|
5
|
+
DomesticHotWaterBoost = "DomesticHotWaterBoost",
|
|
6
|
+
/** If the heatpump has a heating rod*/
|
|
7
|
+
HeatingRod = "HeatingRod"
|
|
8
|
+
}
|
|
9
|
+
export declare enum HemsOneHeatpumpApplianceModeEnum {
|
|
10
|
+
Idle = "Idle",
|
|
11
|
+
Heating = "Heating",
|
|
12
|
+
DomesticHotWater = "DomesticHotWater",
|
|
13
|
+
EmergencyOperation = "EmergencyOperation"
|
|
14
|
+
}
|
|
15
|
+
export interface HemsOneHeatpumpApplianceDomesticHotWater {
|
|
16
|
+
index: number;
|
|
17
|
+
tankSizeLiter?: number;
|
|
18
|
+
targetTemperatureC: number;
|
|
19
|
+
hysteresisK?: number;
|
|
20
|
+
}
|
|
21
|
+
export interface HemsOneHeatpumpApplianceCompressor {
|
|
22
|
+
index: number;
|
|
23
|
+
}
|
|
24
|
+
export interface HemsOneHeatpumpApplianceHeatingCircuit {
|
|
25
|
+
index: number;
|
|
26
|
+
targetRoomTemperatureC?: number;
|
|
27
|
+
}
|
|
28
|
+
export interface HemsOneHeatpumpApplianceMetadata {
|
|
29
|
+
availableFeatures: HemsOneHeatpumpApplianceAvailableFeaturesEnum[];
|
|
30
|
+
mode?: HemsOneHeatpumpApplianceModeEnum;
|
|
31
|
+
domesticHotWater?: HemsOneHeatpumpApplianceDomesticHotWater[];
|
|
32
|
+
compressors?: HemsOneHeatpumpApplianceCompressor[];
|
|
33
|
+
heatingCircuits?: HemsOneHeatpumpApplianceHeatingCircuit[];
|
|
34
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.HemsOneMeterApplianceAvailableFeaturesEnum = void 0;
|
|
4
|
+
var HemsOneMeterApplianceAvailableFeaturesEnum;
|
|
5
|
+
(function (HemsOneMeterApplianceAvailableFeaturesEnum) {
|
|
6
|
+
/** If the meter can get the live power consumption in Watt */
|
|
7
|
+
HemsOneMeterApplianceAvailableFeaturesEnum["LivePowerConsumption"] = "LivePowerConsumption";
|
|
8
|
+
/** If the meter can read the current meter values in Wh */
|
|
9
|
+
HemsOneMeterApplianceAvailableFeaturesEnum["MeterValues"] = "MeterValues";
|
|
10
|
+
})(HemsOneMeterApplianceAvailableFeaturesEnum || (exports.HemsOneMeterApplianceAvailableFeaturesEnum = HemsOneMeterApplianceAvailableFeaturesEnum = {}));
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare enum HemsOneMeterApplianceAvailableFeaturesEnum {
|
|
2
|
+
/** If the meter can get the live power consumption in Watt */
|
|
3
|
+
LivePowerConsumption = "LivePowerConsumption",
|
|
4
|
+
/** If the meter can read the current meter values in Wh */
|
|
5
|
+
MeterValues = "MeterValues"
|
|
6
|
+
}
|
|
7
|
+
export interface HemsOneMeterAppliance {
|
|
8
|
+
availableFeatures: HemsOneMeterApplianceAvailableFeaturesEnum[];
|
|
9
|
+
meterNumber?: string;
|
|
10
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a detected network device with its connectivity information.
|
|
3
|
+
*/
|
|
4
|
+
export interface HemsOneNetworkDevice {
|
|
5
|
+
/** Unique identifier for the device */
|
|
6
|
+
id: string;
|
|
7
|
+
/** Network hostname of the device */
|
|
8
|
+
hostname: string;
|
|
9
|
+
/** IP address of the device */
|
|
10
|
+
ipAddress: string;
|
|
11
|
+
/** MAC address of the device (if available) */
|
|
12
|
+
macAddress?: string;
|
|
13
|
+
/** Whether the device is currently online */
|
|
14
|
+
isOnline: boolean;
|
|
15
|
+
/** Timestamp when the device was last seen */
|
|
16
|
+
lastSeen: Date;
|
|
17
|
+
/** List of open network ports on the device */
|
|
18
|
+
ports?: HemsOneNetworkPort[];
|
|
19
|
+
/** Access status for the device */
|
|
20
|
+
accessStatus: HemsOneNetworkDeviceAccessStatus | undefined;
|
|
21
|
+
}
|
|
22
|
+
export type HemsOneNetworkDeviceAccessStatus = 'granted' | 'denied' | 'pending';
|
|
23
|
+
/**
|
|
24
|
+
* Represents an open network port on a device.
|
|
25
|
+
*/
|
|
26
|
+
export interface HemsOneNetworkPort {
|
|
27
|
+
/** Port number */
|
|
28
|
+
port: number;
|
|
29
|
+
/** Service name running on the port (if detected) */
|
|
30
|
+
service?: string;
|
|
31
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.HemsOneSourceEnum = void 0;
|
|
4
|
+
var HemsOneSourceEnum;
|
|
5
|
+
(function (HemsOneSourceEnum) {
|
|
6
|
+
HemsOneSourceEnum["Device"] = "device";
|
|
7
|
+
HemsOneSourceEnum["Cloud"] = "cloud";
|
|
8
|
+
})(HemsOneSourceEnum || (exports.HemsOneSourceEnum = HemsOneSourceEnum = {}));
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Represents a vehicle in the HEMS one system.
|
|
3
|
+
* Contains all relevant information about an electric vehicle.
|
|
4
|
+
*/
|
|
5
|
+
export interface HemsOneVehicle {
|
|
6
|
+
/** Unique identifier for the vehicle */
|
|
7
|
+
id: string;
|
|
8
|
+
name: string;
|
|
9
|
+
licensePlate?: string;
|
|
10
|
+
batterySizeKwh?: number;
|
|
11
|
+
pinnedChargingCardId?: string;
|
|
12
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export interface HemsOneWebsocketConnection {
|
|
2
|
+
send(data: string): void;
|
|
3
|
+
close(code?: number, reason?: string): void;
|
|
4
|
+
on(event: 'message', listener: (data: Buffer) => void): this;
|
|
5
|
+
on(event: 'close', listener: (code: number, reason: Buffer) => void): this;
|
|
6
|
+
on(event: 'error', listener: (error: Error) => void): this;
|
|
7
|
+
readyState: number;
|
|
8
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Auto-generated file containing the current SDK version.
|
|
4
|
+
* This file is generated by scripts/extract-version.js and should not be edited manually.
|
|
5
|
+
*/
|
|
6
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
7
|
+
exports.SDK_VERSION = void 0;
|
|
8
|
+
exports.getSdkVersion = getSdkVersion;
|
|
9
|
+
/**
|
|
10
|
+
* Current version of the enyo Energy App SDK.
|
|
11
|
+
*/
|
|
12
|
+
exports.SDK_VERSION = '0.0.34';
|
|
13
|
+
/**
|
|
14
|
+
* Gets the current SDK version.
|
|
15
|
+
* @returns The semantic version string of the SDK
|
|
16
|
+
*/
|
|
17
|
+
function getSdkVersion() {
|
|
18
|
+
return exports.SDK_VERSION;
|
|
19
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auto-generated file containing the current SDK version.
|
|
3
|
+
* This file is generated by scripts/extract-version.js and should not be edited manually.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Current version of the enyo Energy App SDK.
|
|
7
|
+
*/
|
|
8
|
+
export declare const SDK_VERSION = "0.0.34";
|
|
9
|
+
/**
|
|
10
|
+
* Gets the current SDK version.
|
|
11
|
+
* @returns The semantic version string of the SDK
|
|
12
|
+
*/
|
|
13
|
+
export declare function getSdkVersion(): string;
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { ConnectInterval } from "./packages/connect-interval.js";
|
|
2
|
+
import { ConnectModbus } from "./packages/connect-modbus.js";
|
|
3
|
+
import { ConnectNetworkDevices } from "./packages/connect-network-devices.js";
|
|
4
|
+
import { ConnectStorage } from "./packages/connect-storage.js";
|
|
5
|
+
import { ConnectAppliances } from "./packages/connect-appliance.js";
|
|
6
|
+
/**
|
|
7
|
+
* Main API interface for Connect EMS packages.
|
|
8
|
+
* Provides access to all system capabilities including lifecycle management,
|
|
9
|
+
* network operations, storage, and device communication.
|
|
10
|
+
*/
|
|
11
|
+
export interface ConnectEmsApi {
|
|
12
|
+
/** Register a callback that gets called when the package is initialized */
|
|
13
|
+
register: (callback: (packageName: string, version: number) => void) => void;
|
|
14
|
+
/** Register a callback that gets called when the system is shutting down */
|
|
15
|
+
onShutdown: (callback: () => Promise<void>) => void;
|
|
16
|
+
/** Check if the system is currently online */
|
|
17
|
+
isOnline: () => boolean;
|
|
18
|
+
/** Get the fetch API for HTTP requests */
|
|
19
|
+
useFetch: () => typeof fetch;
|
|
20
|
+
/** Get the interval management API */
|
|
21
|
+
useInterval: () => ConnectInterval;
|
|
22
|
+
/** Get the Modbus communication API */
|
|
23
|
+
useModbus: () => ConnectModbus;
|
|
24
|
+
/** Get the network device discovery API */
|
|
25
|
+
useNetworkDevices: () => ConnectNetworkDevices;
|
|
26
|
+
/** Get the persistent storage API */
|
|
27
|
+
useStorage: () => ConnectStorage;
|
|
28
|
+
/** Get the Appliance API */
|
|
29
|
+
useAppliances: () => ConnectAppliances;
|
|
30
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export type ConnectEmsPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'Modbus';
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
import { ConnectEmsPermissionType } from "./connect-ems-permission.type.js";
|
|
2
|
+
export type ConnectPackageLanguage = 'de' | 'en';
|
|
3
|
+
export declare enum ConnectPackageCategory {
|
|
4
|
+
Inverter = "inverter",
|
|
5
|
+
Wallbox = "wallbox",
|
|
6
|
+
Meter = "meter",
|
|
7
|
+
SmartControl = "smart-control"
|
|
8
|
+
}
|
|
9
|
+
/**
|
|
10
|
+
* Configuration options for restricting internet access in a Connect EMS package.
|
|
11
|
+
* Defines which internet origins (domains) the EMS Integration is allowed to access.
|
|
12
|
+
*/
|
|
13
|
+
export interface ConnectPackageRestrictedInternetAccessOption {
|
|
14
|
+
/** List of allowed internet origins (domains) that the EMS Integration can access. Only these origins will be accessible. This information is shown to the user */
|
|
15
|
+
origins: string[];
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Optional configuration settings for a Connect EMS package.
|
|
19
|
+
*/
|
|
20
|
+
export interface ConnectPackageOptions {
|
|
21
|
+
/** Configuration for restricting internet access to specific domains */
|
|
22
|
+
restrictedInternetAccess?: ConnectPackageRestrictedInternetAccessOption;
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Localized store entry information for a Connect EMS package.
|
|
26
|
+
* Contains all the display information shown to users in the package store.
|
|
27
|
+
*/
|
|
28
|
+
export interface ConnectPackageStoreEntry {
|
|
29
|
+
/** Language code for this store entry */
|
|
30
|
+
language: ConnectPackageLanguage;
|
|
31
|
+
/** Display title of the package */
|
|
32
|
+
title: string;
|
|
33
|
+
/** Brief description shown in package listings */
|
|
34
|
+
shortDescription: string;
|
|
35
|
+
/** Detailed description of the package functionality */
|
|
36
|
+
description: string;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* Complete definition for a Connect EMS package.
|
|
40
|
+
* This interface defines all the metadata, permissions, and configuration
|
|
41
|
+
* required to register a package with the Connect EMS system.
|
|
42
|
+
*/
|
|
43
|
+
export interface ConnectPackageDefinition {
|
|
44
|
+
/** Schema version for the package definition format */
|
|
45
|
+
version: '1';
|
|
46
|
+
/** Unique identifier for the package */
|
|
47
|
+
packageName: string;
|
|
48
|
+
/** Categories that this package belongs to */
|
|
49
|
+
categories: ConnectPackageCategory[];
|
|
50
|
+
/** Localized store information for different languages */
|
|
51
|
+
storeEntry: ConnectPackageStoreEntry[];
|
|
52
|
+
/** Required permissions for this package to function */
|
|
53
|
+
permissions: ConnectEmsPermissionType[];
|
|
54
|
+
/** Optional configuration settings */
|
|
55
|
+
options?: ConnectPackageOptions;
|
|
56
|
+
}
|
|
57
|
+
export declare function defineConnectEmsPackage(definition: ConnectPackageDefinition): ConnectPackageDefinition;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export var ConnectPackageCategory;
|
|
2
|
+
(function (ConnectPackageCategory) {
|
|
3
|
+
ConnectPackageCategory["Inverter"] = "inverter";
|
|
4
|
+
ConnectPackageCategory["Wallbox"] = "wallbox";
|
|
5
|
+
ConnectPackageCategory["Meter"] = "meter";
|
|
6
|
+
ConnectPackageCategory["SmartControl"] = "smart-control";
|
|
7
|
+
})(ConnectPackageCategory || (ConnectPackageCategory = {}));
|
|
8
|
+
export function defineConnectEmsPackage(definition) {
|
|
9
|
+
return definition;
|
|
10
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export declare enum EnergyAppApplianceTypeEnum {
|
|
2
|
+
Inverter = "Inverter",
|
|
3
|
+
Charger = "Charger",
|
|
4
|
+
Storage = "Storage",
|
|
5
|
+
Meter = "Meter",
|
|
6
|
+
HeatPump = "heat-pump",
|
|
7
|
+
EnergyManagement = "energy-management",
|
|
8
|
+
BatteryStorage = "battery-storage",
|
|
9
|
+
ClimateControl = "climate-control"
|
|
10
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export var EnergyAppApplianceTypeEnum;
|
|
2
|
+
(function (EnergyAppApplianceTypeEnum) {
|
|
3
|
+
EnergyAppApplianceTypeEnum["Inverter"] = "Inverter";
|
|
4
|
+
EnergyAppApplianceTypeEnum["Charger"] = "Charger";
|
|
5
|
+
EnergyAppApplianceTypeEnum["Storage"] = "Storage";
|
|
6
|
+
EnergyAppApplianceTypeEnum["Meter"] = "Meter";
|
|
7
|
+
EnergyAppApplianceTypeEnum["HeatPump"] = "heat-pump";
|
|
8
|
+
EnergyAppApplianceTypeEnum["EnergyManagement"] = "energy-management";
|
|
9
|
+
EnergyAppApplianceTypeEnum["BatteryStorage"] = "battery-storage";
|
|
10
|
+
EnergyAppApplianceTypeEnum["ClimateControl"] = "climate-control";
|
|
11
|
+
})(EnergyAppApplianceTypeEnum || (EnergyAppApplianceTypeEnum = {}));
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { EnergyAppPackageLanguage } from "./energy-app-package-definition.js";
|
|
2
|
+
export interface EnergyAppPackageConfigurationTranslatedValue {
|
|
3
|
+
/** Language code */
|
|
4
|
+
language: EnergyAppPackageLanguage;
|
|
5
|
+
/** The displayed value */
|
|
6
|
+
value: string;
|
|
7
|
+
}
|
|
8
|
+
export interface EnergyAppPackageConfigurationSettingSelectOption {
|
|
9
|
+
value: string;
|
|
10
|
+
/** The displayed name of the option */
|
|
11
|
+
optionName: EnergyAppPackageConfigurationTranslatedValue[];
|
|
12
|
+
}
|
|
13
|
+
export interface EnergyAppPackageConfigurationSetting {
|
|
14
|
+
/** internal name of the setting */
|
|
15
|
+
name: string;
|
|
16
|
+
/** the type of the setting */
|
|
17
|
+
type: 'text' | 'select';
|
|
18
|
+
/** if the setting is required */
|
|
19
|
+
required: boolean;
|
|
20
|
+
/** The displayed name of the field */
|
|
21
|
+
fieldName: EnergyAppPackageConfigurationTranslatedValue[];
|
|
22
|
+
/** An optional description for the user*/
|
|
23
|
+
fieldDescription?: EnergyAppPackageConfigurationTranslatedValue[];
|
|
24
|
+
/** The optional default value or default selection value*/
|
|
25
|
+
defaultValue?: string;
|
|
26
|
+
selectOptions?: EnergyAppPackageConfigurationSettingSelectOption[];
|
|
27
|
+
}
|
|
28
|
+
export interface EnergyAppPackageConfiguration {
|
|
29
|
+
settings?: EnergyAppPackageConfigurationSetting[];
|
|
30
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { EnergyAppPermissionType } from "./energy-app-permission.type.js";
|
|
2
|
+
export type EnergyAppPackageLanguage = 'de' | 'en';
|
|
3
|
+
export declare enum EnergyAppPackageCategory {
|
|
4
|
+
Inverter = "inverter",
|
|
5
|
+
Wallbox = "wallbox",
|
|
6
|
+
Meter = "meter",
|
|
7
|
+
EnergyManagement = "energy-management",
|
|
8
|
+
HeatPump = "heat-pump",
|
|
9
|
+
BatteryStorage = "battery-storage",
|
|
10
|
+
ClimateControl = "climate-control",
|
|
11
|
+
ElectricityTariff = "electricity-tariff"
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* Configuration options for restricting internet access in an Energy App package.
|
|
15
|
+
* Defines which internet origins (domains) the Energy App is allowed to access.
|
|
16
|
+
*/
|
|
17
|
+
export interface EnergyAppPackageRestrictedInternetAccessOption {
|
|
18
|
+
/** List of allowed internet origins (domains) that the Energy App can access. Only these origins will be accessible. This information is shown to the user */
|
|
19
|
+
origins: string[];
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Optional device detection configuration for hostname detection. The check is always lower case string
|
|
23
|
+
*/
|
|
24
|
+
export interface EnergyAppPackageOptionsDeviceDetectionHostname {
|
|
25
|
+
operation: 'eq' | 'startsWith';
|
|
26
|
+
matchingValue: string;
|
|
27
|
+
}
|
|
28
|
+
export interface EnergyAppPackageOptionsDeviceDetectionModbus {
|
|
29
|
+
unitIds: number[];
|
|
30
|
+
/** Register address, for example 30001 */
|
|
31
|
+
registerAddress: number;
|
|
32
|
+
/** Register size, for example 2 for 30001 - 30002 */
|
|
33
|
+
registerSize: number;
|
|
34
|
+
/** the data type of the register, numbers will be mapped to strings to compare with matching values */
|
|
35
|
+
type: 'string' | 'UInt32BE' | 'UInt16BE' | 'UInt32LE' | 'UInt16LE';
|
|
36
|
+
/** matching values, for example the vendor names or model names */
|
|
37
|
+
matchingValues: string[];
|
|
38
|
+
}
|
|
39
|
+
export interface EnergyAppPackageOptionsDeviceDetectionHttp {
|
|
40
|
+
/** port of http call */
|
|
41
|
+
port: number;
|
|
42
|
+
/** path of http call */
|
|
43
|
+
path: string;
|
|
44
|
+
/** the operation to do */
|
|
45
|
+
operation: 'body_json_field_eq' | 'header_eq' | 'header_startsWith';
|
|
46
|
+
/** for rest APIs with json response, define the field for example device.vendor*/
|
|
47
|
+
field?: string;
|
|
48
|
+
headerName?: string;
|
|
49
|
+
/** matching values, for example the vendor names or model names */
|
|
50
|
+
matchingValues: string[];
|
|
51
|
+
}
|
|
52
|
+
export interface EnergyAppPackageOptionsDeviceDetectionOcpp {
|
|
53
|
+
/** ocpp message name, for example BootNotification */
|
|
54
|
+
message: string;
|
|
55
|
+
/** field name in the boot notification */
|
|
56
|
+
field: string;
|
|
57
|
+
/** matching values, for example the vendor names or model names */
|
|
58
|
+
matchingValues: string[];
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Optional device detection configuration
|
|
62
|
+
*/
|
|
63
|
+
export interface EnergyAppPackageOptionsDeviceDetection {
|
|
64
|
+
hostName?: EnergyAppPackageOptionsDeviceDetectionHostname[];
|
|
65
|
+
modbus?: EnergyAppPackageOptionsDeviceDetectionModbus[];
|
|
66
|
+
http?: EnergyAppPackageOptionsDeviceDetectionHttp[];
|
|
67
|
+
ocpp?: EnergyAppPackageOptionsDeviceDetectionOcpp[];
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Optional configuration settings for an Energy App package.
|
|
71
|
+
*/
|
|
72
|
+
export interface EnergyAppPackageOptions {
|
|
73
|
+
/** Configuration for restricting internet access to specific domains */
|
|
74
|
+
restrictedInternetAccess?: EnergyAppPackageRestrictedInternetAccessOption;
|
|
75
|
+
/** device detection configuration to auto-suggest this energy app on onboarding */
|
|
76
|
+
deviceDetection?: EnergyAppPackageOptionsDeviceDetection;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* Localized store entry information for an Energy App package.
|
|
80
|
+
* Contains all the display information shown to users in the package store.
|
|
81
|
+
*/
|
|
82
|
+
export interface EnergyAppPackageStoreEntry {
|
|
83
|
+
/** Language code for this store entry */
|
|
84
|
+
language: EnergyAppPackageLanguage;
|
|
85
|
+
/** Display title of the package */
|
|
86
|
+
title: string;
|
|
87
|
+
/** Brief description shown in package listings */
|
|
88
|
+
shortDescription: string;
|
|
89
|
+
/** Detailed description of the package functionality */
|
|
90
|
+
description: string;
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* Complete definition for a enyo Energy App package.
|
|
94
|
+
* This interface defines all the metadata, permissions, and configuration
|
|
95
|
+
* required to register a package with the enyo Hub.
|
|
96
|
+
*/
|
|
97
|
+
export interface EnergyAppPackageDefinition {
|
|
98
|
+
/** Schema version for the package definition format */
|
|
99
|
+
version: '1';
|
|
100
|
+
/** Unique identifier for the package */
|
|
101
|
+
packageName: string;
|
|
102
|
+
/** Optional path to the logo */
|
|
103
|
+
logo?: string;
|
|
104
|
+
/** Categories that this package belongs to */
|
|
105
|
+
categories: EnergyAppPackageCategory[];
|
|
106
|
+
/** Localized store information for different languages */
|
|
107
|
+
storeEntry: EnergyAppPackageStoreEntry[];
|
|
108
|
+
/** Required permissions for this package to function */
|
|
109
|
+
permissions: EnergyAppPermissionType[];
|
|
110
|
+
/** Optional configuration settings */
|
|
111
|
+
options?: EnergyAppPackageOptions;
|
|
112
|
+
/** The version of the enyo SDK used to build this package (automatically injected) */
|
|
113
|
+
sdkVersion: string;
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Defines an Energy App package with automatic SDK version injection.
|
|
117
|
+
* This function automatically adds the current SDK version to the package definition
|
|
118
|
+
* for debugging and compatibility tracking purposes.
|
|
119
|
+
*
|
|
120
|
+
* @param definition The Energy App package definition
|
|
121
|
+
* @returns The enhanced package definition with SDK version included
|
|
122
|
+
*/
|
|
123
|
+
export declare function defineEnergyAppPackage(definition: Omit<EnergyAppPackageDefinition, 'sdkVersion'>): EnergyAppPackageDefinition;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { getSdkVersion } from "./version.js";
|
|
2
|
+
export var EnergyAppPackageCategory;
|
|
3
|
+
(function (EnergyAppPackageCategory) {
|
|
4
|
+
EnergyAppPackageCategory["Inverter"] = "inverter";
|
|
5
|
+
EnergyAppPackageCategory["Wallbox"] = "wallbox";
|
|
6
|
+
EnergyAppPackageCategory["Meter"] = "meter";
|
|
7
|
+
EnergyAppPackageCategory["EnergyManagement"] = "energy-management";
|
|
8
|
+
EnergyAppPackageCategory["HeatPump"] = "heat-pump";
|
|
9
|
+
EnergyAppPackageCategory["BatteryStorage"] = "battery-storage";
|
|
10
|
+
EnergyAppPackageCategory["ClimateControl"] = "climate-control";
|
|
11
|
+
EnergyAppPackageCategory["ElectricityTariff"] = "electricity-tariff";
|
|
12
|
+
})(EnergyAppPackageCategory || (EnergyAppPackageCategory = {}));
|
|
13
|
+
/**
|
|
14
|
+
* Defines an Energy App package with automatic SDK version injection.
|
|
15
|
+
* This function automatically adds the current SDK version to the package definition
|
|
16
|
+
* for debugging and compatibility tracking purposes.
|
|
17
|
+
*
|
|
18
|
+
* @param definition The Energy App package definition
|
|
19
|
+
* @returns The enhanced package definition with SDK version included
|
|
20
|
+
*/
|
|
21
|
+
export function defineEnergyAppPackage(definition) {
|
|
22
|
+
return {
|
|
23
|
+
...definition,
|
|
24
|
+
sdkVersion: getSdkVersion()
|
|
25
|
+
};
|
|
26
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export type EnergyAppPermissionType = 'RestrictedInternetAccess' | 'NetworkDeviceDiscovery' | 'NetworkDeviceSearch' | 'NetworkDeviceAccess' | 'Modbus' | 'Storage' | 'Appliance' | 'AllAppliances' | 'SendDataBusValues' | 'SubscribeDataBus' | 'SendDataBusCommands' | 'OcppServer';
|
|
2
|
+
export declare enum EnergyAppPermissionTypeEnum {
|
|
3
|
+
RestrictedInternetAccess = "RestrictedInternetAccess",
|
|
4
|
+
NetworkDeviceDiscovery = "NetworkDeviceDiscovery",
|
|
5
|
+
NetworkDeviceSearch = "NetworkDeviceSearch",
|
|
6
|
+
NetworkDeviceAccess = "NetworkDeviceAccess",
|
|
7
|
+
Modbus = "Modbus",
|
|
8
|
+
Storage = "Storage",
|
|
9
|
+
Appliance = "Appliance",
|
|
10
|
+
AllAppliances = "AllAppliances",
|
|
11
|
+
SendDataBusValues = "SendDataBusValues",
|
|
12
|
+
SubscribeDataBus = "SubscribeDataBus",
|
|
13
|
+
SendDataBusCommands = "SendDataBusCommands",
|
|
14
|
+
OcppServer = "OcppServer",
|
|
15
|
+
ChargingCard = "ChargingCard",
|
|
16
|
+
Vehicle = "Vehicle",
|
|
17
|
+
Charge = "Charge"
|
|
18
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export var EnergyAppPermissionTypeEnum;
|
|
2
|
+
(function (EnergyAppPermissionTypeEnum) {
|
|
3
|
+
EnergyAppPermissionTypeEnum["RestrictedInternetAccess"] = "RestrictedInternetAccess";
|
|
4
|
+
EnergyAppPermissionTypeEnum["NetworkDeviceDiscovery"] = "NetworkDeviceDiscovery";
|
|
5
|
+
EnergyAppPermissionTypeEnum["NetworkDeviceSearch"] = "NetworkDeviceSearch";
|
|
6
|
+
EnergyAppPermissionTypeEnum["NetworkDeviceAccess"] = "NetworkDeviceAccess";
|
|
7
|
+
EnergyAppPermissionTypeEnum["Modbus"] = "Modbus";
|
|
8
|
+
EnergyAppPermissionTypeEnum["Storage"] = "Storage";
|
|
9
|
+
EnergyAppPermissionTypeEnum["Appliance"] = "Appliance";
|
|
10
|
+
EnergyAppPermissionTypeEnum["AllAppliances"] = "AllAppliances";
|
|
11
|
+
EnergyAppPermissionTypeEnum["SendDataBusValues"] = "SendDataBusValues";
|
|
12
|
+
EnergyAppPermissionTypeEnum["SubscribeDataBus"] = "SubscribeDataBus";
|
|
13
|
+
EnergyAppPermissionTypeEnum["SendDataBusCommands"] = "SendDataBusCommands";
|
|
14
|
+
EnergyAppPermissionTypeEnum["OcppServer"] = "OcppServer";
|
|
15
|
+
EnergyAppPermissionTypeEnum["ChargingCard"] = "ChargingCard";
|
|
16
|
+
EnergyAppPermissionTypeEnum["Vehicle"] = "Vehicle";
|
|
17
|
+
EnergyAppPermissionTypeEnum["Charge"] = "Charge";
|
|
18
|
+
})(EnergyAppPermissionTypeEnum || (EnergyAppPermissionTypeEnum = {}));
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
import { EnergyAppInterval } from "./packages/energy-app-interval.js";
|
|
2
|
+
import { EnergyAppModbus } from "./packages/energy-app-modbus.js";
|
|
3
|
+
import { EnergyAppStorage } from "./packages/energy-app-storage.js";
|
|
4
|
+
import { EnergyAppAppliance } from "./packages/energy-app-appliance.js";
|
|
5
|
+
import { EnergyAppNetworkDevice } from "./packages/energy-app-network-device.js";
|
|
6
|
+
import { EnergyAppDataBus } from "./packages/energy-app-data-bus.js";
|
|
7
|
+
import { EnergyAppOcpp } from "./packages/energy-app-ocpp.js";
|
|
8
|
+
import { EnergyAppCharge } from "./packages/energy-app-charge.js";
|
|
9
|
+
import { EnergyAppVehicle } from "./packages/energy-app-vehicle.js";
|
|
10
|
+
import { EnergyAppChargingCard } from "./packages/energy-app-charging-card.js";
|
|
11
|
+
import { EnergyAppAuthentication } from "./packages/energy-app-authentication.js";
|
|
12
|
+
import { EnergyAppSettings } from "./packages/energy-app-settings.js";
|
|
13
|
+
import { EnergyAppElectricityPrices } from "./packages/energy-app-electricity-prices.js";
|
|
14
|
+
import { EnergyAppNotification } from "./packages/energy-app-notification.js";
|
|
15
|
+
export declare enum EnergyAppStateEnum {
|
|
16
|
+
Launching = "launching",
|
|
17
|
+
Running = "running",
|
|
18
|
+
/** This state tells the user that a configuration is required which blocks the energy app from running*/
|
|
19
|
+
ConfigurationRequired = "configuration-required",
|
|
20
|
+
/** This state tells the user that an internet connection of the system is required which blocks the energy app from running*/
|
|
21
|
+
InternetConnectionRequired = "internet-connection-required"
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Main API interface for enyo Energy App packages.
|
|
25
|
+
* Provides access to all system capabilities including lifecycle management,
|
|
26
|
+
* network operations, storage, and device communication.
|
|
27
|
+
*/
|
|
28
|
+
export interface EnyoEnergyAppSdk {
|
|
29
|
+
/** Register a callback that gets called when the package is initialized */
|
|
30
|
+
register: (callback: (packageName: string, version: number) => void) => void;
|
|
31
|
+
/** Register a callback that gets called when the system is shutting down */
|
|
32
|
+
onShutdown: (callback: () => Promise<void>) => void;
|
|
33
|
+
/** Update the state of the Energy App. Default state set is launching*/
|
|
34
|
+
updateEnergyAppState: (state: EnergyAppStateEnum) => void;
|
|
35
|
+
/** Check if the system is currently online */
|
|
36
|
+
isSystemOnline: () => boolean;
|
|
37
|
+
/** Get the fetch API for HTTP requests */
|
|
38
|
+
useFetch: () => typeof fetch;
|
|
39
|
+
/** Get the interval management API */
|
|
40
|
+
useInterval: () => EnergyAppInterval;
|
|
41
|
+
/** Get the Modbus communication API */
|
|
42
|
+
useModbus: () => EnergyAppModbus;
|
|
43
|
+
/** Get the network device discovery API */
|
|
44
|
+
useNetworkDevices: () => EnergyAppNetworkDevice;
|
|
45
|
+
/** Get the persistent storage API */
|
|
46
|
+
useStorage: () => EnergyAppStorage;
|
|
47
|
+
/** Get the Appliance API */
|
|
48
|
+
useAppliances: () => EnergyAppAppliance;
|
|
49
|
+
/** Get the Data Bus API */
|
|
50
|
+
useDataBus: () => EnergyAppDataBus;
|
|
51
|
+
/** Get the OCPP API */
|
|
52
|
+
useOcpp: () => EnergyAppOcpp;
|
|
53
|
+
/** Get the Charge API*/
|
|
54
|
+
useCharge: () => EnergyAppCharge;
|
|
55
|
+
/** Get the Vehicle API*/
|
|
56
|
+
useVehicle: () => EnergyAppVehicle;
|
|
57
|
+
/** Get the Charging Card API*/
|
|
58
|
+
useChargingCard: () => EnergyAppChargingCard;
|
|
59
|
+
/** Get the Authentication API */
|
|
60
|
+
useAuthentication: () => EnergyAppAuthentication;
|
|
61
|
+
/** Get the Settings API */
|
|
62
|
+
useSettings: () => EnergyAppSettings;
|
|
63
|
+
/** Get the Electricity Prices API */
|
|
64
|
+
useElectricityPrices: () => EnergyAppElectricityPrices;
|
|
65
|
+
/** Get the Notification API */
|
|
66
|
+
useNotification: () => EnergyAppNotification;
|
|
67
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export var EnergyAppStateEnum;
|
|
2
|
+
(function (EnergyAppStateEnum) {
|
|
3
|
+
EnergyAppStateEnum["Launching"] = "launching";
|
|
4
|
+
EnergyAppStateEnum["Running"] = "running";
|
|
5
|
+
/** This state tells the user that a configuration is required which blocks the energy app from running*/
|
|
6
|
+
EnergyAppStateEnum["ConfigurationRequired"] = "configuration-required";
|
|
7
|
+
/** This state tells the user that an internet connection of the system is required which blocks the energy app from running*/
|
|
8
|
+
EnergyAppStateEnum["InternetConnectionRequired"] = "internet-connection-required";
|
|
9
|
+
})(EnergyAppStateEnum || (EnergyAppStateEnum = {}));
|