Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ioki-mobility/thingsboard-ruby
A Thingsboard client for ruby
https://github.com/ioki-mobility/thingsboard-ruby
Last synced: 1 day ago
JSON representation
A Thingsboard client for ruby
- Host: GitHub
- URL: https://github.com/ioki-mobility/thingsboard-ruby
- Owner: ioki-mobility
- License: mit
- Created: 2022-07-27T17:28:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-16T08:02:56.000Z (9 months ago)
- Last Synced: 2024-04-21T03:54:37.401Z (2 months ago)
- Language: Ruby
- Size: 54.7 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Lists
- awesome-thingsboard - thingsboard-ruby
README
# thingsboard-ruby [](https://github.com/ioki-mobility/thingsboard-ruby/actions/workflows/main.yml)
This library helps to integrate the Thingsboard's API's with following feature-primitives:
* [Administration REST API](https://thingsboard.io/docs/reference/rest-api/)
* [Login](https://demo.thingsboard.io/swagger-ui/#/login-endpoint/loginPost)
* [create Asset](https://demo.thingsboard.io/swagger-ui/#/asset-controller/saveAssetUsingPOST)
* [create Device](https://demo.thingsboard.io/swagger-ui/#/device-controller/saveDeviceUsingPOST)
* [create Relation](https://demo.thingsboard.io/swagger-ui/#/entity-relation-controller/saveRelationUsingPOST)
* [HTTP Device API](https://thingsboard.io/docs/reference/http-api/)
* [create Telemetries](https://thingsboard.io/docs/reference/http-api/)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'thingsboard-ruby'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install thingsboard-ruby
## Usage
To load this gem run:
```ruby
require 'thingsboard'
```
To perform any Api call:
```ruby
Thingsboard::Api::CreateAsset.call(
token: '***SECRET_THINGSBOARD_TOKEN***',
name: 'Bathroom',
type: 'room',
label: 'The bathroom next to the entry'
)
```
The response of an Api call usually returns an json-string of the response-body:
```json
{
"id": {
"entityType": "ASSET",
"id": "332090a0-0737-11eb-b3f7-4dbfb57ed205"
},
"createdTime": 1601921922730,
"additionalInfo": null,
"tenantId": {
"entityType": "TENANT",
"id": "8e71f160-db9a-88ea-95d6-fd59fd7ffce1"
},
"customerId": {
"entityType": "CUSTOMER",
"id": "13814000-1dd2-11b2-8080-808080808080"
},
"name": "Bathroom",
"type": "room",
"label": "The bathroom next to the entry"
}
```
Any request that results in an unexpected error (meaning all response https-status-codes except `2**`) will raise an `Thingsboard::Api::Error`. Depending on the exact kind of error it will raise different subclasses of `Thingsboard::Api::Error`:
* `Thingsboard::Api::Unauthorized` if http-status is `401`
* `Thingsboard::Api::Forbidden` if http-status is `403`
* `Thingsboard::Api::UnexpectedResponseCode` for any other kind of error (like http-stauts `500`)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ioki-mobility/thingsboard-ruby.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).