Modified Converter works but entities not showing up on Home Assistant.

[reefland]

Device: https://www.zigbee2mqtt.io/devices/IM6001-OTP05.html#smartthings-im6001-otp05

This device also supports power monitoring, not included in the default converter.

I made a converter like this:

$ cat IM6001-OTP05.js 

const fz = require('zigbee-herdsman-converters/converters/fromZigbee');
const tz = require('zigbee-herdsman-converters/converters/toZigbee');
const exposes = require('zigbee-herdsman-converters/lib/exposes');
const reporting = require('zigbee-herdsman-converters/lib/reporting');
const extend = require('zigbee-herdsman-converters/lib/extend');
const e = exposes.presets;
const ea = exposes.access;

const definition = {
    zigbeeModel: ['outlet'],
    model: 'IM6001-OTP05',
    vendor: 'SmartThings',
    description: 'Outlet',
    fromZigbee: [fz.on_off, fz.electrical_measurement],
    toZigbee: [tz.on_off],
    configure: async (device, coordinatorEndpoint, logger) => {
        const endpoint = device.getEndpoint(1);
        await reporting.bind(endpoint, coordinatorEndpoint, ['genOnOff', 'haElectricalMeasurement']);
        await reporting.onOff(endpoint);
        await reporting.readEletricalMeasurementMultiplierDivisors(endpoint);
        await reporting.activePower(endpoint);
        await reporting.rmsCurrent(endpoint);
        await reporting.rmsVoltage(endpoint);
    },
    exposes: [e.switch(), e.power(), e.current(), e.voltage()],
};

module.exports = definition;

The Z2M dashboard now shows the attributes and the state looks like:

State:
{
    "current": 0.75,
    "linkquality": 54,
    "power": 58.4,
    "state": "ON",
    "voltage": 121.6
}

Log looks like:

info  2021-12-28 11:45:13: Successfully configured '0x286d970001099504'
info  2021-12-28 11:45:13: MQTT publish: topic 'homeassistant/switch/0x286d970001099504/switch/config', payload '{"availability":[{"topic":"zigbee2mqtt
/bridge/state"}],"command_topic":"zigbee2mqtt/0x286d970001099504/set","device":{"configuration_url":"https://zigbee2mqtt.rich-durso.us/#/device/0x286d970001099504/info","identifie
rs":["zigbee2mqtt_0x286d970001099504"],"manufacturer":"SmartThings","model":"Outlet (IM6001-OTP05)","name":"0x286d970001099504","sw_version":""},"name":"0x286d970001099504","paylo
ad_off":"OFF","payload_on":"ON","state_topic":"zigbee2mqtt/0x286d970001099504","unique_id":"0x286d970001099504_switch_zigbee2mqtt","value_template":"{{ value_json.state }}"}'
2021-12-28.11-45-09/log.txt:info  2021-12-28 11:45:13: MQTT publish: topic 'homeassistant/sensor/0x286d970001099504/linkquality/config', payload '{"availability":[{"topic":"zigbee
2mqtt/bridge/state"}],"device":{"configuration_url":"https://zigbee2mqtt.rich-durso.us/#/device/0x286d970001099504/info","identifiers":["zigbee2mqtt_0x286d970001099504"],"manufact
urer":"SmartThings","model":"Outlet (IM6001-OTP05)","name":"0x286d970001099504","sw_version":""},"enabled_by_default":false,"entity_category":"diagnostic","icon":"mdi:signal","nam
e":"0x286d970001099504 linkquality","state_class":"measurement","state_topic":"zigbee2mqtt/0x286d970001099504","unique_id":"0x286d970001099504_linkquality_zigbee2mqtt","unit_of_me
asurement":"lqi","value_template":"{{ value_json.linkquality }}"}'
info  2021-12-28 11:45:13: MQTT publish: topic 'zigbee2mqtt/0x286d970001099504', payload #'{"linkquality":42,"power":570,"state":"ON","voltage":121.6}'
info  2021-12-28 11:45:14: MQTT publish: topic 'zigbee2mqtt/0x286d970001099504', payload '{"current":0.74,"linkquality":42,"power":570,"state":"ON","vo
ltage":121.6}'
info  2021-12-28 11:45:17: MQTT publish: topic 'zigbee2mqtt/0x286d970001099504', payload '{"current":0.74,"linkquality":45,"power":58,"state":"ON","vol
tage":121.6}'
info  2021-12-28 11:45:19: MQTT publish: topic 'zigbee2mqtt/0x286d970001099504', payload '{"current":0.74,"linkquality":54,"power":58,"state":"ON","vol
tage":121.6}'

Now in Home Assistant, I don't see these additional attributes.

HA > MQTT > Device: 0x286d970001099504

• Control was Created for ON/OFF
• No sensors created for device class power or energy

HA > MQTT > Device: 0x286d970001099504 > MQTT Info > Subscribed Topics > zigbee2mqtt/0x286d970001099504

Received Messages:

Received 12:03:49 PM

    QoS: 0
    Payload:

    current: 0.75
    linkquality: 45
    power: 58.4
    state: 'ON'
    voltage: 120.9

Received 12:03:53 PM

    QoS: 0
    Payload:

    current: 0.75
    linkquality: 48
    power: 58
    state: 'ON'
    voltage: 120.9

Is it expected that the Z2M HA integration (using MQTT discovery), would create the sensors for the power & energy ??

[reefland]

I guess to refine my question, how are external converters handled in regards to Z2M HA Integration? what determines which sensors are created? How do I indicate the sensors for power, current, and voltage should be created and define which are enabled by default?

For now I've created manual MQTT template entity to read the newly exposed power attribute. But this doesn't seem like the right way to handle this.

[Koenkk]

Your config looks good to me, the discovery is based on the exposes, could you provide the debug log when starting z2m?

See https://www.zigbee2mqtt.io/guide/usage/debug.html on how to enable debug logging.

Also updated the default converter to support power measurements.

[reefland]

Thank you for confirming the expose, that was my educated guess. See attached console log with debug. This is startup only for a few seconds and then stopped it.

console.zip

[Koenkk]

Your converter is not loaded:

�[32mZigbee2MQTT:info �[39m 2021-12-29 14:29:04: Power Outlet 01 (0x286d970001099504): IM6001-OTP05 - SmartThings Zigbee smart plug with power meter (Router)

The description should be Outlet (as defined in your external converter), make sure to add the external converter to the configuration.yaml as explained on https://www.zigbee2mqtt.io/advanced/support-new-devices/01_support_new_devices.html#_2-adding-your-device

[reefland]

I did tweak the converter a bit since the original post, I assumed the Description could be tweaked to be more accurate. It currently looks like:

$ cat IM6001-OTP05.js 
const fz = require('zigbee-herdsman-converters/converters/fromZigbee');
const tz = require('zigbee-herdsman-converters/converters/toZigbee');
const exposes = require('zigbee-herdsman-converters/lib/exposes');
const reporting = require('zigbee-herdsman-converters/lib/reporting');
const extend = require('zigbee-herdsman-converters/lib/extend');
const e = exposes.presets;
const ea = exposes.access;

const definition = {
    zigbeeModel: ['outlet'],
    model: 'IM6001-OTP05',
    vendor: 'SmartThings',
    description: 'Zigbee smart plug with power meter',
    fromZigbee: [fz.on_off, fz.electrical_measurement],
    toZigbee: [tz.on_off],
    configure: async (device, coordinatorEndpoint, logger) => {
        const endpoint = device.getEndpoint(1);
        await reporting.bind(endpoint, coordinatorEndpoint, ['genOnOff', 'haElectricalMeasurement']);
        await reporting.onOff(endpoint);
        await reporting.readEletricalMeasurementMultiplierDivisors(endpoint);
        await reporting.activePower(endpoint);
        await reporting.rmsCurrent(endpoint);
        await reporting.rmsVoltage(endpoint, {change: 10});
    },
    exposes: [e.switch(), e.power(), e.current(), e.voltage()],
};

module.exports = definition;

And I have the following in configuration.yaml:

external_converters:
  - IM6001-OTP05.js

[Koenkk]

I see now, it could be that f9aa525 fixed this already, could you check on the latest dev branch? (https://www.zigbee2mqtt.io/advanced/more/switch-to-dev-branch.html)

[reefland]

BTW - The updated description does shows up in Home Assistant > MQTT > Device > Device Info screen as Zigbee smart plug with power meter (IM6001-OTP05) by SmartThings but no sensor was created.

[reefland]

Now running 1.22.1-dev commit: bf72347 and the sensor was created and active and the other attributes created but not enabled. I have 2 more of these devices that Z2M has never seen, I'll pair them in and report back.

[reefland]

I was able to pair the other 2 and all three are operating flawless. At least I was able to help confirm this issue is fixed. Thank you for taking the time to help. I'll work on submitting a PR to update the device converter file.

[reefland]

@Koenkk - Just noticed you already updated the converter file... thanks.