Skip to main content

Discovery

The energy devices can be automatically discovered on your network, the method used for this is Multicast DNS (also called mDNS, Zeroconf or Bonjour). Your application can use this technology to discover the device(s) without the user having to enter the IP address.

Example scan​

The device can be found on the _hwenergy._tcp domain.

   $ dns-sd -B _hwenergy._tcp .
   Browsing for _hwenergy._tcp
   DATE: ---Wed 13 Oct 2021---
   14:51:03.565  ...STARTING...
   Timestamp     A/R  Flags  if Domain  Service Type     Instance Name
   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energysocket-AABBCC
   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energysocket-DDEEFF
   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  energysocket-001122
   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  p1meter-334455
   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  kwhmeter-667788
   14:51:03.566  Add      3   7 local.  _hwenergy._tcp.  watermeter-ABCDEF

The hostname is formatted as <product-name>-<last 6 characters of serial>, so devices with serial AABBCCDDEEFF the hostname is as following:

DeviceExample hostname
P1 meterp1meter-DDEEFF
Energy Socketenergysocket-DDEEFF
Watermeterwatermeter-DDEEFF
kWh meter (single phase)kwhmeter-DDEEFF
kWh meter (three phase)kwhmeter-DDEEFF

TXT records​

A discovery response contains some extra data that can be used to improve the setup in your application.

DataDescription
api_enabled'0' or '1', reflects if the API is enabled (1 means enabled)
pathFixed to '/api/v1'. Can be used to validate that your application supports this device and API version
serialSerial, also the MAC address. Consists of 12 hexadecimal values
product_nameA fixed, user-friendly name. This name is not the same that is set by the user in the app.
product_typeThe product type, see Supported devices. Make sure your application can handle other values for future products