Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Eddy Babetto <eddy.babetto@secomind.com>
  • Loading branch information
eddbbt committed Oct 31, 2024
1 parent 29fac67 commit 4db228f
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,23 @@ key and all necessary information are provided.
## Usage

Run `astartectl` to see available commands.

### Send or set data to devices

For server-owned interfaces, it is possible to send or set data via astartectl.
To do so, you can use:
- astartectl appengine devices send-data (deprecated)
- astartectl appengine devices publish-datastream
- astartectl appengine devices set-property

Run the appropriate command to see a short description, command suggestions and flags.
Generally speaking, one of those could be written like
```
astartectl appengine devices publish-datastream 2TBn-jNESuuHamE2Zo1anA com.my.interface /my/path "value"
```

Please note, "value" is whatever your raw value is, no encapsulation whatsoever is required by astarte or astartectl (but you can provide your own, if you need it).
Exceptions follow:
- arrays are written like ["value", "anothervalue"] (depending on your shell, this can also be "['value', 'anothervalue']", please check before using in a production env)
- binaryblobs must be base64 encoded
- datetime is based on an external library that is flexible enough to translate a fairly high number of different formats, further documentation and supported formats can be found [here](https://github.com/araddon/dateparse)

0 comments on commit 4db228f

Please sign in to comment.