https://github.com/brocaar/chirpstack-api
ChirpStack API (Protobuf & gRPC)
https://github.com/brocaar/chirpstack-api
Last synced: about 1 year ago
JSON representation
ChirpStack API (Protobuf & gRPC)
- Host: GitHub
- URL: https://github.com/brocaar/chirpstack-api
- Owner: brocaar
- License: mit
- Created: 2019-11-05T12:24:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T02:37:13.000Z (over 3 years ago)
- Last Synced: 2025-04-02T01:45:25.251Z (about 1 year ago)
- Language: Python
- Size: 2.84 MB
- Stars: 68
- Watchers: 8
- Forks: 81
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ChirpStack API
This repository contains the [Protobuf](https://developers.google.com/protocol-buffers/)
and [gRPC](https://grpc.io/) API definitions for the [ChirpStack](https://www.chirpstack.io)
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
```bash
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](https://docs.docker.com/install/) and
[Docker Compose](https://docs.docker.com/compose/install/) to be installed.
```bash
# (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
```