From c1229dbd81307f501c173cde8a6f07f99a4b86f2 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Thu, 27 Jan 2022 14:52:04 -0700 Subject: [PATCH] Broke out examples --- .../environmental-measurment-plugin.md | 157 +++++++++++++++++- 1 file changed, 152 insertions(+), 5 deletions(-) diff --git a/docs/software/settings/environmental-measurment-plugin.md b/docs/software/settings/environmental-measurment-plugin.md index 5803583d..3e60e5ae 100644 --- a/docs/software/settings/environmental-measurment-plugin.md +++ b/docs/software/settings/environmental-measurment-plugin.md @@ -62,6 +62,7 @@ Interval in seconds of how often we should try to send our measurements to the m ## Examples +### Enable/Disable the plugin -``` +```bash title="Enable Plugin" meshtastic --set environmental_measurement_plugin_measurement_enabled true +``` +```bash title="Disable Plugin" +meshtastic --set environmental_measurement_plugin_measurement_enabled false +``` + + + + TODO + + + + + TODO + + + + + TODO + + + + +### Enable/Disable the plugin on device screen + + + +```bash title="Enable on device screen" meshtastic --set environmental_measurement_plugin_screen_enabled true -meshtastic --set environmental_measurement_plugin_update_interval 15 +``` +```bash title="Disable on device screen" +meshtastic --set environmental_measurement_plugin_screen_enabled false +``` + + + + TODO + + + + + TODO + + + + + TODO + + + + +### Display Farenheit/Celsius + + + +```bash title="Display Farenheit" meshtastic --set environmental_measurement_plugin_display_farenheit true -meshtastic --set environmental_measurement_plugin_sensor_type 5 -meshtastic --set environmental_measurement_plugin_sensor_type BME280 +``` +```bash title="Display Celsius" +meshtastic --set environmental_measurement_plugin_display_farenheit false +``` + + + + + TODO + + + + + TODO + + + + + TODO + + + + +### Set plugin update interval + + + +```bash title="Set plugin update interval to 15 seconds" +meshtastic --set environmental_measurement_plugin_update_interval 15 +``` + + + + + TODO + + + + + TODO + + + + + TODO + + + + +### Set Sensor type + + + + +:::note +The CLI is able to take the [value or the name](#environmental_measurement_plugin_sensor_type) of the sensor. +::: + +```bash title="Set sensor type to DS18B20" +meshtastic --set environmental_measurement_plugin_sensor_type 1 +``` +```bash title="Set sensor type to DS18B20" +meshtastic --set environmental_measurement_plugin_sensor_type DS18B20 ```