Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.33 KB

README.md

File metadata and controls

51 lines (33 loc) · 2.33 KB

ZCL Advanced Platform

ZCL Advanced Platform

Node.js CI

What is ZAP?

ZAP is a generic generation engine and user interface for applications and libraries based on Zigbee Cluster Library, the specification developed by the Zigbee Alliance.

ZAP allows you to perform the following:

  • perform tailored generation of all global artifacts (constants, types, IDs, etc) based on the ZCL specification
  • provide UI for the end-user to select specific application configuration (clusters, attributes, commands, etc.)
  • provide tailored generation engine to convert user selected configuration, into sets of generated artifacts that can plug into any ZCL-based middleware or networking stack solutions.

ZAP is a generic templating engine. Examples are provided for how to generate artifacts for the C language environment, but one could easily add new templates for other language environments, such as C++, java, node.js, python or any other.

Quick instructions

This is a node.js application. In order to run it, you need to have npm installed. The best way is to simply download latest install of node and you will get npm. If you have an older version of node installed on your workstation, it may give you trouble, particularly if it's very old. So make sure you have decently recent (v12.16 or later as of 2020) version of node available. Run node --version to check what version is picked up.

Once you have a desired version of node, you can run:

npm install

which will download install all the project dependencies, and then run:

npm run zap

Refer to more detailed instructions for more details.

License

This software is licensed under Apache 2.0 license.

Detailed Documentation