https://github.com/cjhdev/chirp_stack_api
ChirpStack API for Ruby
https://github.com/cjhdev/chirp_stack_api
chirpstack
Last synced: 4 months ago
JSON representation
ChirpStack API for Ruby
- Host: GitHub
- URL: https://github.com/cjhdev/chirp_stack_api
- Owner: cjhdev
- License: mit
- Created: 2023-06-07T11:14:38.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T11:33:35.000Z (over 1 year ago)
- Last Synced: 2025-01-21T03:42:34.259Z (6 months ago)
- Topics: chirpstack
- Language: Ruby
- Homepage:
- Size: 90.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Ruby ChirpStack API
===================
A Ruby Gem containing the generated GRPC code for talking to [ChirpStack V4](https://github.com/chirpstack/chirpstack).
## How To Use
Add this repository to your Gemfile:
`gem 'chirp_stack_api', git: 'https://github.com/cjhdev/chirp_stack_api', tag: 'v0.1.0'`
then
`require 'chirp_stack_api'`
The grpc types will be in the `ChirpStackAPI` namespace with the chirpstack groups in uppercase.
e.g.
`ChirpStackAPI::API`
`ChirpStackAPI::GW`
`ChirpStackAPI::COMMON`
## How To Update
`make generate`
- creates docker environment
- runs the generator script
The generator script exists to:
- take a copy of the upstream proto files
- insert the Ruby namespace into our copy
- run protoc on our copy
- insert `require` for all the generated files