diff --git a/website/docs/software/python/cli.md b/website/docs/software/python/cli.md index 477e63c4..14e3e686 100644 --- a/website/docs/software/python/cli.md +++ b/website/docs/software/python/cli.md @@ -18,7 +18,14 @@ meshtastic -h Because of the growing nature of this project, not all commands may appear when using the help command with `meshtastic -h`. ::: -## Changing device settings +## Getting a list of User Preferences + +You can get a list of user preferences by running '--get' with an invalid atrribute such as 'all'. +```bash +meshtastic --get all +``` + +## Changing settings You can also use this tool to set any of the device parameters which are stored in persistent storage. For instance, here's how to set the device to keep the bluetooth link alive for eight hours (any usage of the bluetooth protocol from your phone will reset this timer) diff --git a/website/docs/software/python/usage.md b/website/docs/software/python/usage.md index f75c42e9..30b88c0c 100644 --- a/website/docs/software/python/usage.md +++ b/website/docs/software/python/usage.md @@ -36,6 +36,21 @@ interface.close() Note: Be sure to change the ip address in the code above to a valid ip address for your setup. +You can get and update settings like this: +```python +import meshtastic +interface = meshtastic.SerialInterface() + +ourNode = interface.getNode('^local') +print(ourNode.radioConfig.preferences) +ourNode.radioConfig.preferences.gps_update_interval = 60 +print(ourNode.radioConfig.preferences) +ourNode.writeConfig() + +interface.close() +``` + + For the rough notes/implementation plan see [TODO](https://github.com/meshtastic/Meshtastic-python/blob/master/TODO.md). See the API for full details of how to use the library. ## A note to developers of this lib