@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.
Files changed (330) hide show
  1. package/README.md +216 -0
  2. package/dist/cjs/connect-ems-api.cjs +2 -0
  3. package/dist/cjs/connect-ems-api.d.cts +30 -0
  4. package/dist/cjs/connect-ems-permission.enum.cjs +7 -0
  5. package/dist/cjs/connect-ems-permission.enum.d.cts +3 -0
  6. package/dist/cjs/connect-ems-permission.type.cjs +2 -0
  7. package/dist/cjs/connect-ems-permission.type.d.cts +1 -0
  8. package/dist/cjs/connect-package-definition.cjs +14 -0
  9. package/dist/cjs/connect-package-definition.d.cts +57 -0
  10. package/dist/cjs/energy-app-appliance-type.enum.cjs +14 -0
  11. package/dist/cjs/energy-app-appliance-type.enum.d.cts +10 -0
  12. package/dist/cjs/energy-app-package-configuration.cjs +2 -0
  13. package/dist/cjs/energy-app-package-configuration.d.cts +30 -0
  14. package/dist/cjs/energy-app-package-definition.cjs +30 -0
  15. package/dist/cjs/energy-app-package-definition.d.cts +123 -0
  16. package/dist/cjs/energy-app-permission.type.cjs +21 -0
  17. package/dist/cjs/energy-app-permission.type.d.cts +18 -0
  18. package/dist/cjs/enyo-energy-app-sdk.cjs +12 -0
  19. package/dist/cjs/enyo-energy-app-sdk.d.cts +67 -0
  20. package/dist/cjs/hems-one-energy-app-sdk.cjs +12 -0
  21. package/dist/cjs/hems-one-energy-app-sdk.d.cts +64 -0
  22. package/dist/cjs/implementations/modbus/EnergyAppModbusBattery.cjs +388 -0
  23. package/dist/cjs/implementations/modbus/EnergyAppModbusBattery.d.cts +59 -0
  24. package/dist/cjs/implementations/modbus/EnergyAppModbusConnectionHealth.cjs +37 -0
  25. package/dist/cjs/implementations/modbus/EnergyAppModbusConnectionHealth.d.cts +15 -0
  26. package/dist/cjs/implementations/modbus/EnergyAppModbusDataTypeConverter.cjs +130 -0
  27. package/dist/cjs/implementations/modbus/EnergyAppModbusDataTypeConverter.d.cts +41 -0
  28. package/dist/cjs/implementations/modbus/EnergyAppModbusFaultTolerantReader.cjs +49 -0
  29. package/dist/cjs/implementations/modbus/EnergyAppModbusFaultTolerantReader.d.cts +10 -0
  30. package/dist/cjs/implementations/modbus/EnergyAppModbusInverter.cjs +348 -0
  31. package/dist/cjs/implementations/modbus/EnergyAppModbusInverter.d.cts +56 -0
  32. package/dist/cjs/implementations/modbus/EnergyAppModbusMeter.cjs +199 -0
  33. package/dist/cjs/implementations/modbus/EnergyAppModbusMeter.d.cts +26 -0
  34. package/dist/cjs/implementations/modbus/EnergyAppModbusRegisterMapper.cjs +98 -0
  35. package/dist/cjs/implementations/modbus/EnergyAppModbusRegisterMapper.d.cts +13 -0
  36. package/dist/cjs/implementations/modbus/interfaces.cjs +29 -0
  37. package/dist/cjs/implementations/modbus/interfaces.d.cts +202 -0
  38. package/dist/cjs/implementations/ocpp/ocpp-common.cjs +337 -0
  39. package/dist/cjs/implementations/ocpp/ocpp-common.d.cts +75 -0
  40. package/dist/cjs/implementations/ocpp/ocpp16.cjs +51 -0
  41. package/dist/cjs/implementations/ocpp/ocpp16.d.cts +137 -0
  42. package/dist/cjs/implementations/ocpp/ocpp201.cjs +84 -0
  43. package/dist/cjs/implementations/ocpp/ocpp201.d.cts +215 -0
  44. package/dist/cjs/index.cjs +117 -0
  45. package/dist/cjs/index.d.cts +56 -0
  46. package/dist/cjs/mockConnectEmsApi.cjs +167 -0
  47. package/dist/cjs/mockConnectEmsApi.d.cts +10 -0
  48. package/dist/cjs/packages/connect-appliance.cjs +2 -0
  49. package/dist/cjs/packages/connect-appliance.d.cts +24 -0
  50. package/dist/cjs/packages/connect-http-api.cjs +2 -0
  51. package/dist/cjs/packages/connect-http-api.d.cts +15 -0
  52. package/dist/cjs/packages/connect-interval.cjs +2 -0
  53. package/dist/cjs/packages/connect-interval.d.cts +15 -0
  54. package/dist/cjs/packages/connect-modbus.cjs +2 -0
  55. package/dist/cjs/packages/connect-modbus.d.cts +60 -0
  56. package/dist/cjs/packages/connect-network-devices.cjs +2 -0
  57. package/dist/cjs/packages/connect-network-devices.d.cts +40 -0
  58. package/dist/cjs/packages/connect-storage.cjs +2 -0
  59. package/dist/cjs/packages/connect-storage.d.cts +14 -0
  60. package/dist/cjs/packages/energy-app-appliance.cjs +2 -0
  61. package/dist/cjs/packages/energy-app-appliance.d.cts +17 -0
  62. package/dist/cjs/packages/energy-app-authentication.cjs +2 -0
  63. package/dist/cjs/packages/energy-app-authentication.d.cts +52 -0
  64. package/dist/cjs/packages/energy-app-charge.cjs +2 -0
  65. package/dist/cjs/packages/energy-app-charge.d.cts +13 -0
  66. package/dist/cjs/packages/energy-app-charging-card.cjs +2 -0
  67. package/dist/cjs/packages/energy-app-charging-card.d.cts +11 -0
  68. package/dist/cjs/packages/energy-app-data-bus.cjs +2 -0
  69. package/dist/cjs/packages/energy-app-data-bus.d.cts +12 -0
  70. package/dist/cjs/packages/energy-app-electricity-prices.cjs +2 -0
  71. package/dist/cjs/packages/energy-app-electricity-prices.d.cts +59 -0
  72. package/dist/cjs/packages/energy-app-interval.cjs +2 -0
  73. package/dist/cjs/packages/energy-app-interval.d.cts +15 -0
  74. package/dist/cjs/packages/energy-app-modbus.cjs +2 -0
  75. package/dist/cjs/packages/energy-app-modbus.d.cts +46 -0
  76. package/dist/cjs/packages/energy-app-network-device.cjs +2 -0
  77. package/dist/cjs/packages/energy-app-network-device.d.cts +25 -0
  78. package/dist/cjs/packages/energy-app-notification.cjs +2 -0
  79. package/dist/cjs/packages/energy-app-notification.d.cts +50 -0
  80. package/dist/cjs/packages/energy-app-ocpp.cjs +16 -0
  81. package/dist/cjs/packages/energy-app-ocpp.d.cts +52 -0
  82. package/dist/cjs/packages/energy-app-settings.cjs +2 -0
  83. package/dist/cjs/packages/energy-app-settings.d.cts +47 -0
  84. package/dist/cjs/packages/energy-app-storage.cjs +2 -0
  85. package/dist/cjs/packages/energy-app-storage.d.cts +14 -0
  86. package/dist/cjs/packages/energy-app-vehicle.cjs +2 -0
  87. package/dist/cjs/packages/energy-app-vehicle.d.cts +11 -0
  88. package/dist/cjs/permission-not-granted.cjs +18 -0
  89. package/dist/cjs/permission-not-granted.d.cts +8 -0
  90. package/dist/cjs/types/connect-appliance-type.enum.cjs +10 -0
  91. package/dist/cjs/types/connect-appliance-type.enum.d.cts +6 -0
  92. package/dist/cjs/types/energy-app-settings.cjs +2 -0
  93. package/dist/cjs/types/energy-app-settings.d.cts +74 -0
  94. package/dist/cjs/types/enyo-appliance.cjs +33 -0
  95. package/dist/cjs/types/enyo-appliance.d.cts +81 -0
  96. package/dist/cjs/types/enyo-authentication.cjs +9 -0
  97. package/dist/cjs/types/enyo-authentication.d.cts +69 -0
  98. package/dist/cjs/types/enyo-battery-appliance.cjs +2 -0
  99. package/dist/cjs/types/enyo-battery-appliance.d.cts +6 -0
  100. package/dist/cjs/types/enyo-charge.cjs +15 -0
  101. package/dist/cjs/types/enyo-charge.d.cts +82 -0
  102. package/dist/cjs/types/enyo-charger-appliance.cjs +41 -0
  103. package/dist/cjs/types/enyo-charger-appliance.d.cts +49 -0
  104. package/dist/cjs/types/enyo-charging-card.cjs +2 -0
  105. package/dist/cjs/types/enyo-charging-card.d.cts +11 -0
  106. package/dist/cjs/types/enyo-data-bus-value.cjs +78 -0
  107. package/dist/cjs/types/enyo-data-bus-value.d.cts +379 -0
  108. package/dist/cjs/types/enyo-electricity-prices.cjs +2 -0
  109. package/dist/cjs/types/enyo-electricity-prices.d.cts +63 -0
  110. package/dist/cjs/types/enyo-energy-tariff.cjs +2 -0
  111. package/dist/cjs/types/enyo-energy-tariff.d.cts +70 -0
  112. package/dist/cjs/types/enyo-heatpump-appliance.cjs +19 -0
  113. package/dist/cjs/types/enyo-heatpump-appliance.d.cts +34 -0
  114. package/dist/cjs/types/enyo-inverter-appliance.cjs +2 -0
  115. package/dist/cjs/types/enyo-inverter-appliance.d.cts +3 -0
  116. package/dist/cjs/types/enyo-meter-appliance.cjs +10 -0
  117. package/dist/cjs/types/enyo-meter-appliance.d.cts +10 -0
  118. package/dist/cjs/types/enyo-network-device.cjs +2 -0
  119. package/dist/cjs/types/enyo-network-device.d.cts +31 -0
  120. package/dist/cjs/types/enyo-notification.cjs +2 -0
  121. package/dist/cjs/types/enyo-notification.d.cts +48 -0
  122. package/dist/cjs/types/enyo-settings.cjs +2 -0
  123. package/dist/cjs/types/enyo-settings.d.cts +74 -0
  124. package/dist/cjs/types/enyo-source.enum.cjs +8 -0
  125. package/dist/cjs/types/enyo-source.enum.d.cts +4 -0
  126. package/dist/cjs/types/enyo-vehicle.cjs +2 -0
  127. package/dist/cjs/types/enyo-vehicle.d.cts +12 -0
  128. package/dist/cjs/types/enyo-websocket-connection.cjs +2 -0
  129. package/dist/cjs/types/enyo-websocket-connection.d.cts +8 -0
  130. package/dist/cjs/types/hems-one-appliance.cjs +33 -0
  131. package/dist/cjs/types/hems-one-appliance.d.cts +81 -0
  132. package/dist/cjs/types/hems-one-authentication.cjs +9 -0
  133. package/dist/cjs/types/hems-one-authentication.d.cts +69 -0
  134. package/dist/cjs/types/hems-one-battery-appliance.cjs +2 -0
  135. package/dist/cjs/types/hems-one-battery-appliance.d.cts +6 -0
  136. package/dist/cjs/types/hems-one-charge.cjs +15 -0
  137. package/dist/cjs/types/hems-one-charge.d.cts +82 -0
  138. package/dist/cjs/types/hems-one-charger-appliance.cjs +41 -0
  139. package/dist/cjs/types/hems-one-charger-appliance.d.cts +49 -0
  140. package/dist/cjs/types/hems-one-charging-card.cjs +2 -0
  141. package/dist/cjs/types/hems-one-charging-card.d.cts +11 -0
  142. package/dist/cjs/types/hems-one-data-bus-command.cjs +9 -0
  143. package/dist/cjs/types/hems-one-data-bus-command.d.cts +34 -0
  144. package/dist/cjs/types/hems-one-data-bus-value.cjs +78 -0
  145. package/dist/cjs/types/hems-one-data-bus-value.d.cts +379 -0
  146. package/dist/cjs/types/hems-one-electricity-prices.cjs +2 -0
  147. package/dist/cjs/types/hems-one-electricity-prices.d.cts +63 -0
  148. package/dist/cjs/types/hems-one-energy-tariff.cjs +2 -0
  149. package/dist/cjs/types/hems-one-energy-tariff.d.cts +70 -0
  150. package/dist/cjs/types/hems-one-heatpump-appliance.cjs +19 -0
  151. package/dist/cjs/types/hems-one-heatpump-appliance.d.cts +34 -0
  152. package/dist/cjs/types/hems-one-inverter-appliance.cjs +2 -0
  153. package/dist/cjs/types/hems-one-inverter-appliance.d.cts +3 -0
  154. package/dist/cjs/types/hems-one-meter-appliance.cjs +10 -0
  155. package/dist/cjs/types/hems-one-meter-appliance.d.cts +10 -0
  156. package/dist/cjs/types/hems-one-network-device.cjs +2 -0
  157. package/dist/cjs/types/hems-one-network-device.d.cts +31 -0
  158. package/dist/cjs/types/hems-one-source.enum.cjs +8 -0
  159. package/dist/cjs/types/hems-one-source.enum.d.cts +4 -0
  160. package/dist/cjs/types/hems-one-vehicle.cjs +2 -0
  161. package/dist/cjs/types/hems-one-vehicle.d.cts +12 -0
  162. package/dist/cjs/types/hems-one-websocket-connection.cjs +2 -0
  163. package/dist/cjs/types/hems-one-websocket-connection.d.cts +8 -0
  164. package/dist/cjs/version.cjs +19 -0
  165. package/dist/cjs/version.d.cts +13 -0
  166. package/dist/connect-ems-api.d.ts +30 -0
  167. package/dist/connect-ems-api.js +1 -0
  168. package/dist/connect-ems-permission.enum.d.ts +3 -0
  169. package/dist/connect-ems-permission.enum.js +4 -0
  170. package/dist/connect-ems-permission.type.d.ts +1 -0
  171. package/dist/connect-ems-permission.type.js +1 -0
  172. package/dist/connect-package-definition.d.ts +57 -0
  173. package/dist/connect-package-definition.js +10 -0
  174. package/dist/energy-app-appliance-type.enum.d.ts +10 -0
  175. package/dist/energy-app-appliance-type.enum.js +11 -0
  176. package/dist/energy-app-package-configuration.d.ts +30 -0
  177. package/dist/energy-app-package-configuration.js +1 -0
  178. package/dist/energy-app-package-definition.d.ts +123 -0
  179. package/dist/energy-app-package-definition.js +26 -0
  180. package/dist/energy-app-permission.type.d.ts +18 -0
  181. package/dist/energy-app-permission.type.js +18 -0
  182. package/dist/enyo-energy-app-sdk.d.ts +67 -0
  183. package/dist/enyo-energy-app-sdk.js +9 -0
  184. package/dist/hems-one-energy-app-sdk.d.ts +67 -0
  185. package/dist/hems-one-energy-app-sdk.js +9 -0
  186. package/dist/implementations/modbus/EnergyAppModbusBattery.d.ts +59 -0
  187. package/dist/implementations/modbus/EnergyAppModbusBattery.js +384 -0
  188. package/dist/implementations/modbus/EnergyAppModbusConnectionHealth.d.ts +15 -0
  189. package/dist/implementations/modbus/EnergyAppModbusConnectionHealth.js +33 -0
  190. package/dist/implementations/modbus/EnergyAppModbusDataTypeConverter.d.ts +41 -0
  191. package/dist/implementations/modbus/EnergyAppModbusDataTypeConverter.js +126 -0
  192. package/dist/implementations/modbus/EnergyAppModbusFaultTolerantReader.d.ts +10 -0
  193. package/dist/implementations/modbus/EnergyAppModbusFaultTolerantReader.js +45 -0
  194. package/dist/implementations/modbus/EnergyAppModbusInverter.d.ts +56 -0
  195. package/dist/implementations/modbus/EnergyAppModbusInverter.js +344 -0
  196. package/dist/implementations/modbus/EnergyAppModbusMeter.d.ts +26 -0
  197. package/dist/implementations/modbus/EnergyAppModbusMeter.js +195 -0
  198. package/dist/implementations/modbus/EnergyAppModbusRegisterMapper.d.ts +13 -0
  199. package/dist/implementations/modbus/EnergyAppModbusRegisterMapper.js +94 -0
  200. package/dist/implementations/modbus/interfaces.d.ts +202 -0
  201. package/dist/implementations/modbus/interfaces.js +23 -0
  202. package/dist/implementations/ocpp/ocpp-common.d.ts +75 -0
  203. package/dist/implementations/ocpp/ocpp-common.js +328 -0
  204. package/dist/implementations/ocpp/ocpp16.d.ts +137 -0
  205. package/dist/implementations/ocpp/ocpp16.js +48 -0
  206. package/dist/implementations/ocpp/ocpp201.d.ts +215 -0
  207. package/dist/implementations/ocpp/ocpp201.js +81 -0
  208. package/dist/index.d.ts +56 -0
  209. package/dist/index.js +99 -0
  210. package/dist/mockConnectEmsApi.d.ts +10 -0
  211. package/dist/mockConnectEmsApi.js +160 -0
  212. package/dist/packages/connect-appliance.d.ts +24 -0
  213. package/dist/packages/connect-appliance.js +1 -0
  214. package/dist/packages/connect-http-api.d.ts +15 -0
  215. package/dist/packages/connect-http-api.js +1 -0
  216. package/dist/packages/connect-interval.d.ts +15 -0
  217. package/dist/packages/connect-interval.js +1 -0
  218. package/dist/packages/connect-modbus.d.ts +60 -0
  219. package/dist/packages/connect-modbus.js +1 -0
  220. package/dist/packages/connect-network-devices.d.ts +40 -0
  221. package/dist/packages/connect-network-devices.js +1 -0
  222. package/dist/packages/connect-storage.d.ts +14 -0
  223. package/dist/packages/connect-storage.js +1 -0
  224. package/dist/packages/energy-app-appliance.d.ts +17 -0
  225. package/dist/packages/energy-app-appliance.js +1 -0
  226. package/dist/packages/energy-app-authentication.d.ts +52 -0
  227. package/dist/packages/energy-app-authentication.js +1 -0
  228. package/dist/packages/energy-app-charge.d.ts +13 -0
  229. package/dist/packages/energy-app-charge.js +1 -0
  230. package/dist/packages/energy-app-charging-card.d.ts +11 -0
  231. package/dist/packages/energy-app-charging-card.js +1 -0
  232. package/dist/packages/energy-app-data-bus.d.ts +12 -0
  233. package/dist/packages/energy-app-data-bus.js +1 -0
  234. package/dist/packages/energy-app-electricity-prices.d.ts +59 -0
  235. package/dist/packages/energy-app-electricity-prices.js +1 -0
  236. package/dist/packages/energy-app-interval.d.ts +15 -0
  237. package/dist/packages/energy-app-interval.js +1 -0
  238. package/dist/packages/energy-app-modbus.d.ts +46 -0
  239. package/dist/packages/energy-app-modbus.js +1 -0
  240. package/dist/packages/energy-app-network-device.d.ts +25 -0
  241. package/dist/packages/energy-app-network-device.js +1 -0
  242. package/dist/packages/energy-app-notification.d.ts +50 -0
  243. package/dist/packages/energy-app-notification.js +1 -0
  244. package/dist/packages/energy-app-ocpp.d.ts +52 -0
  245. package/dist/packages/energy-app-ocpp.js +13 -0
  246. package/dist/packages/energy-app-settings.d.ts +47 -0
  247. package/dist/packages/energy-app-settings.js +1 -0
  248. package/dist/packages/energy-app-storage.d.ts +14 -0
  249. package/dist/packages/energy-app-storage.js +1 -0
  250. package/dist/packages/energy-app-vehicle.d.ts +11 -0
  251. package/dist/packages/energy-app-vehicle.js +1 -0
  252. package/dist/permission-not-granted.d.ts +8 -0
  253. package/dist/permission-not-granted.js +14 -0
  254. package/dist/types/connect-appliance-type.enum.d.ts +6 -0
  255. package/dist/types/connect-appliance-type.enum.js +7 -0
  256. package/dist/types/energy-app-settings.d.ts +74 -0
  257. package/dist/types/energy-app-settings.js +1 -0
  258. package/dist/types/enyo-appliance.d.ts +81 -0
  259. package/dist/types/enyo-appliance.js +30 -0
  260. package/dist/types/enyo-authentication.d.ts +69 -0
  261. package/dist/types/enyo-authentication.js +6 -0
  262. package/dist/types/enyo-battery-appliance.d.ts +6 -0
  263. package/dist/types/enyo-battery-appliance.js +1 -0
  264. package/dist/types/enyo-charge.d.ts +82 -0
  265. package/dist/types/enyo-charge.js +12 -0
  266. package/dist/types/enyo-charger-appliance.d.ts +49 -0
  267. package/dist/types/enyo-charger-appliance.js +38 -0
  268. package/dist/types/enyo-charging-card.d.ts +11 -0
  269. package/dist/types/enyo-charging-card.js +1 -0
  270. package/dist/types/enyo-data-bus-value.d.ts +379 -0
  271. package/dist/types/enyo-data-bus-value.js +75 -0
  272. package/dist/types/enyo-electricity-prices.d.ts +63 -0
  273. package/dist/types/enyo-electricity-prices.js +1 -0
  274. package/dist/types/enyo-energy-tariff.d.ts +70 -0
  275. package/dist/types/enyo-energy-tariff.js +1 -0
  276. package/dist/types/enyo-heatpump-appliance.d.ts +34 -0
  277. package/dist/types/enyo-heatpump-appliance.js +16 -0
  278. package/dist/types/enyo-inverter-appliance.d.ts +3 -0
  279. package/dist/types/enyo-inverter-appliance.js +1 -0
  280. package/dist/types/enyo-meter-appliance.d.ts +10 -0
  281. package/dist/types/enyo-meter-appliance.js +7 -0
  282. package/dist/types/enyo-network-device.d.ts +31 -0
  283. package/dist/types/enyo-network-device.js +1 -0
  284. package/dist/types/enyo-notification.d.ts +48 -0
  285. package/dist/types/enyo-notification.js +1 -0
  286. package/dist/types/enyo-settings.d.ts +74 -0
  287. package/dist/types/enyo-settings.js +1 -0
  288. package/dist/types/enyo-source.enum.d.ts +4 -0
  289. package/dist/types/enyo-source.enum.js +5 -0
  290. package/dist/types/enyo-vehicle.d.ts +12 -0
  291. package/dist/types/enyo-vehicle.js +1 -0
  292. package/dist/types/enyo-websocket-connection.d.ts +8 -0
  293. package/dist/types/enyo-websocket-connection.js +1 -0
  294. package/dist/types/hems-one-appliance.d.ts +81 -0
  295. package/dist/types/hems-one-appliance.js +30 -0
  296. package/dist/types/hems-one-authentication.d.ts +69 -0
  297. package/dist/types/hems-one-authentication.js +6 -0
  298. package/dist/types/hems-one-battery-appliance.d.ts +6 -0
  299. package/dist/types/hems-one-battery-appliance.js +1 -0
  300. package/dist/types/hems-one-charge.d.ts +82 -0
  301. package/dist/types/hems-one-charge.js +12 -0
  302. package/dist/types/hems-one-charger-appliance.d.ts +49 -0
  303. package/dist/types/hems-one-charger-appliance.js +38 -0
  304. package/dist/types/hems-one-charging-card.d.ts +11 -0
  305. package/dist/types/hems-one-charging-card.js +1 -0
  306. package/dist/types/hems-one-data-bus-command.d.ts +34 -0
  307. package/dist/types/hems-one-data-bus-command.js +6 -0
  308. package/dist/types/hems-one-data-bus-value.d.ts +379 -0
  309. package/dist/types/hems-one-data-bus-value.js +75 -0
  310. package/dist/types/hems-one-electricity-prices.d.ts +63 -0
  311. package/dist/types/hems-one-electricity-prices.js +1 -0
  312. package/dist/types/hems-one-energy-tariff.d.ts +70 -0
  313. package/dist/types/hems-one-energy-tariff.js +1 -0
  314. package/dist/types/hems-one-heatpump-appliance.d.ts +34 -0
  315. package/dist/types/hems-one-heatpump-appliance.js +16 -0
  316. package/dist/types/hems-one-inverter-appliance.d.ts +3 -0
  317. package/dist/types/hems-one-inverter-appliance.js +1 -0
  318. package/dist/types/hems-one-meter-appliance.d.ts +10 -0
  319. package/dist/types/hems-one-meter-appliance.js +7 -0
  320. package/dist/types/hems-one-network-device.d.ts +31 -0
  321. package/dist/types/hems-one-network-device.js +1 -0
  322. package/dist/types/hems-one-source.enum.d.ts +4 -0
  323. package/dist/types/hems-one-source.enum.js +5 -0
  324. package/dist/types/hems-one-vehicle.d.ts +12 -0
  325. package/dist/types/hems-one-vehicle.js +1 -0
  326. package/dist/types/hems-one-websocket-connection.d.ts +8 -0
  327. package/dist/types/hems-one-websocket-connection.js +1 -0
  328. package/dist/version.d.ts +13 -0
  329. package/dist/version.js +15 -0
  330. package/package.json +43 -0
@@ -0,0 +1,10 @@
1
+ export declare enum EnyoMeterApplianceAvailableFeaturesEnum {
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 EnyoMeterAppliance {
8
+ availableFeatures: EnyoMeterApplianceAvailableFeaturesEnum[];
9
+ meterNumber?: string;
10
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Represents a detected network device with its connectivity information.
3
+ */
4
+ export interface EnyoNetworkDevice {
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?: EnyoNetworkPort[];
19
+ /** Access status for the device */
20
+ accessStatus: EnyoNetworkDeviceAccessStatus | undefined;
21
+ }
22
+ export type EnyoNetworkDeviceAccessStatus = 'granted' | 'denied' | 'pending';
23
+ /**
24
+ * Represents an open network port on a device.
25
+ */
26
+ export interface EnyoNetworkPort {
27
+ /** Port number */
28
+ port: number;
29
+ /** Service name running on the port (if detected) */
30
+ service?: string;
31
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,48 @@
1
+ import { EnergyAppPackageLanguage } from "../energy-app-package-definition.cjs";
2
+ /**
3
+ * Types of notifications that can be displayed to users
4
+ */
5
+ export type EnyoNotificationType = 'info' | 'warning' | 'error' | 'success';
6
+ /**
7
+ * Priority levels for notifications affecting display order and importance
8
+ */
9
+ export type EnyoNotificationPriority = 'low' | 'normal' | 'high';
10
+ /**
11
+ * Configuration options for notification display and behavior
12
+ */
13
+ export interface EnyoNotificationOptions {
14
+ /** Whether the notification persists until manually dismissed by the user */
15
+ permanent?: boolean;
16
+ /** Optional expiration time in ISO format for auto-dismissal */
17
+ expiresAtIso?: string;
18
+ /** Priority level affecting display order and visual emphasis */
19
+ priority?: EnyoNotificationPriority;
20
+ /** Optional appliance ID if notification is specific to an appliance */
21
+ applianceId?: string;
22
+ }
23
+ /**
24
+ * Translated notification content for multi-language support
25
+ */
26
+ export interface EnyoNotificationTranslation {
27
+ /** Language code for this translation */
28
+ language: EnergyAppPackageLanguage;
29
+ /** Notification message content in the specified language */
30
+ notification: string;
31
+ }
32
+ /**
33
+ * Complete notification object containing all notification data
34
+ */
35
+ export interface EnyoNotification {
36
+ /** Unique identifier for this notification */
37
+ id: string;
38
+ /** Type of notification determining visual style and urgency */
39
+ type: EnyoNotificationType;
40
+ /** Configuration options for display and behavior */
41
+ options: EnyoNotificationOptions;
42
+ /** Array of translated notification messages for different languages */
43
+ translations: EnyoNotificationTranslation[];
44
+ /** ISO timestamp when the notification was created */
45
+ createdAtIso: string;
46
+ /** Optional ISO timestamp when the notification was last updated */
47
+ updatedAtIso?: string;
48
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,74 @@
1
+ import { EnergyAppPackageLanguage } from "../energy-app-package-definition.cjs";
2
+ /**
3
+ * Represents a translated value for different languages in Energy App settings.
4
+ */
5
+ export interface EnyoPackageConfigurationTranslatedValue {
6
+ /** Language code */
7
+ language: EnergyAppPackageLanguage;
8
+ /** The displayed value */
9
+ value: string;
10
+ }
11
+ /**
12
+ * Represents an option in a select-type setting field.
13
+ */
14
+ export interface EnyoPackageConfigurationSettingSelectOption {
15
+ value: string;
16
+ /** The displayed name of the option */
17
+ optionName: EnyoPackageConfigurationTranslatedValue[];
18
+ }
19
+ /**
20
+ * Represents a single configuration setting for an Energy App package.
21
+ */
22
+ export interface EnyoPackageConfigurationSetting {
23
+ /** internal name of the setting - must be unique */
24
+ name: string;
25
+ /** the type of the setting */
26
+ type: 'text' | 'select';
27
+ /** if the setting is required */
28
+ required: boolean;
29
+ /** The displayed name of the field */
30
+ fieldName: EnyoPackageConfigurationTranslatedValue[];
31
+ /** An optional description for the user*/
32
+ fieldDescription?: EnyoPackageConfigurationTranslatedValue[];
33
+ /** The current value of the setting (optional) */
34
+ currentValue?: string;
35
+ /** Optional appliance ID. If provided, setting is for specific appliance. If omitted, setting is for the whole package */
36
+ applianceId?: string;
37
+ selectOptions?: EnyoPackageConfigurationSettingSelectOption[];
38
+ }
39
+ /**
40
+ * Configuration container for Energy App package settings.
41
+ */
42
+ export interface EnyoPackageConfiguration {
43
+ }
44
+ /**
45
+ * Represents a change event when a setting value is modified.
46
+ */
47
+ export interface EnyoSettingChangeEvent {
48
+ /** The name of the setting that changed */
49
+ settingName: string;
50
+ /** The new value of the setting */
51
+ newValue: string;
52
+ /** The previous value of the setting (if any) */
53
+ previousValue?: string;
54
+ }
55
+ /**
56
+ * Callback function type for listening to setting changes.
57
+ */
58
+ export type EnyoSettingsChangeListener = (event: EnyoSettingChangeEvent) => Promise<void> | void;
59
+ /**
60
+ * Represents a configuration setting with a unique identifier.
61
+ * Extends the base setting configuration to include an ID for tracking and management.
62
+ */
63
+ export interface EnyoSettingConfigWithId extends EnyoPackageConfigurationSetting {
64
+ /** Unique identifier for this setting */
65
+ id: string;
66
+ }
67
+ /**
68
+ * Represents a configuration setting with its current value.
69
+ * Extends the setting configuration with ID to include the actual current value.
70
+ */
71
+ export interface EnyoSettingConfigWithValue extends EnyoSettingConfigWithId {
72
+ /** Current value of the setting (if set) */
73
+ currentValue?: string;
74
+ }
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EnyoSourceEnum = void 0;
4
+ var EnyoSourceEnum;
5
+ (function (EnyoSourceEnum) {
6
+ EnyoSourceEnum["Device"] = "device";
7
+ EnyoSourceEnum["Cloud"] = "cloud";
8
+ })(EnyoSourceEnum || (exports.EnyoSourceEnum = EnyoSourceEnum = {}));
@@ -0,0 +1,4 @@
1
+ export declare enum EnyoSourceEnum {
2
+ Device = "device",
3
+ Cloud = "cloud"
4
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Represents a vehicle in the enyo system.
3
+ * Contains all relevant information about an electric vehicle.
4
+ */
5
+ export interface EnyoVehicle {
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,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,8 @@
1
+ export interface EnyoWebsocketConnection {
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,33 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HemsOneApplianceTopologyFeatureEnum = exports.HemsOneApplianceConnectionType = exports.HemsOneApplianceStateEnum = exports.HemsOneApplianceTypeEnum = void 0;
4
+ var HemsOneApplianceTypeEnum;
5
+ (function (HemsOneApplianceTypeEnum) {
6
+ HemsOneApplianceTypeEnum["Inverter"] = "Inverter";
7
+ HemsOneApplianceTypeEnum["Charger"] = "Charger";
8
+ HemsOneApplianceTypeEnum["Storage"] = "Storage";
9
+ HemsOneApplianceTypeEnum["Meter"] = "Meter";
10
+ HemsOneApplianceTypeEnum["Heatpump"] = "Heatpump";
11
+ })(HemsOneApplianceTypeEnum || (exports.HemsOneApplianceTypeEnum = HemsOneApplianceTypeEnum = {}));
12
+ var HemsOneApplianceStateEnum;
13
+ (function (HemsOneApplianceStateEnum) {
14
+ HemsOneApplianceStateEnum["Connected"] = "connected";
15
+ HemsOneApplianceStateEnum["ConnectionPending"] = "connection-pending";
16
+ HemsOneApplianceStateEnum["Offline"] = "offline";
17
+ })(HemsOneApplianceStateEnum || (exports.HemsOneApplianceStateEnum = HemsOneApplianceStateEnum = {}));
18
+ var HemsOneApplianceConnectionType;
19
+ (function (HemsOneApplianceConnectionType) {
20
+ HemsOneApplianceConnectionType["Connector"] = "Connector";
21
+ HemsOneApplianceConnectionType["Cloud"] = "Cloud";
22
+ })(HemsOneApplianceConnectionType || (exports.HemsOneApplianceConnectionType = HemsOneApplianceConnectionType = {}));
23
+ var HemsOneApplianceTopologyFeatureEnum;
24
+ (function (HemsOneApplianceTopologyFeatureEnum) {
25
+ /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */
26
+ HemsOneApplianceTopologyFeatureEnum["PrimaryMeter"] = "PrimaryMeter";
27
+ /** If the meter is an Intermediate Meter (like the meter of an Inverter) directly behind the Primary Meter */
28
+ HemsOneApplianceTopologyFeatureEnum["IntermediateOfPrimaryMeter"] = "IntermediateOfPrimaryMeter";
29
+ /** If the meter is an Intermediate Meter for a single appliance */
30
+ HemsOneApplianceTopologyFeatureEnum["IntermediateMeter"] = "PrimaryMeter";
31
+ /** If the inverter does a direct grid feed in without self consumption */
32
+ HemsOneApplianceTopologyFeatureEnum["InverterFullGridFeedIn"] = "InverterFullGridFeedIn";
33
+ })(HemsOneApplianceTopologyFeatureEnum || (exports.HemsOneApplianceTopologyFeatureEnum = HemsOneApplianceTopologyFeatureEnum = {}));
@@ -0,0 +1,81 @@
1
+ import { EnergyAppPackageLanguage } from "../energy-app-package-definition.cjs";
2
+ import { HemsOneChargerApplianceMetadata } from "./hems-one-charger-appliance.cjs";
3
+ import { HemsOneHeatpumpApplianceMetadata } from "./hems-one-heatpump-appliance.cjs";
4
+ import { HemsOneBatteryApplianceMetadata } from "./hems-one-battery-appliance.cjs";
5
+ import { HemsOneInverterApplianceMetadata } from "./hems-one-inverter-appliance.cjs";
6
+ import { HemsOneMeterAppliance } from "./hems-one-meter-appliance.cjs";
7
+ export declare enum HemsOneApplianceTypeEnum {
8
+ Inverter = "Inverter",
9
+ Charger = "Charger",
10
+ Storage = "Storage",
11
+ Meter = "Meter",
12
+ Heatpump = "Heatpump"
13
+ }
14
+ export interface HemsOneApplianceName {
15
+ language: EnergyAppPackageLanguage;
16
+ name: string;
17
+ }
18
+ export declare enum HemsOneApplianceStateEnum {
19
+ Connected = "connected",
20
+ ConnectionPending = "connection-pending",
21
+ Offline = "offline"
22
+ }
23
+ export interface HemsOneApplianceNetworkMetadata {
24
+ /** If the appliance is connected via cellular network, you can put the imsi here*/
25
+ imsi?: string;
26
+ }
27
+ export declare enum HemsOneApplianceConnectionType {
28
+ Connector = "Connector",
29
+ Cloud = "Cloud"
30
+ }
31
+ export interface HemsOneApplianceMetadata {
32
+ modelName?: string;
33
+ vendorName?: string;
34
+ serialNumber?: string;
35
+ firmwareVersion?: string;
36
+ state?: HemsOneApplianceStateEnum;
37
+ network?: HemsOneApplianceNetworkMetadata;
38
+ connectionType: HemsOneApplianceConnectionType;
39
+ }
40
+ export declare enum HemsOneApplianceTopologyFeatureEnum {
41
+ /** If the meter is the real Primary Meter collecting feed in and consumption in Wh */
42
+ PrimaryMeter = "PrimaryMeter",
43
+ /** If the meter is an Intermediate Meter (like the meter of an Inverter) directly behind the Primary Meter */
44
+ IntermediateOfPrimaryMeter = "IntermediateOfPrimaryMeter",
45
+ /** If the meter is an Intermediate Meter for a single appliance */
46
+ IntermediateMeter = "PrimaryMeter",
47
+ /** If the inverter does a direct grid feed in without self consumption */
48
+ InverterFullGridFeedIn = "InverterFullGridFeedIn"
49
+ }
50
+ export interface HemsOneApplianceTopology {
51
+ features: HemsOneApplianceTopologyFeatureEnum[];
52
+ /** Information, behind which meter this appliance is located, for example if the wallbox is behind the primary meter or a submeter. Put the appliance ID of the meter */
53
+ behindMeterApplianceId?: string;
54
+ }
55
+ /**
56
+ * Represents an appliance managed by the HEMS one system.
57
+ */
58
+ export interface HemsOneAppliance {
59
+ /** Unique identifier for the appliance */
60
+ id: string;
61
+ /** Name of the appliance in different supported languages */
62
+ name: HemsOneApplianceName[];
63
+ /** Type/category of the appliance */
64
+ type: HemsOneApplianceTypeEnum;
65
+ /** network device IDs associated with the appliance */
66
+ networkDeviceIds: string[];
67
+ /** Optional Metadata of the Appliance */
68
+ metadata?: HemsOneApplianceMetadata;
69
+ /** Topology Information of the appliance */
70
+ topology?: HemsOneApplianceTopology;
71
+ /** Optional Metadata of the Appliance if of type Meter */
72
+ meter?: HemsOneMeterAppliance;
73
+ /** Optional Metadata of the Appliance if of type Inverter */
74
+ inverter?: HemsOneInverterApplianceMetadata;
75
+ /** Optional Metadata of the Appliance if of type Charger */
76
+ charger?: HemsOneChargerApplianceMetadata;
77
+ /** Optional Metadata of the Appliance if of type Heatpump */
78
+ heatpump?: HemsOneHeatpumpApplianceMetadata;
79
+ /** Optional Metadata of the Appliance if of type Battery */
80
+ battery?: HemsOneBatteryApplianceMetadata;
81
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HemsOneAuthenticationStateEnum = void 0;
4
+ var HemsOneAuthenticationStateEnum;
5
+ (function (HemsOneAuthenticationStateEnum) {
6
+ HemsOneAuthenticationStateEnum["Authenticated"] = "Authenticated";
7
+ HemsOneAuthenticationStateEnum["AuthenticationFailed"] = "AuthenticationFailed";
8
+ HemsOneAuthenticationStateEnum["Unauthenticated"] = "Unauthenticated";
9
+ })(HemsOneAuthenticationStateEnum || (exports.HemsOneAuthenticationStateEnum = HemsOneAuthenticationStateEnum = {}));
@@ -0,0 +1,69 @@
1
+ import { EnergyAppPackageConfigurationTranslatedValue } from "./energy-app-settings.cjs";
2
+ export type HemsOneAuthenticationType = 'apiKey' | 'oauth' | 'usernamePassword';
3
+ export interface HemsOneApiKeyAuthentication {
4
+ fieldName: EnergyAppPackageConfigurationTranslatedValue[];
5
+ fieldDescription?: EnergyAppPackageConfigurationTranslatedValue[];
6
+ /** A link to an external resource where to find more information how to get an api key */
7
+ externalGuideUrl?: string;
8
+ }
9
+ export interface HemsOneUsernamePasswordAuthentication {
10
+ description?: EnergyAppPackageConfigurationTranslatedValue[];
11
+ usernameName: EnergyAppPackageConfigurationTranslatedValue[];
12
+ passwordName: EnergyAppPackageConfigurationTranslatedValue[];
13
+ /** A link to an external resource where to find more information how to get an api key */
14
+ externalGuideUrl?: string;
15
+ }
16
+ export interface HemsOneOauthAuthentication {
17
+ description?: EnergyAppPackageConfigurationTranslatedValue[];
18
+ /** If the client id and client secret need to be provided by the user*/
19
+ clientIdName?: EnergyAppPackageConfigurationTranslatedValue[];
20
+ clientSecretName?: EnergyAppPackageConfigurationTranslatedValue[];
21
+ redirectUrl?: string;
22
+ }
23
+ export interface HemsOneOauthAuthenticationParameters {
24
+ clientId?: string;
25
+ clientSecret?: string;
26
+ }
27
+ export interface HemsOneOauthAuthenticationRedirectUrlResponse {
28
+ redirectUrl: string;
29
+ }
30
+ export interface HemsOneAuthentication {
31
+ /** The authentication mode */
32
+ authenticationType: HemsOneAuthenticationType;
33
+ /** the api key configuration */
34
+ apiKey?: HemsOneApiKeyAuthentication;
35
+ /** the oauth configuration */
36
+ oauth?: HemsOneOauthAuthentication;
37
+ /** the username password configuration */
38
+ usernamePassword?: HemsOneUsernamePasswordAuthentication;
39
+ /** If the authentication is one time or not. If not a one time authentication, the user can sign out*/
40
+ oneTimeAuthentication: boolean;
41
+ /** Optional appliance ID. If provided, authentication is for specific appliance. If omitted, authentication is for the whole package */
42
+ applianceId?: string;
43
+ }
44
+ export interface HemsOneApiKeyAuthenticationResponse {
45
+ apiKey: string;
46
+ }
47
+ export interface HemsOneUsernamePasswordAuthenticationResponse {
48
+ username: string;
49
+ password: string;
50
+ }
51
+ export interface HemsOneOauthAuthenticationResponse {
52
+ code: string;
53
+ challenge: string;
54
+ }
55
+ export interface HemsOneAuthenticationResponse {
56
+ requestId: string;
57
+ authenticationType: HemsOneAuthenticationType;
58
+ apiKey?: HemsOneApiKeyAuthenticationResponse;
59
+ usernamePassword?: HemsOneUsernamePasswordAuthenticationResponse;
60
+ oauth?: HemsOneOauthAuthenticationResponse;
61
+ }
62
+ export declare enum HemsOneAuthenticationStateEnum {
63
+ Authenticated = "Authenticated",
64
+ AuthenticationFailed = "AuthenticationFailed",
65
+ Unauthenticated = "Unauthenticated"
66
+ }
67
+ export interface HemsOneAuthenticateState {
68
+ state: HemsOneAuthenticationStateEnum;
69
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ export interface HemsOneBatteryApplianceMetadata {
2
+ connectedToApplianceId?: string;
3
+ maxDischargePowerW?: number;
4
+ maxChargingPowerW?: number;
5
+ maxCapacityWh?: number;
6
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HemsOneChargeStatus = void 0;
4
+ /**
5
+ * Status of a charging session
6
+ */
7
+ var HemsOneChargeStatus;
8
+ (function (HemsOneChargeStatus) {
9
+ /** Charging session is active */
10
+ HemsOneChargeStatus["Charging"] = "Charging";
11
+ /** Charging session completed successfully */
12
+ HemsOneChargeStatus["Completed"] = "Completed";
13
+ /** Charging session ended due to fault */
14
+ HemsOneChargeStatus["Failed"] = "Failed";
15
+ })(HemsOneChargeStatus || (exports.HemsOneChargeStatus = HemsOneChargeStatus = {}));
@@ -0,0 +1,82 @@
1
+ /**
2
+ * Status of a charging session
3
+ */
4
+ export declare enum HemsOneChargeStatus {
5
+ /** Charging session is active */
6
+ Charging = "Charging",
7
+ /** Charging session completed successfully */
8
+ Completed = "Completed",
9
+ /** Charging session ended due to fault */
10
+ Failed = "Failed"
11
+ }
12
+ /**
13
+ * Meter values recorded during a charging session
14
+ */
15
+ export interface ChargeMeterValue {
16
+ /** Timestamp when the value was recorded */
17
+ timestamp: Date;
18
+ /** Energy value in Watt hours */
19
+ valueWh: number;
20
+ /** Price per kWh at the time of measurement */
21
+ pricePerKwh?: number;
22
+ /** Charging cost in Euro for this measurement */
23
+ chargingCostEuro?: number;
24
+ /** Current on phase 1 in Amperes */
25
+ currentPhase1: number;
26
+ /** Current on phase 2 in Amperes */
27
+ currentPhase2?: number;
28
+ /** Current on phase 3 in Amperes */
29
+ currentPhase3?: number;
30
+ }
31
+ /**
32
+ * Represents a charging session in the HEMS one system.
33
+ * Contains all relevant information about an EV charging transaction.
34
+ */
35
+ export interface HemsOneCharge {
36
+ /** Unique identifier for the charging session */
37
+ id: string;
38
+ /** Transaction ID for the charging session */
39
+ transactionId: string;
40
+ /** ID of the appliance (charger) handling this session */
41
+ applianceId: string;
42
+ /** ID of the charging card used for this session */
43
+ chargingCardId?: string;
44
+ /** Connector ID on the charge point */
45
+ connectorId?: number;
46
+ /** ID of the vehicle being charged */
47
+ vehicleId?: string;
48
+ /** Current status of the charging session */
49
+ status: HemsOneChargeStatus;
50
+ /** Meter reading at session start in Watt hours */
51
+ meterStartValueWh?: number;
52
+ /** Meter reading at session end in Watt hours */
53
+ meterEndValueWh?: number;
54
+ /** Paid price in Euro cents */
55
+ paidPriceEuroCent?: number;
56
+ /** Total energy delivered in kWh */
57
+ totalEnergyKwh?: number;
58
+ /** Timestamp when charging started */
59
+ startTime?: Date;
60
+ /** Timestamp when charging ended */
61
+ endTime?: Date;
62
+ /** Array of meter values recorded during the session */
63
+ meterValues?: ChargeMeterValue[];
64
+ /** Number of phases used for charging */
65
+ numberOfPhases: number;
66
+ }
67
+ export interface HemsOneChargeFilter {
68
+ /** Filter by specific appliance ID */
69
+ applianceId?: string;
70
+ /** Filter by specific charge point ID */
71
+ chargePointId?: string;
72
+ /** Filter sessions starting after this ISO timestamp */
73
+ startDate?: string;
74
+ /** Filter sessions ending before this ISO timestamp */
75
+ endDate?: string;
76
+ /** Filter by charging session status */
77
+ status?: HemsOneChargeStatus;
78
+ /** Filter by chargingCard */
79
+ chargingCardId?: string;
80
+ /** Filter by vehicle */
81
+ vehicleId?: string;
82
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HemsOneChargerApplianceAvailableFeaturesEnum = exports.HemsOneChargerApplianceAuthorizationModeEnum = exports.HemsOneChargerApplianceStatusEnum = void 0;
4
+ var HemsOneChargerApplianceStatusEnum;
5
+ (function (HemsOneChargerApplianceStatusEnum) {
6
+ HemsOneChargerApplianceStatusEnum["Available"] = "Available";
7
+ HemsOneChargerApplianceStatusEnum["Occupied"] = "Occupied";
8
+ HemsOneChargerApplianceStatusEnum["Suspended"] = "Suspended";
9
+ HemsOneChargerApplianceStatusEnum["Finishing"] = "Finishing";
10
+ HemsOneChargerApplianceStatusEnum["Reserved"] = "Reserved";
11
+ HemsOneChargerApplianceStatusEnum["Unavailable"] = "Unavailable";
12
+ HemsOneChargerApplianceStatusEnum["Faulted"] = "Faulted";
13
+ })(HemsOneChargerApplianceStatusEnum || (exports.HemsOneChargerApplianceStatusEnum = HemsOneChargerApplianceStatusEnum = {}));
14
+ var HemsOneChargerApplianceAuthorizationModeEnum;
15
+ (function (HemsOneChargerApplianceAuthorizationModeEnum) {
16
+ HemsOneChargerApplianceAuthorizationModeEnum["AuthorizationRequired"] = "AuthorizationRequired";
17
+ HemsOneChargerApplianceAuthorizationModeEnum["NoAuthorization"] = "NoAuthorization";
18
+ })(HemsOneChargerApplianceAuthorizationModeEnum || (exports.HemsOneChargerApplianceAuthorizationModeEnum = HemsOneChargerApplianceAuthorizationModeEnum = {}));
19
+ var HemsOneChargerApplianceAvailableFeaturesEnum;
20
+ (function (HemsOneChargerApplianceAvailableFeaturesEnum) {
21
+ /** If the charger can limit the power in Ampere or Watt*/
22
+ HemsOneChargerApplianceAvailableFeaturesEnum["PowerLimitation"] = "PowerLimitation";
23
+ /** If the charger is capable of smart charging to adjust the charging power in a pre-defined schedule */
24
+ HemsOneChargerApplianceAvailableFeaturesEnum["SmartChargingSchedule"] = "SmartChargingSchedule";
25
+ /** If the cable can be locked (only available for socket wallboxes */
26
+ HemsOneChargerApplianceAvailableFeaturesEnum["CableLocking"] = "CableLocking";
27
+ /** If the LED of the charger can be dimmed by the user */
28
+ HemsOneChargerApplianceAvailableFeaturesEnum["LedDimming"] = "LedDimming";
29
+ /** If the charger has a simple meter to collect the charged electricity consumption */
30
+ HemsOneChargerApplianceAvailableFeaturesEnum["SimpleMeter"] = "SimpleMeter";
31
+ /** If the charger has a mid certified meter to collect the charged electricity consumption */
32
+ HemsOneChargerApplianceAvailableFeaturesEnum["MidMeter"] = "MidMeter";
33
+ /** If the charger has an eichrecht certified meter to collect the charged electricity consumption */
34
+ HemsOneChargerApplianceAvailableFeaturesEnum["EichrechtMeter"] = "EichrechtMeter";
35
+ /** If the charger has a fixed cable attached */
36
+ HemsOneChargerApplianceAvailableFeaturesEnum["FixedCable"] = "FixedCable";
37
+ /** If the charger has a socket for charging cable */
38
+ HemsOneChargerApplianceAvailableFeaturesEnum["Socket"] = "Socket";
39
+ /** If the charger supports authorization via rfid reader*/
40
+ HemsOneChargerApplianceAvailableFeaturesEnum["RfidAuthorization"] = "RfidAuthorization";
41
+ })(HemsOneChargerApplianceAvailableFeaturesEnum || (exports.HemsOneChargerApplianceAvailableFeaturesEnum = HemsOneChargerApplianceAvailableFeaturesEnum = {}));
@@ -0,0 +1,49 @@
1
+ export declare enum HemsOneChargerApplianceStatusEnum {
2
+ Available = "Available",
3
+ Occupied = "Occupied",
4
+ Suspended = "Suspended",
5
+ Finishing = "Finishing",
6
+ Reserved = "Reserved",
7
+ Unavailable = "Unavailable",
8
+ Faulted = "Faulted"
9
+ }
10
+ export declare enum HemsOneChargerApplianceAuthorizationModeEnum {
11
+ AuthorizationRequired = "AuthorizationRequired",
12
+ NoAuthorization = "NoAuthorization"
13
+ }
14
+ export interface HemsOneChargerApplianceOcppMetadata {
15
+ chargePointId: string;
16
+ ocppVersion: '1.6' | '2.0.1';
17
+ }
18
+ export declare enum HemsOneChargerApplianceAvailableFeaturesEnum {
19
+ /** If the charger can limit the power in Ampere or Watt*/
20
+ PowerLimitation = "PowerLimitation",
21
+ /** If the charger is capable of smart charging to adjust the charging power in a pre-defined schedule */
22
+ SmartChargingSchedule = "SmartChargingSchedule",
23
+ /** If the cable can be locked (only available for socket wallboxes */
24
+ CableLocking = "CableLocking",
25
+ /** If the LED of the charger can be dimmed by the user */
26
+ LedDimming = "LedDimming",
27
+ /** If the charger has a simple meter to collect the charged electricity consumption */
28
+ SimpleMeter = "SimpleMeter",
29
+ /** If the charger has a mid certified meter to collect the charged electricity consumption */
30
+ MidMeter = "MidMeter",
31
+ /** If the charger has an eichrecht certified meter to collect the charged electricity consumption */
32
+ EichrechtMeter = "EichrechtMeter",
33
+ /** If the charger has a fixed cable attached */
34
+ FixedCable = "FixedCable",
35
+ /** If the charger has a socket for charging cable */
36
+ Socket = "Socket",
37
+ /** If the charger supports authorization via rfid reader*/
38
+ RfidAuthorization = "RfidAuthorization"
39
+ }
40
+ export interface HemsOneChargerApplianceMetadata {
41
+ availableFeatures: HemsOneChargerApplianceAvailableFeaturesEnum[];
42
+ status: HemsOneChargerApplianceStatusEnum;
43
+ /** ISO Timestamp of the last heartbeat */
44
+ lastHeartbeatAtIso?: string;
45
+ ocpp?: HemsOneChargerApplianceOcppMetadata;
46
+ authorizationMode: HemsOneChargerApplianceAuthorizationModeEnum;
47
+ /** If cableType is Socket, the cable can be locked for theft protection */
48
+ cableLocked?: boolean;
49
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Represents a charging card in the HEMS one system.
3
+ * Contains all relevant information about an electric vehicle charging card.
4
+ */
5
+ export interface HemsOneChargingCard {
6
+ /** Unique identifier for the charging card */
7
+ id: string;
8
+ name: string;
9
+ rfid?: string;
10
+ pendingRegistration?: boolean;
11
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HemsOneDataBusCommandTypeEnum = void 0;
4
+ var HemsOneDataBusCommandTypeEnum;
5
+ (function (HemsOneDataBusCommandTypeEnum) {
6
+ HemsOneDataBusCommandTypeEnum["PauseChargingV1"] = "PauseChargingV1";
7
+ HemsOneDataBusCommandTypeEnum["ResumeChargingV1"] = "ResumeChargingV1";
8
+ HemsOneDataBusCommandTypeEnum["ChangeChargingPowerV1"] = "ChangeChargingPowerV1";
9
+ })(HemsOneDataBusCommandTypeEnum || (exports.HemsOneDataBusCommandTypeEnum = HemsOneDataBusCommandTypeEnum = {}));