70 stable releases

new 3.11.0 Aug 4, 2021
3.10.2 Jul 28, 2021
3.10.1 Jun 23, 2021
3.9.6 Mar 29, 2021
3.0.4 Dec 29, 2019
Download history 260/week @ 2021-04-14 59/week @ 2021-04-21 11/week @ 2021-04-28 45/week @ 2021-05-05 93/week @ 2021-05-12 19/week @ 2021-05-19 20/week @ 2021-05-26 29/week @ 2021-06-02 79/week @ 2021-06-09 11/week @ 2021-06-16 31/week @ 2021-06-23 2/week @ 2021-06-30 15/week @ 2021-07-07 146/week @ 2021-07-14 13/week @ 2021-07-21 195/week @ 2021-07-28

228 downloads per month

MIT license

40KB
130 lines

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

Dependencies

~6.5–9MB
~142K SLoC