keyble icon indicating copy to clipboard operation
keyble copied to clipboard

Development of keyble version 1.0.0

Open oyooyo opened this issue 3 years ago • 3 comments

I plan to release keyble version 1.0.0 in the near future, which will come with a few changes worth mentioning:

  1. The current "keyble" npm package will be split into two parts: The "keyble" package will only contain the core API, the command line tools will all move to a separate package named "keyble-cli". So in the future, you will probably npm install keyble-cli instead of npm install keyble.

  2. There will only be a single command line tool in the future, probably named "keyble". So there won't be separate keyble-registeruser and keyble-sendcommand scripts; your command line will change from keyble-sendcommand ... to keyble sendcommand ... (notice the space instead of the dash character)

  3. Starting with version 1.0.0, I intend to provide a properly documented and stable API and switch to semantic versioning. So if you're using keyble as an API in another Javascript project, backwards-incompatible changes to the API shall only occur on major version changes in the future.

  4. I intend to provide some more npm packages in order to make it easier to use keyble in smart home systems:

  • keyble-mqtt, for making it easier to use control the smart lock via MQTT
  • keyble-nodered, for making it easier to control the smart lock via Node Red
  • keyble-iobroker, create an actually working adapter for ioBroker

Until version 1.0.0 is ready, the version 0.1.14 from 2018 is the latest stable version that gets installed when running

npm install keyble

The latest unstable development version can be installed by using the nexttag, e.g.

npm install keyble@next

I will post some updates on the status of the development here. If you have any suggestions, comments etc. concerning the development of version 1.0.0, please post them here as well.

oyooyo avatar Nov 10 '20 14:11 oyooyo

Da hört sich gut an. Dann warte ich noch bis diese Version fertig ist um mein Schloss in Iobroker einzubinden.

frodo777 avatar Nov 11 '20 18:11 frodo777

An initial version of the MQTT client is ready. It is available on Github and as a npm package.

oyooyo avatar Nov 13 '20 14:11 oyooyo

An initial version of the Node-RED nodes is ready. It is available on GitHub and as a npm package.

Kind of works already, but needs some more work and is not yet installable from within Node-RED.

oyooyo avatar Nov 14 '20 16:11 oyooyo