https://github.com/balena-io-examples/device-tags

Examples on how to use the balena API & SDK to set device tags from within your app.
https://github.com/balena-io-examples/device-tags

balena-sdk

Last synced: 22 days ago
JSON representation

Examples on how to use the balena API & SDK to set device tags from within your app.

• Host: GitHub
• URL: https://github.com/balena-io-examples/device-tags
• Owner: balena-io-examples
• Created: 2018-01-19T06:27:17.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-22T08:22:47.000Z (10 months ago)
• Last Synced: 2024-05-29T22:15:28.566Z (7 months ago)
• Topics: balena-sdk
• Language: Shell
• Homepage:
• Size: 144 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
## Using the balena API & SDK to set device tags from within apps.

This is a simple project which runs one container based on the [balena simple-server-node repository][simple-server-node] that demonstrates how to set device tags from within your application.

This project serves up `"Hello World!"` on port `:80` of your balena device and additionally:

* Demonstrates how to use CURL to set tags (in the application's `start.sh`).

  * sets the `device_tags_node.last_application_start` tag with the current timestamp when the application starts.

* Demonstrates how to use the javascript [balena-SDK][balena-sdk] in the application's `device_tags_node/server.js`.

  * sets the `device_tags_node.last_server_start` tag with the current timestamp whenever the node server starts.

  * sets the `device_tags_node.last_request` tag with the current timestamp whenever the node server responds to an HTTP request.

* Demonstrates how to use the python [balena-SDK][balena-sdk-python] in the application's `device_tags_python/src/app.py`. To try to python version, you need to uncomment the respective section in the docker-compose.yml.

  * sets the `device_tags_python.last_server_start` tag with the current timestamp whenever the python server starts.

  * sets the `device_tags_python.last_request` tag with the current timestamp whenever the python server responds to an HTTP request.

### Setup

Check out the instructions in the [balena simple-server-node repository][simple-server-node] to get started.

### Authentication

The scripts use the [`BALENA_API_KEY` environment variable][container-environment], which is injected to the environment of all balena applications, to authenticate all requests.

[simple-server-node]:https://github.com/balena-io-projects/simple-server-node

[balena-sdk]:https://github.com/balena-io/balena-sdk/

[balena-sdk-python]:https://github.com/balena-io/balena-sdk-python/

[container-environment]:https://docs.balena.io/runtime/runtime/#the-container-environment