Type Alias ModuleConfig_ExternalNotificationConfig

Type declaration

• active: boolean

  IF this is true, the 'output' Pin will be pulled active high, false means active low.

  Generated

  from field: bool active = 4;

• alertBell: boolean

  True: Alert when the bell character is received (output)

  Generated

  from field: bool alert_bell = 6;

• alertBellBuzzer: boolean

  True: Alert when the bell character is received (output_buzzer)

  Generated

  from field: bool alert_bell_buzzer = 13;

• alertBellVibra: boolean

  True: Alert when the bell character is received (output_vibra)

  Generated

  from field: bool alert_bell_vibra = 12;

• alertMessage: boolean

  True: Alert when a text message arrives (output)

  Generated

  from field: bool alert_message = 5;

• alertMessageBuzzer: boolean

  True: Alert when a text message arrives (output_buzzer)

  Generated

  from field: bool alert_message_buzzer = 11;

• alertMessageVibra: boolean

  True: Alert when a text message arrives (output_vibra)

  Generated

  from field: bool alert_message_vibra = 10;

• enabled: boolean

  Enable the ExternalNotificationModule

  Generated

  from field: bool enabled = 1;

• nagTimeout: number

  The notification will toggle with 'output_ms' for this time of seconds. Default is 0 which means don't repeat at all. 60 would mean blink and/or beep for 60 seconds

  Generated

  from field: uint32 nag_timeout = 14;

• output: number

  Define the output pin GPIO setting Defaults to EXT_NOTIFY_OUT if set for the board. In standalone devices this pin should drive the LED to match the UI.

  Generated

  from field: uint32 output = 3;

• outputBuzzer: number

  Optional: Define a tertiary output pin for an active buzzer This is used in standalone devices to to match the UI.

  Generated

  from field: uint32 output_buzzer = 9;

• outputMs: number

  When using in On/Off mode, keep the output on for this many milliseconds. Default 1000ms (1 second).

  Generated

  from field: uint32 output_ms = 2;

• outputVibra: number

  Optional: Define a secondary output pin for a vibra motor This is used in standalone devices to match the UI.

  Generated

  from field: uint32 output_vibra = 8;

• useI2sAsBuzzer: boolean

  When true, enables devices with native I2S audio output to use the RTTTL over speaker like a buzzer T-Watch S3 and T-Deck for example have this capability

  Generated

  from field: bool use_i2s_as_buzzer = 15;

• usePwm: boolean

  use a PWM output instead of a simple on/off output. This will ignore the 'output', 'output_ms' and 'active' settings and use the device.buzzer_gpio instead.

  Generated

  from field: bool use_pwm = 7;