Ambient Lighting Module Usage

The Ambient Lighting Module has settings for control of onboard LEDsLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. and allows users to adjust the brightness levels and respective color levels. Initially created for the RAK14001 RGB LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. module using the NCP5623 with I2CI2CA two-wire bus used to attach peripherals such as sensors and displays to a device.. Config options are: LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. 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 LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. to on or Off

Current

Sets the current for the LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. output. Default is 10.

Red

Sets the red LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. level. Values are 0-255.

Green

Sets the green LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. level. Values are 0-255.

Blue

Sets the blue LEDLED (Light-Emitting Diode). An indicator light on a device. The External Notification module can drive one in response to mesh activity. level. Values are 0-255.

Ambient Lighting Module Client Availability

Android

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: Settings > Ambient Lighting

Apple

Apple

info

All Ambient Lighting Module config options are available on iOS, iPadOS and macOS app versions 2.2.3 and higher at Settings > Module Configuration > Ambient Lighting

CLI

CLI

info

All Ambient Lighting Module config options are available in the python CLI version 2.2.3 and higher.

Example commands are below:

Set the LED to on or off

meshtastic --set ambient_lighting.led_state 1
meshtastic --set ambient_lighting.led_state 0

Set the led current to 5

meshtastic --set ambient_lighting.current 5

Set the red LED brightness to 103

meshtastic --set ambient_lighting.red 103

Set the green brightness to 234

meshtastic --set ambient_lighting.green 234

Set the blue LED brightness to 148

meshtastic --set ambient_lighting.blue 148

Get the Ambient Lighting Module Configuration

meshtastic --get ambient_lighting

Web

Web

info

All Ambient Lighting module config options are available in the Web UI.