Add new Zigbee Power Meter Device

[script0803]

Check all that apply

Type of Change

• [x] WWST Certification Request
  • If this is your first time contributing code:
    • [x] I have reviewed the README.md file
    • [x] I have reviewed the CODE_OF_CONDUCT.md file
    • [x] I have signed the CLA
  • [x] I plan on entering a WWST Certification Request or have entered a request through the WWST Certification console at developer.smartthings.com
• [ ] Bug fix
• [ ] New feature
• [ ] Refactor

Checklist

• [ ] I have performed a self-review of my code
• [ ] I have commented my code in hard-to-understand areas
• [ ] I have verified my changes by testing with a device or have communicated a plan for testing
• [ ] I am adding new behavior, such as adding a sub-driver, and have added and run new unit tests to cover the new behavior

Description of Change

Add new Zigbee Power Meter Device.

Based on the existing driver, support for single-phase, two-phase, and three-phase energy meters has been added.

Added Capability: voltageMeasurement Cluster: 0x0B04 Attributes: 0x0505, 0x0905, 0x0A05 Added Capability: currentMeasurement Cluster: 0x0B04 Attributes: 0x0508, 0x0908, 0x0A08 Added Capability: powerMeter (extended for two-phase and three-phase applications) Cluster: 0x0B04 Attributes: 0x050B, 0x090B, 0x0A0B Added Capability: energyMeter (using component marked as producedEnergy) Cluster: 0x0702 Attribute: 0x0001 Additionally, all types of Power Meters now support the capability: powerConsumptionReport, in preparation for integration with SmartThings Energy.

These changes have been communicated in advance to [email protected]. After the merge request, the WWST Certification process will be initiated.

Summary of Completed Tests

[script0803]

up

[github-actions[bot]]

Duplicate profile check: Passed - no duplicate profiles detected.

[github-actions[bot]]

Channel deleted.

[github-actions[bot]]

Test Results

   71 files    480 suites   0s ⏱️ 2 482 tests 2 482 ✅ 0 💤 0 ❌ 4 263 runs  4 263 ✅ 0 💤 0 ❌

Results for commit 2ec2d28f.

:recycle: This comment has been updated with latest results.

[github-actions[bot]]

File	Coverage
All files	96%	:white_check_mark:
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-power-meter/src/init.lua	97%	:white_check_mark:
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-power-meter/src/configurations.lua	95%	:white_check_mark:
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-power-meter/src/lazy_load_subdriver.lua	57%	:x:
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-power-meter/src/shinasystems/init.lua	95%	:white_check_mark:
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-power-meter/src/bituo/init.lua	95%	:white_check_mark:
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-power-meter/src/frient/can_handle.lua	83%	:x:

Minimum allowed coverage is 90%

Generated by :monkey: cobertura-action against 2ec2d28f2ed1264be5bf54e6cf319ed91a4a989d

[greens]

Checking drivers/SmartThings/zigbee-power-meter/src/bituo/init.lua 1 warning

    drivers/SmartThings/zigbee-power-meter/src/bituo/init.lua:260:1: (W611) line contains only whitespace

[greens]

Also, please add some unit tests.

[script0803]

Also, please add some unit tests.

Hi, I've written some test uints. Could you please tell me how I can run these test uints locally before pull request to ensure they are working?

[greens]

@script0803 I'd first follow this guide: https://developer.smartthings.com/docs/devices/hub-connected/set-up-dev-env using the artifact containing the lua libraries here: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/releases/tag/apiv15_58

Then navigate to your driver's src directory and simply run lua test/[name_of_your_test_file].lua

[script0803]

@script0803 I'd first follow this guide: https://developer.smartthings.com/docs/devices/hub-connected/set-up-dev-env using the artifact containing the lua libraries here: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/releases/tag/apiv15_58

Then navigate to your driver's src directory and simply run lua test/[name_of_your_test_file].lua

Hi, when testing the do_config part, the test uint receives some strange messages. I haven't used the frequency attribute in my driver, but it receives an unexpected report of frequency divisor. Additionally, there are similar attributes like ACPower Multiplier and Divisor, and their min interval, max interval, and report changeable are very strange. These messages are all identified as unexpected messages, which causes my device to fail the test. How can I solve this problem?

ZigbeeMessageTx:
        Uint16: 0x0000
        AddressHeader:
            src_addr: 0x0000
            src_endpoint: 0x01
            dest_addr: 0x0001
            dest_endpoint: 0x01
            profile: 0x0104
            cluster: SimpleMetering
        ZCLMessageBody:
            ZCLHeader:
                frame_ctrl: 0x00
                seqno: 0x00
                ZCLCommandId: 0x06
            ConfigureReporting:
                AttributeReportingConfiguration:
                    direction: 0x00
                    attr_id: 0x0400
                    DataType: Int24
                    minimum_reporting_interval: 0x0005
                    maximum_reporting_interval: 0x0E10
                    reportable_change: 5

FAILED

test code

test.register_coroutine_test(
  "Device configure lifecycle event should configure device properly",
  function()
    test.socket.zigbee:__set_channel_ordering("relaxed")
    test.socket.device_lifecycle:__queue_receive({ mock_device.id, "doConfigure" })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      zigbee_test_utils.build_bind_request(mock_device, zigbee_test_utils.mock_hub_eui, SimpleMetering.ID)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      zigbee_test_utils.build_bind_request(mock_device, zigbee_test_utils.mock_hub_eui, ElectricalMeasurement.ID)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      SimpleMetering.attributes.CurrentSummationDelivered:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ActivePower:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.RMSVoltage:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.RMSCurrent:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      cluster_base.configure_reporting(mock_device, data_types.ClusterId(SimpleMetering.ID), data_types.AttributeId(0x0001), data_types.ZigbeeDataType(SimpleMetering.attributes.CurrentSummationDelivered.base_type.ID), 30, 120, 0)
    })
    mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
  end
)

[script0803]

@script0803 I'd first follow this guide: https://developer.smartthings.com/docs/devices/hub-connected/set-up-dev-env using the artifact containing the lua libraries here: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/releases/tag/apiv15_58

Then navigate to your driver's src directory and simply run lua test/[name_of_your_test_file].lua

After trying, it was only by listing all of them that the do config test could be passed. However, there are many attributes in the list that have not been used by my devices.

test.register_coroutine_test(
  "Device configure lifecycle event should configure device properly",
  function()
    test.socket.zigbee:__set_channel_ordering("relaxed")
    test.socket.device_lifecycle:__queue_receive({ mock_device.id, "doConfigure" })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      zigbee_test_utils.build_bind_request(mock_device, zigbee_test_utils.mock_hub_eui, SimpleMetering.ID)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      zigbee_test_utils.build_bind_request(mock_device, zigbee_test_utils.mock_hub_eui, ElectricalMeasurement.ID)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      SimpleMetering.attributes.CurrentSummationDelivered:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ActivePower:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.RMSVoltage:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.RMSCurrent:configure_reporting(mock_device, 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      cluster_base.configure_reporting(mock_device, data_types.ClusterId(SimpleMetering.ID), data_types.AttributeId(0x0001), data_types.ZigbeeDataType(SimpleMetering.attributes.CurrentSummationDelivered.base_type.ID), 30, 120, 0)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ACPowerDivisor:configure_reporting(mock_device, 1, 43200, 1)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      SimpleMetering.attributes.InstantaneousDemand:configure_reporting(mock_device, 5, 3600, 5)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ACPowerMultiplier:configure_reporting(mock_device, 1, 43200, 1)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      SimpleMetering.attributes.InstantaneousDemand:read(mock_device)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      cluster_base.read_attribute(mock_device, data_types.ClusterId(SimpleMetering.ID), data_types.AttributeId(0x0001))
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      SimpleMetering.attributes.CurrentSummationDelivered:read(mock_device)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ActivePower:read(mock_device)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.RMSVoltage:read(mock_device)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.RMSCurrent:read(mock_device)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ACPowerMultiplier:read(mock_device)
    })
    test.socket.zigbee:__expect_send({
      mock_device.id,
      ElectricalMeasurement.attributes.ACPowerDivisor:read(mock_device)
    })
    mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
  end

[greens]

@script0803 can you include your test in the PR here so I can take a look?

[script0803]

@script0803 can you include your test in the PR here so I can take a look?

Of course, thank you very much for your help!

[greens]

Your configuration test failures are because your fork needs to be rebased. There have been upstream changes in the main repo that are not included in your fork.

[greens]

@script0803 Please rebase your pull request to remove the merge conflicts.