https://github.com/hadjedjvincent/homebridge-yokis-usb

Bring Yokis Pro USB key (also named Yokey) support to homebridge
https://github.com/hadjedjvincent/homebridge-yokis-usb

homebridge homebridge-plugin yokis

Last synced: 4 months ago
JSON representation

Bring Yokis Pro USB key (also named Yokey) support to homebridge

• Host: GitHub
• URL: https://github.com/hadjedjvincent/homebridge-yokis-usb
• Owner: hadjedjvincent
• License: mit
• Created: 2022-07-01T17:08:32.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T06:22:02.000Z (4 months ago)
• Last Synced: 2024-10-12T15:02:34.497Z (4 months ago)
• Topics: homebridge, homebridge-plugin, yokis
• Language: TypeScript
• Homepage:
• Size: 506 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        










# Homebridge Yokis Plugin

[![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)





This plugin allow you to trigger ON/OFF and get current state of Yokis *MTR2000ER* module from HomeKit with [Homebridge](https://homebridge.io).

The implementation has been made using the [Yokey](https://www.yokis.com/en/system-configuration-and-management/yokey/), an USB dongle that facilitates acquisition and configuration phase of Yokis radio modules.

Using the [Yokis Pro app](https://www.yokis.com/en/app-yokispro/), you can create Yokis Radio BUS, configure your module etc.

This step is mandatory before using this plugin.

Once you're done with the Yokis Pro app, you can plug the Yokey on your device (tested on Raspberry Pi);

What is currently working :

 - [x] Retrieve state for a module using its ID (ON/OFF and variation value)

 - [x] Toggle state for a module

 - [x] Force ON mode for a module using its ID

 - [x] Force OFF mode for amodule using its ID

 - [x] Automatically calculate the CRC control value for each request

By doing some USB traffic capture, I was able to create this plugin, but some additionnal work has to be done **(help needed !**) :

 - [ ] Retrieve the modules list from the dongle database / or from the Yokis API

 - [ ] Make this plugin compatible with "Energeasy Connect USB Dongle" (I don't have one)