Giter Club home page Giter Club logo

projectchip-zap's Introduction

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.x or v14.x should work as of 2021) 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 ci

which will download install all the project dependencies. It is not uncommon to run into native library compilation problems at this point. There are various src-script/install-* scripts for different platforms. Please refer to FAQ for additional details of which script to run on different platforms and then rerun npm ci.

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

projectchip-zap's People

Contributors

alexroxy17 avatar arunbharadwaj avatar babakzarrinbal avatar brdandu avatar bzbarsky-apple avatar dependabot[bot] avatar erjiaqing avatar gabrielashsilabs avatar irushavm avatar jepenven-silabs avatar jmartinez-silabs avatar mehradml avatar mlepage-google avatar mrjerryjohns avatar nicolaskey avatar pjzander-signify avatar rcasallas-silabs avatar saharkaargar avatar saharkargar avatar selissia avatar tecimovic avatar thucdtran avatar unify-automated avatar vivien-apple avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.