feat(sma_sunny_boy): implement energy.pv_inverter.1_phase

Author: kulti

solar_inverters/sma_sunny_boy_v3/manifest.yml

@@ -12,13 +12,14 @@ contributors:
 support:
   url: https://go.enapter.com/enapter-blueprint-support
   email: support@enapter.com
+implements: energy.pv_inverter.1_phase
 
 runtime:
   type: lua
   requirements:
     - lua_api_ver_3
     - modbus
-  opts:
+  options:
     dir: src
 
 configuration:
@@ -42,15 +43,19 @@ properties:
   model:
     display_name: Model
     type: string
-  serial_num:
+  vendor:
+    display_name: Vendor
+    type: string
+  serial_number:
     display_name: Serial Number
-    type: integer
-  fw_ver:
+    type: string
+  firmware_version:
     display_name: Firmware Version
     type: string
-  rated_power_va:
+  inverter_nameplate_capacity:
     display_name: Rated Power
     type: integer
+    unit: VA
   country_code:
     display_name: Country Code
     type: string
@@ -65,13 +70,40 @@ telemetry:
   status:
     display_name: Status
     type: string
+    description: Current operational status of the inverter
+    enum:
+      "off":
+        display_name: "Off"
+        description: Inverter is switched off
+      standby:
+        display_name: Standby
+        description: |
+          Inverter is in standby mode waiting for startup conditions.
+          Examples:
+          - AC grid voltage unavailable for grid-tied inverters
+          - DC voltage too low (night time for PV inverters)
+          - External control signal forcing standby
+      starting:
+        display_name: Starting
+        description: Inverter is going through startup procedure
+      operating:
+        display_name: Operating
+        description: Inverter is actively producing power
+      shutting_down:
+        display_name: Shutting Down
+        description: Inverter is going through shutdown procedure
+      fault:
+        display_name: Fault
+        description: Inverter has detected a fault and is not operating
+  health:
+    display_name: Health Status
+    type: string
     enum:
       - ok
       - warning
       - fault
-      - "off"
-  operation_status:
-    display_name: Operation Status
+  operating_status:
+    display_name: Operating Status
     type: string
     enum:
       - standby
@@ -81,12 +113,10 @@ telemetry:
       - shutdown
       - waiting_utilities
       - bolted
-      - standalone
       - derating
       - mpp
       - "off"
       - stop
-      - const_voltage
       - run
   recom_action:
     display_name: Recommended Action
@@ -122,10 +152,16 @@ telemetry:
     display_name: DC Power
     type: float
     unit: W
+    implements: energy.pv_inverter.1_phase.
+  ac_total_power:
+    display_name: AC Total Power
+    type: float
+    unit: W
   ac_power:
     display_name: AC Power
     type: float
     unit: W
+    implements: energy.pv_inverter.1_phase.ac_l1_power
   ac_frequency:
     display_name: AC Frequency
     type: float
@@ -134,6 +170,12 @@ telemetry:
     display_name: AC Voltage
     type: float
     unit: V
+    implements: energy.pv_inverter.1_phase.ac_l1_voltage
+  ac_current:
+    display_name: AC Current
+    type: float
+    unit: A
+    implements: energy.pv_inverter.1_phase.ac_l1_current
   ac_power_var:
     display_name: AC Reavtive Power
     type: float

solar_inverters/sma_sunny_boy_v3/src/main.lua

@@ -49,9 +49,10 @@ function send_properties()
 
   local properties = {}
   properties.model = parse_model(conn:read_u32_enum(30053))
-  properties.serial_num = conn:read_u32_fix0(30057)
-  properties.fw_ver = parse_firmware_version(conn:read_u32_fix0(30059))
-  properties.rated_power_va = conn:read_u32_fix0(40185)
+  properties.vendor = 'SMA'
+  properties.serial_number = tostring(conn:read_u32_fix0(30057))
+  properties.firmware_version = parse_firmware_version(conn:read_u32_fix0(30059))
+  properties.inverter_nameplate_capacity = conn:read_u32_fix0(40185)
   properties.country_code = parse_country_code(conn:read_u32_fix0(40109))
   if conn_cfg then
     properties.address = conn_cfg.address
@@ -72,14 +73,17 @@ function send_realtime_telemetry()
   end
 
   local started = os.clock()
+  local operating_status = parse_operating_status(conn:read_u32_enum(40029))
   local telemetry = {
     alerts = parse_alerts(conn:read_u32_enum(30213), conn:read_u32_enum(30247)),
-    status = parse_status(conn:read_u32_enum(30201)),
-    operation_status = parse_operation_status(conn:read_u32_enum(40029)),
+    health = parse_health_status(conn:read_u32_enum(30201)),
+    operating_status = operating_status,
+    status = convert_operating_status_to_status(operating_status),
 
     dc_voltage = conn:read_s32_fix2(30771),
     dc_power = conn:read_s32_fix0(30773),
     ac_power = conn:read_s32_fix0(30775),
+    ac_total_power = conn:read_s32_fix0(30777),
     ac_frequency = conn:read_u32_fix2(30803),
   }
   telemetry.read_time = math.ceil((os.clock() - started) * 1000) / 1000 -- round
@@ -273,15 +277,15 @@ function parse_model(value)
   end
 end
 
-function parse_status(value)
+function parse_health_status(value)
   if not value then
     return
   end
 
   if value == 35 then
     return 'fault'
   elseif value == 303 then
-    return 'off'
+    return nil
   elseif value == 307 then
     return 'ok'
   elseif value == 455 then
@@ -324,7 +328,7 @@ function parse_grid_relay_closed(value)
   end
 end
 
-function parse_operation_status(value)
+function parse_operating_status(value)
   if not value then
     return
   end
@@ -336,9 +340,9 @@ function parse_operation_status(value)
   elseif value == 1393 then
     return 'waiting_pv_voltage'
   elseif value == 1467 then
-    return 'start'
+    return 'starting'
   elseif value == 1469 then
-    return 'shutdown'
+    return 'shutting_down'
   elseif value == 1480 then
     return 'waiting_utilities'
   elseif value == 1795 then
@@ -356,13 +360,33 @@ function parse_operation_status(value)
   elseif value == 443 then
     return 'const_voltage'
   elseif value == 569 then
-    return 'run'
+    return 'operating'
   else
-    enapter.log('Cannot decode operation status: ' .. tostring(value), 'error')
+    enapter.log('Cannot decode operating status: ' .. tostring(value), 'error')
     return tostring(value)
   end
 end
 
+function convert_operating_status_to_status(value)
+  if not value then
+    return
+  end
+
+  if value == 'off' or value == 'stop' then
+    return 'off'
+  elseif value == 'standby' or value == 'waiting_pv_voltage' or value == 'waiting_utilities' or value == 'bolted' then
+    return 'standby'
+  elseif value == 'start' then
+    return 'starting'
+  elseif value == 'derating' or value == 'mpp' or value == 'run' then
+    return 'operating'
+  elseif value == 'shutdown' then
+    return 'shutting_down'
+  elseif value == 'fault' then
+    return 'fault'
+  end
+end
+
 function parse_alerts(presence, message)
   if not presence and not message then
     return