settings_catalog.h File Reference

The shared catalog of known settings. A KNOWN_* macro per setting bakes in its neutral wire key, encoding, bounds, default, and side effects. More...

#include "system/settings/settings.h"

Go to the source code of this file.

Macros
#define	KNOWN_TEMPERATURE_UNIT(off)
	Setting definition for Temperature Unit (Celsius or Fahrenheit).
#define	KNOWN_DATE_FORMAT(off, dflt)
	Setting definition for Date Format.
#define	KNOWN_THEME(off, count)
	Setting definition for Theme.
#define	KNOWN_HEADER_FONT(off, count)
	Setting definition for Header Font, an index into the face's own header font table.
#define	KNOWN_STEPS_MODE(off, count)
	Setting definition for Steps Mode.
#define	KNOWN_DISTANCE_UNIT(off, count)
	Setting definition for Distance Unit.
#define	KNOWN_TIME_FORMAT(off, count)
	Setting definition for Time Format.
#define	KNOWN_BLUETOOTH_ICON(off)
	Setting definition for Bluetooth Icon.
#define	KNOWN_QUIET_TIME_ICON(off)
	Setting definition for the Quiet Time Icon.
#define	KNOWN_BLUETOOTH_VIBE_CONNECT(off, count)
	Setting definition for Bluetooth Vibe Connect.
#define	KNOWN_BLUETOOTH_VIBE_DISCONNECT(off, count)
	Setting definition for Bluetooth Vibe Disconnect.
#define	KNOWN_HOURLY_VIBE(off, count)
	Setting definition for the Hourly Vibration (a VibeChoice fired at the top of each hour).
#define	KNOWN_BATTERY_DISPLAY(off, count)
	Setting definition for Battery Display (icon + percent / icon / percent).

Detailed Description

The shared catalog of known settings. A KNOWN_* macro per setting bakes in its neutral wire key, encoding, bounds, default, and side effects.

A face subscribes to a known setting by placing its KNOWN_* entry in the face's field table at the offset of the matching struct member, and by declaring the setting's MESSAGE_KEY in the face's package.json. Face-only settings are declared inline in the table instead, with an id of SETTING_COUNT or greater.