Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

ConfiguredThings/chirpstack-api

Repository files navigation

ChirpStack API

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

if you want install maven artifact on local repo after the build

sudo chown $(id -u).$(id -g) java/build/ -R && mvn -f java/build/pom.xml install

currently the build run only on Linux x86_64 due to the download of the protoc-gen-grpc-java-1.31.0-linux-x86_64.exe

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

About

ChirpStack API (Protobuf & gRPC)

Resources

License

Stars

Watchers

Forks

Packages

Contributors

Languages

  • Python 53.2%
  • JavaScript 36.8%
  • Makefile 7.7%
  • Rust 2.1%
  • Go 0.2%

AltStyle によって変換されたページ (->オリジナル) /