ZiGate implementation #242

G1K · 2020-10-21T20:17:43Z

Discussion of the implementation of a new adapter based on the NXP chip JN516x ( JN5168 / JN5169 )
#241

What you can try as a coordinator

Xiaomi gateway DGNWG05LM, ZHWG11LM
End devices from xiaomi JN5169 https://github.com/Jerome-PS/JN516xSniffer
- Xiaomi Door sensor
- Xiaomi smart button
- Xiaomi smart button UART1 ZiGate coordinators
Ready modules https://www.seeedstudio.com/Mesh-Bee-Open-Source-Zigbee-Pro-Module-with-MCU-JN516-p-1751.html
DIY module + TTL adapter
E75-2G4M10S Zigbee JN5169 aliexpress.com/item/32973411720.html

Road map

Stability, queuing APDU, waiting for data and using SQN
deduplication of all incoming messages by sqn duplicate data indication 0x8002 fairecasoimeme/ZiGate#346 or use build custom firmware or alternate firmware
implementation sendZclFrameToGroup
supported GP - (requires stable firmware with GreenPower support and 242 endpoint ) What is being assembled now limits the resources of the APDU or does not start after the firmware
OTA check, not sure if it will work
more correct error handling and re-sending with route finding
* Backup and restore ( mvp )

If you have the opportunity, please join the development and testing. I don't have much development experience especially with uart and ZiGate

Perhaps this will solve the requests
Koenkk/zigbee2mqtt#743
Koenkk/zigbee2mqtt#409

Hedda · 2020-11-03T13:46:15Z

Does #241 and Koenkk/zigbee2mqtt#4737 being merged mean that zigbee-herdsman and zigbee2mqtt now works with all modules with ZiGate firmware including original ones from https://zigate.fr by the @fairecasoimeme project from Frédéric Dubois?

Do not own a ZiGate or other NXP Zigbee coordinator myself but know it is supported by ZHA for Home Assistant via zigpy-zigate

Known working Zigbee radio modules

ZiGate USB-TTL
ZiGate USB-DIN
PiZiGate (ZiGate module for Raspberry Pi GPIO)
ZiGate Pack WiFi (ZiGate USB-TTL with ESP8266 serial TCP server)

Gamester17 · 2020-11-03T15:05:13Z

Perhaps this will solve the requests
Koenkk/zigbee2mqtt#743
Koenkk/zigbee2mqtt#409

Also related to #150

Koenkk · 2020-11-03T17:09:43Z

These changes are all available in Zigbee2MQTT 1.16.0 but it's unclear for me how stable it is.

Update supported adapters with ZiGate USB-TTL. Experimental as per Koenkk/zigbee-herdsman#242

* Update supported adapters with ZiGate USB-TTL Update supported adapters with ZiGate USB-TTL. Experimental as per Koenkk/zigbee-herdsman#242 * Update supported adapters with ZiGate USB-TTL * Mention ZiGate USB-TTL hardware specification Mention ZiGate USB-TTL hardware specification * Update supported_adapters.md Co-authored-by: Koen Kanters <koenkanters94@gmail.com>

Hedda · 2020-11-30T15:53:09Z

FYI, Koenkk/zigbee2mqtt.io#474 has updated Zigbee2MQTT website documentation to list ZiGate USB-TTL as a supported adapter:

https://www.zigbee2mqtt.io/information/supported_adapters.html

PS: Other ZiGate adapters not yet listed there, include ZiGate USB-DIN, PiZiGate, and ZiGate WiFi Pack -> https://zigate.fr/boutique/

Thanks and headsup to @fairecasoimeme @G1K @kirovilya @devbis @lenz

jonathan-gatard · 2020-12-14T15:39:30Z

Hi everybody,

I'm trying to add my PiZiGate to Zigbee2MQTT, but i have errors:

Zigbee2MQTT:info  2020-12-14 16:38:29: Logging to console and directory: '/app/data/log/2020-12-14.16-38-28' filename: log.txt
Zigbee2MQTT:info  2020-12-14 16:38:29: Starting Zigbee2MQTT version 1.16.2-dev (commit #2468d61)
Zigbee2MQTT:info  2020-12-14 16:38:29: Starting zigbee-herdsman (0.13.41)
Zigbee2MQTT:error 2020-12-14 16:38:39: Error while starting zigbee-herdsman
Zigbee2MQTT:error 2020-12-14 16:38:39: Failed to start zigbee
Zigbee2MQTT:error 2020-12-14 16:38:39: Exiting...
Zigbee2MQTT:error 2020-12-14 16:38:39: Error: failed to connect to zigate adapter [object Object] after 10000ms
    at ZiGateAdapter.<anonymous> (/app/node_modules/zigbee-herdsman/dist/adapter/zigate/adapter/zigateAdapter.js:125:23)
    at Generator.throw (<anonymous>)
    at rejected (/app/node_modules/zigbee-herdsman/dist/adapter/zigate/adapter/zigateAdapter.js:25:65)
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! zigbee2mqtt@1.16.2-dev start: `node index.js`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the zigbee2mqtt@1.16.2-dev start script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     /root/.npm/_logs/2020-12-14T15_38_39_702Z-debug.log
Using '/app/data' as data directory

> zigbee2mqtt@1.16.2-dev start /app
> node index.js

This is my configuration.yaml:

# Home Assistant integration (MQTT discovery)
homeassistant: true

# allow new devices to join
permit_join: true

# MQTT settings
mqtt:
  # MQTT base topic for zigbee2mqtt MQTT messages
  base_topic: zigbee2mqtt
  # MQTT server URL
  server: 'mqtt://127.0.0.1:1883'
  # MQTT server authentication, uncomment if required:
  user: Jonathan
  password: xxxxxxxxxxxxx

# Serial settings
serial:
  # Location of CC2531 USB sniffer
  port: /dev/ttyS0
  adapter: zigate

I use docker-compose:

    zigbee2mqtt:
        image: koenkk/zigbee2mqtt:latest-dev
        container_name: zigbee2mqtt
        hostname: "neptune_zigbee2mqtt"
        restart: unless-stopped
        network_mode: host
        privileged: true
        environment:
          - TZ=Europe/Paris
        volumes:
          - zigbee2mqtt_data:/app/data
        devices:
          - /dev/ttyS0:/dev/ttyS0

/dev/ttyS0 is working, i used it before with ZHA in HA.
My PiZiGate firmware is 3.1d
Any ideas ?

Thanks !

devbis · 2020-12-14T17:53:38Z

Hey @Kalypox

Does the baudrate for your zigate adapter is equal to the one in herdsman? You should try to set the baudrate in the config file.

The second approach is to upgrade the firmware. It heavily relies on the raw Zigbee mode that is under development since 3.1c.
Maybe updating to the latest firmware can solve your problem.

jonathan-gatard · 2020-12-14T18:43:17Z

Hi @devbis,
Thanks you a lot !!!
It works, i've added:

advanced:
  baudrate: 115200

Have a nice day !

Hedda · 2020-12-14T19:27:43Z

Note! ZiGate 3.1d firmware or later is recommended for all ZiGate hardware is it contains an important bug-fix

https://zigate.fr/tag/firmware/

https://zigate.fr/2020/10/12/maj-firmware-zigate-version-3-1d/

Also updated docs recommend upgrading to ZiGate Zigbee coordinator firmware version 3.1d or later:

https://www.zigbee2mqtt.io/information/supported_adapters.html

G1K · 2021-01-13T13:21:28Z

Added Roadmap to start post

Described current problems in #252 (comment) related to #285

G1K · 2021-01-28T20:42:57Z

Most of the points from the roadmap are closed, but there is a problem with the stability of the module firmware when using raw mode in both directions. Perhaps they will be resolved, but for now I recommend trying to work with the firmware from this repository.
https://github.com/openlumi/JN-ZigbeeNodeControlBridge-firmware/releases/latest
The firmware is collected on Github Actions binaries are in artifacts

And it supports advanced logging, which can help in finalizing the adapter

G1K · 2021-01-28T20:48:36Z

I do not have devices to check OTA, but in the sniffer, I see the correct communication that there is no update for the device. If anyone tests please write here.

github-actions · 2021-02-28T00:26:55Z

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days

G1K · 2021-03-02T07:32:14Z

The latest improvements from the end of January are available in the 1.18 release

github-actions · 2021-04-03T00:10:19Z

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days

Hedda · 2022-01-18T10:48:03Z

@Koenkk Maybe re-open this issue for tracking and leave open even if no activity as ZiGate support is still listed as experimental?

https://www.zigbee2mqtt.io/guide/adapters/#experimental

Hedda · 2022-01-26T14:26:31Z

hmm, why does github-actions bot close this?

github-actions · 2022-02-26T00:45:17Z

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days

Hedda · 2022-02-28T10:23:27Z

Maybe permanently remove the stale label somehow?

G1K · 2022-03-02T10:12:40Z

Most likely, you need to add the closing issue exempt-issue-labels to the action settings, specify a list of labels in it that do not need to be marked as obsolete. and for issue to use such a label

https://github.com/actions/stale#exempt-issue-labels

zigbee-herdsman/.github/workflows/stale.yml

Lines 11 to 18 in ff26225

    
           - uses: actions/stale@v3 
        
             with: 
        
               repo-token: ${{ secrets.GITHUB_TOKEN }} 
        
               stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days' 
        
               stale-pr-message: 'This pull request is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days' 
        
               days-before-stale: 30 
        
               days-before-close: 7 
        
               operations-per-run: 500

Hedda · 2022-03-09T09:20:31Z

@Koenkk Maybe add dont-stale label to this issue as well as it should probably also be keep open for the same reason as EZSP?

https://github.com/Koenkk/zigbee-herdsman/issues?q=is%3Aissue+is%3Aopen+label%3Adont-stale

pipiche38 · 2023-02-06T15:04:19Z

Most of the points from the roadmap are closed, but there is a problem with the stability of the module firmware when using raw mode in both directions. Perhaps they will be resolved, but for now I recommend trying to work with the firmware from this repository. https://github.com/openlumi/JN-ZigbeeNodeControlBridge-firmware/releases/latest The firmware is collected on Github Actions binaries are in artifacts

And it supports advanced logging, which can help in finalizing the adapter

Could you clarify which firmware should be use on a ZiGate V1 to act as a coordinator

G1K · 2023-02-18T16:27:31Z

@pipiche38
Any depending on your type of chip and Baudrate for Zigate sticks most likely should be 5168 and 115200. Just do not take the versions with GP. The firmware JN chips looks at magic bats at the beginning of the firmware and should not let the firmware of 5169 be flashed in 5168 and vice versa.
We use firmware on Xiaomi Gateway, there is a chip 5169 as in Xiaomi end devices

But Zigate V1 firmware has seemed to be corrected and work as it should. The only problem that strongly interferes is the absence of PDM backup and periodically the chip reports that after rebooting it is Factory reseted

In the firmware
https://github.com/openlumi/JN-ZigbeeNodeControlBridge-firmware/releases/latest
Alx2000y/zigbee-herdsman@068bbe7...fd707e4

Realized raw PDM backup memory of NXP JN516x zigbee chip and recovery. Those who wish can try.

pipiche38 · 2023-02-18T17:37:11Z

I'll put it on my todo list, this looks promising and could be a good alternative to the zigate firmware

Hedda · 2023-02-21T11:54:37Z

Road map

...

* Backup and restore ( mvp )

Does anyone have any more updates or news on the backup and restore features for the zigate adapter in zigbee-herdsman?

PS: This question is directly related to this discussion about Z2M migration across Zigbee stacks -> Koenkk/zigbee2mqtt#16478

Hedda mentioned this issue Nov 3, 2020

[REQUEST] Support for Xiaomi Lumi Gateway MIxx01 Zigbee to WiFi bridge with ZiGate and OpenLumi firmware zigpy/zigpy-zigate#59

Closed

Hedda added a commit to Hedda/zigbee2mqtt.io that referenced this issue Nov 30, 2020

Update supported adapters with ZiGate USB-TTL

efa4fef

Update supported adapters with ZiGate USB-TTL. Experimental as per Koenkk/zigbee-herdsman#242

Hedda mentioned this issue Nov 30, 2020

Update supported adapters with ZiGate USB-TTL Koenkk/zigbee2mqtt.io#474

Merged

Hedda mentioned this issue Dec 17, 2020

[REQUEST] Support for Silicon Labs EFR32 (Mighty Gecko family) based Zigbee radio adapters using EZSP serial protocols? #168

Closed

This was referenced Jan 12, 2021

[zigate-adapter #242 ] fix removeDevice #288

Merged

[zigate-adapter] parsing new messages #290

Merged

G1K mentioned this issue Jan 13, 2021

add compatible coordinators blakadder/zigbee#176

Merged

G1K mentioned this issue Jan 28, 2021

[zigate-adapter] Improved stability and functionality #301

Merged

github-actions bot added the stale label Feb 28, 2021

Hedda mentioned this issue Mar 2, 2021

[WIP]: EFR32 EmberZNet EZSP adapter #317

Merged

11 tasks

github-actions bot removed the stale label Mar 3, 2021

Hedda mentioned this issue Mar 5, 2021

Add Silicon Labs EZSP as experimental to supported adapters list Koenkk/zigbee2mqtt.io#655

Merged

github-actions bot added the stale label Apr 3, 2021

github-actions bot closed this as completed Apr 10, 2021

Koenkk reopened this Jan 18, 2022

github-actions bot closed this as completed Jan 26, 2022

Koenkk reopened this Jan 26, 2022

Koenkk removed the stale label Jan 26, 2022

github-actions bot added the stale label Feb 26, 2022

Koenkk removed the stale label Feb 28, 2022

Koenkk added the dont-stale label Mar 10, 2022

Hedda mentioned this issue Feb 23, 2023

Supporting more network and node information in v2 spec zigpy/open-coordinator-backup#9

Closed

Hedda mentioned this issue Mar 8, 2024

New ember adapter implementation targeting EZSP 13 and above #918

Merged

Hedda mentioned this issue May 31, 2024

State of ZiGate support #1037

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ZiGate implementation #242

ZiGate implementation #242

G1K commented Oct 21, 2020 •

edited

Loading

Hedda commented Nov 3, 2020 •

edited

Loading

Gamester17 commented Nov 3, 2020

Koenkk commented Nov 3, 2020 •

edited

Loading

Hedda commented Nov 30, 2020 •

edited

Loading

jonathan-gatard commented Dec 14, 2020 •

edited

Loading

devbis commented Dec 14, 2020 •

edited

Loading

jonathan-gatard commented Dec 14, 2020 •

edited

Loading

Hedda commented Dec 14, 2020 •

edited

Loading

G1K commented Jan 13, 2021

G1K commented Jan 28, 2021 •

edited

Loading

G1K commented Jan 28, 2021 •

edited

Loading

github-actions bot commented Feb 28, 2021

G1K commented Mar 2, 2021

github-actions bot commented Apr 3, 2021

Hedda commented Jan 18, 2022 •

edited

Loading

Hedda commented Jan 26, 2022

github-actions bot commented Feb 26, 2022

Hedda commented Feb 28, 2022

G1K commented Mar 2, 2022

Hedda commented Mar 9, 2022

pipiche38 commented Feb 6, 2023

G1K commented Feb 18, 2023

pipiche38 commented Feb 18, 2023

Hedda commented Feb 21, 2023 •

edited

Loading

Road map

ZiGate implementation #242

ZiGate implementation #242

Comments

G1K commented Oct 21, 2020 • edited Loading

Road map

Hedda commented Nov 3, 2020 • edited Loading

Known working Zigbee radio modules

Gamester17 commented Nov 3, 2020

Koenkk commented Nov 3, 2020 • edited Loading

Hedda commented Nov 30, 2020 • edited Loading

jonathan-gatard commented Dec 14, 2020 • edited Loading

devbis commented Dec 14, 2020 • edited Loading

jonathan-gatard commented Dec 14, 2020 • edited Loading

Hedda commented Dec 14, 2020 • edited Loading

G1K commented Jan 13, 2021

G1K commented Jan 28, 2021 • edited Loading

G1K commented Jan 28, 2021 • edited Loading

github-actions bot commented Feb 28, 2021

G1K commented Mar 2, 2021

github-actions bot commented Apr 3, 2021

Hedda commented Jan 18, 2022 • edited Loading

Hedda commented Jan 26, 2022

github-actions bot commented Feb 26, 2022

Hedda commented Feb 28, 2022

G1K commented Mar 2, 2022

Hedda commented Mar 9, 2022

pipiche38 commented Feb 6, 2023

G1K commented Feb 18, 2023

pipiche38 commented Feb 18, 2023

Hedda commented Feb 21, 2023 • edited Loading

Road map

G1K commented Oct 21, 2020 •

edited

Loading

Hedda commented Nov 3, 2020 •

edited

Loading

Koenkk commented Nov 3, 2020 •

edited

Loading

Hedda commented Nov 30, 2020 •

edited

Loading

jonathan-gatard commented Dec 14, 2020 •

edited

Loading

devbis commented Dec 14, 2020 •

edited

Loading

jonathan-gatard commented Dec 14, 2020 •

edited

Loading

Hedda commented Dec 14, 2020 •

edited

Loading

G1K commented Jan 28, 2021 •

edited

Loading

G1K commented Jan 28, 2021 •

edited

Loading

Hedda commented Jan 18, 2022 •

edited

Loading

Hedda commented Feb 21, 2023 •

edited

Loading