Skip to content

Collection of device converters to be used with zigbee-herdsman

License

Notifications You must be signed in to change notification settings

dzikus/zigbee-herdsman-converters

 
 

Repository files navigation

NPM

zigbee-herdsman-converters

Collection of device converters to be used with zigbee-herdsman.

Breaking changes

20.0.0

  • A toZigbee converter is now allowed to not define any key, in this case the converter should be used for any key.

    19.0.0

  • Legacy extend was removed

    18.0.0

  • After converting a message with a fromZigbee converter, postProcessConvertedFromZigbeeMessage should be called now (for applying calibration/precision)

    17.0.0

  • Various methods in index.ts are now async and return a Promise

    15.0.0

  • OTA isUpdateAvailable now returns an object instead of a boolean (e.g. {available: true, currentFileVersion: 120, otaFileVersion: 125})

  • OTA updateToLatest now returns a number (fileVersion of the new OTA) instead of a void

Contributing

See Zigbee2MQTT how to support new devices.

Submitting a pull request

If you'd like to submit a pull request, you should run the following commands to ensure your changes will pass the tests:

npm install -g pnpm
pnpm install --frozen-lockfile
pnpm run eslint --fix
pnpm run pretty:write
pnpm run build
pnpm test

If any of those commands finish with an error your PR won't pass the tests and will likely be rejected.

About

Collection of device converters to be used with zigbee-herdsman

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.7%
  • JavaScript 1.2%
  • Python 0.1%