JSPM

zigbee-herdsman-converters

20.39.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 27969
  • Score
    100M100P100Q172973F
  • License MIT

Collection of device converters to be used with zigbee-herdsman

Package Exports

  • zigbee-herdsman-converters
  • zigbee-herdsman-converters/index.js
  • zigbee-herdsman-converters/lib/exposes
  • zigbee-herdsman-converters/lib/exposes.js
  • zigbee-herdsman-converters/lib/ota/tradfri
  • zigbee-herdsman-converters/lib/ota/tradfri.js
  • zigbee-herdsman-converters/lib/ota/zigbeeOTA
  • zigbee-herdsman-converters/lib/ota/zigbeeOTA.js
  • zigbee-herdsman-converters/lib/philips
  • zigbee-herdsman-converters/lib/philips.js
  • zigbee-herdsman-converters/lib/utils
  • zigbee-herdsman-converters/lib/utils.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (zigbee-herdsman-converters) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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.