Giter VIP home page Giter VIP logo

chirpstack-api's Introduction

ChirpStack API

Tests

This repository contains the Protobuf and gRPC API definitions for the ChirpStack components.

Protobuf / gRPC structure

protobuf             - Protobuf and gRPC source files
├── as
│   ├── external
│   │   └── api      - Application Server External API definitions
│   └── integration  - Application Server integration definitions
├── common           - Definitions shared across ChirpStack components
├── geo              - Geolocation Server API definitions
├── gw               - LoRa gateway definitions
├── nc               - Network Controller definitions
└── ns               - Network Server definitions

Supported languages

Go

Documentation: https://godoc.org/github.com/brocaar/chirpstack-api/go

go get github.com/brocaar/chirpstack-api/go/v3

JavaScript / Typescript

See: https://www.npmjs.com/package/@chirpstack/chirpstack-api.

Python

See: https://pypi.org/project/chirpstack-api/.

Rust

See: https://crates.io/crates/chirpstack_api.

Java

See the README in /java subfolder: https://github.com/brocaar/chirpstack-api/tree/master/java.

Generating client libraries

These instructions require Docker and Docker Compose to be installed.

# (re)generate all client libraries
make all

# only (re)generate go client library
make go

# only (re)generate JavaScript / Typescript
make js

# only (re)generate Python client library
make python

# only (re)generate Swagger definitions
make swagger

# only (re)generate Java definitions
make java

chirpstack-api's People

Contributors

brocaar avatar sophiekovalevsky avatar mattocchi avatar dependabot[bot] avatar aleksandrovrts avatar sagar-patel-sls avatar sylveon avatar mjl- avatar philday-ct avatar dangodai 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.