ambient lighting init

2025-02-02 08:42:11 -08:00 · 2023-09-10 21:38:07 -07:00 · 2023-09-10 21:38:07 -07:00 · 6ea0d9a6af
parent 9883b48e01
commit 6ea0d9a6af
3 changed files with 109 additions and 0 deletions
--- a/docs/configuration/module-config/ambient-lighting.mdx
+++ b/docs/configuration/module-config/ambient-lighting.mdx
@ -0,0 +1,106 @@
+---
+id: ambient-lighting
+title: Ambient Lighting Module Usage
+slug: /settings/moduleconfig/ambient-lighting
+sidebar_label: Ambient Lighting
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+
+The Ambient Lighting Module has settings for control of onboard LEDs and allows users to adjust the brightness levels and respective color levels. Initially created for the RAK14001 RGB LED module using the NCP5623 with I2C. Config options are: LED State, Current, Red Level, Green Level, and Blue Level.
+
+In order to use this module, make sure your devices have firmware version 2.2.5 or higher.
+
+## Ambient Lighting Config Values
+
+### LED State
+
+Sets the LED to on or Off
+
+### Current
+
+Sets the current for the LED output. Default is 10.
+
+### Red
+
+Sets the red LED level. Values are 0-255.
+
+### Green
+
+Sets the green LED level. Values are 0-255.
+
+### Blue
+
+Sets the blue LED level. Values are 0-255.
+
+## Ambient Lighting Module Client Availability
+
+<Tabs
+groupId="settings"
+defaultValue="cli"
+values={[
+{label: 'Android', value: 'android'},
+{label: 'Apple', value: 'apple'},
+{label: 'CLI', value: 'cli'},
+{label: 'Web', value: 'web'},
+]}>
+<TabItem value="android">
+
+
+:::info
+All Ambient Lighting Module config options are available for Android in app version 2.2.3 and higher.
+
+1. Open the Meshtastic App
+2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > Ambient Lighting**
+:::
+
+</TabItem>
+<TabItem value="apple">
+
+:::info
+All Ambient Lighting Module config options are available on iOS, iPadOS and macOS app versions 2.2.3 and higher at Settings > Modules > Ambient Lighting
+:::
+
+</TabItem>
+<TabItem value="cli">
+
+:::info
+
+All Ambient Lighting Module config options are available in the python CLI version 2.2.3 and higher.
+
+:::
+
+Example commands are below:
+
+```shell title="Set the LED to on or off"
+meshtastic --set ambient_lighting.led_state 1
+meshtastic --set ambient_lighting.led_state 0
+```
+
+```shell title="Set the led current to 5"
+meshtastic --set ambient_lighting.current 5
+```
+
+```shell title="Set the red LED brightness to 103"
+meshtastic --set ambient_lighting.red 103
+```
+
+```shell title="Set the green brightness to 234"
+meshtastic --set ambient_lighting.green 234
+```
+
+```shell title="Set the blue LED brightness to 148"
+meshtastic --set ambient_lighting.blue 148
+```
+
+```shell title="Get the Ambient Lighting Module Configuration"
+meshtastic --get ambient_lighting
+```
+</TabItem>
+<TabItem value="web">
+
+Not yet implemented.
+
+</TabItem>
+</Tabs>
--- a/docs/configuration/module-config/detection-sensor.mdx
+++ b/docs/configuration/module-config/detection-sensor.mdx
@ -71,7 +71,9 @@ All Detection Sensor Module config options are available for Android in app vers
 </TabItem>
 <TabItem value="apple">

+:::info
 All Detection Sensor Module config options are available on iOS, iPadOS and macOS app versions 2.2.2 and higher at Settings > Modules > Detection Sensor
+:::

 </TabItem>
 <TabItem value="cli">
--- a/docs/configuration/module-config/index.mdx
+++ b/docs/configuration/module-config/index.mdx
@ -10,6 +10,7 @@ Modules are included in the firmware and allow users to extend the functionality

 |                                    Name                                    |                                                                                                             Description                                                                                                             |
 | :------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
+|       [Ambient Lighting](/docs/settings/moduleconfig/ambient-lighting)     |                                                                                              Adjust the brightness of NCP5623 I2C RGB LEDs                                                                                          |
 |                 [Audio](/docs/settings/moduleconfig/audio)                 |                                                                                      Enable Support for Codec2 Voice Comms on certain devices.                                                                                      |
 |        [Canned Message](/docs/settings/moduleconfig/canned-message)        |                                                   Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder.                                                   |
 |      [Detection Sensor](/docs/settings/moduleconfig/detection-sensor)      |                                                                     Configure a GPIO pin to be monitored for specified high/low status and send text alerts.                                                                        |