constants Namespace Reference

Namespace that groups compile-time constants. More...

Namespaces
namespace	bridgeSerial
	Constants that configure the serial link shared with lsh-bridge.
namespace	config
	Resource limits derived from lsh_user_config.hpp.
namespace	debugConfigs
	namespace for debug configurable parameters.
namespace	wrongConfigStrings
	namespace for wrong config static EEPROM strings.

Enumerations
enum class	ClickResult : uint8_t {   NO_CLICK , SHORT_CLICK , SHORT_CLICK_QUICK , LONG_CLICK ,   SUPER_LONG_CLICK , NO_CLICK_KEEPING_CLICKED , NO_CLICK_NOT_SHORT_CLICKABLE }
	Result of clickable click detection via clickDetection(). More...
enum class	ClickType : uint8_t { NONE , SHORT , LONG , SUPER_LONG }
	Clickable (like button) click types. More...
enum class	LongClickType : uint8_t { NONE , NORMAL , ON_ONLY , OFF_ONLY }
	Long click behaviors. More...
enum class	SuperLongClickType : uint8_t { NONE , NORMAL , SELECTIVE }
	Super long click behaviors. More...
enum class	NoNetworkClickType : uint8_t { NONE , LOCAL_FALLBACK , DO_NOTHING }
	Fallback for a network click that expired or receives a failover. More...
enum class	IndicatorMode : uint8_t { ANY , ALL , MAJORITY }
	Indicator mode for an indicator. More...

Detailed Description

Namespace that groups compile-time constants.

namespace for constants.

namespace for constants

Namespace that groups firmware constants.

Enumeration Type Documentation

ClickResult

enum class constants::ClickResult : uint8_t

strong

Result of clickable click detection via clickDetection().

Enumerator
NO_CLICK	No click detected.
SHORT_CLICK	Short click detected.
SHORT_CLICK_QUICK	Short click detected on press for quick-only buttons.
LONG_CLICK	Long click detected.
SUPER_LONG_CLICK	Super long click detected.
NO_CLICK_KEEPING_CLICKED	The clickable is kept pressed after a timed action.
NO_CLICK_NOT_SHORT_CLICKABLE	A short press was detected on a non-short-clickable input.

ClickType

enum class constants::ClickType : uint8_t

strong

Clickable (like button) click types.

Enumerator
NONE	Never use this, it's just a default parameter.
SHORT	Short click.
LONG	Long click.
SUPER_LONG	Super long click.

IndicatorMode

enum class constants::IndicatorMode : uint8_t

strong

Indicator mode for an indicator.

Enumerator
ANY	If any controlled actuators is ON turn on the indicator.
ALL	If all controlled actuators are ON turn on the indicator.
MAJORITY	If the majority of controlled actuators is ON turn ON the indicator.

LongClickType

enum class constants::LongClickType : uint8_t

strong

Long click behaviors.

Enumerator
NONE	Never use this, it's just a default parameter.
NORMAL	Turns on or off secondary attached actuators based on how many are on or off.
ON_ONLY	Turns on secondary attached actuators.
OFF_ONLY	Turns off secondary attached actuators.

NoNetworkClickType

enum class constants::NoNetworkClickType : uint8_t

strong

Fallback for a network click that expired or receives a failover.

Enumerator
NONE	Never use this, it's just a default parameter.
LOCAL_FALLBACK	Apply local logic.
DO_NOTHING	Do nothing.

SuperLongClickType

enum class constants::SuperLongClickType : uint8_t

strong

Super long click behaviors.

Enumerator
NONE	Never use this, it's just a default parameter.
NORMAL	Turns off all controllino unprotected actuators.
SELECTIVE	Turns off a list of selected unprotected actuators.