Variables reference

Here is the list of all available variables accessible by the get and set commands.

Please note that config.* variables act directly on the live configuration, but they are not directly saved in eeprom. This allows you to test the configuration, and simply reset the board to revert to your previous configuration, unless you run eeprom::save.

In the set commands, the value argument is space trimmed (left and right), except for string arguments: in that case, exactly a single space is expected from the address and the value.

# sets the wifi password to 'mypassword'
set config.wifi.password mypassword

# sets the wifi password to ' mypassword'
set config.wifi.password  mypassword

bool-typed variables take a numeric argument 0/1 (false/true).

Validation is basic: for example, there is no check for overlapping usage of digital pins.

Most configurations are applied on the fly, while others require a specific reload command or a board reset:

• buttons: need to run buttons::reload
• NTP hostname: at next refresh, or force with ntp::sync.

address	type	description	read-only	default
version	string	version (git commit, worktree state)	y
config.scale.dataPin	uint8	HX711 data pin		5
config.scale.clockPin	uint8	HX711 clock pin		4
config.scale.mode	HX711Mode	HX711 mode (A128, B, A64)		A128
config.scale.calibration.tareRead	int32	raw sensor read for tare (current HX711 mode)	y
config.scale.calibration.calibrationRead	int32	raw sensor read for calibration (current HX711 mode)	y
config.scale.calibration.calibrationWeight	float	calibration weight (current HX711 mode)	y	NaN (uncalibrated)
config.scale.calibrations.$mode. ...	~	same fields as config.scale.calibration. ..., but for the specific HX711 mode	y
config.wifi.ssid	string	WiFi access point name
config.wifi.password	string	WiFi WPA password (open if '')
config.wifi.dhcpTimeout	uint8	DHCP timeout in seconds		10 seconds
config.wifi.idleTimeout	uint8	WiFi automatic shutdown timeout in seconds		10 seconds
config.submit.threshold	float	minimum weight for submission, also affect countdown to idle (low power) state
config.submit.skipPPForm	bool	skip upload of the weighing to the official Precious Plastic form		1
config.submit.spacesWorkaroundPPForm	bool	workaround bad plastic entry values (missing spaces)		1
config.submit.collectionPoint	string	collection point name
config.submit.collectorName	string	name of collector
config.submit.userForm.urn	string	user Google form: address (e.g. docs.google.com/forms/...), '' to disable
config.submit.userForm.type	string	user Google form: parameter key for plastic type (e.g. entry.123456789)
config.submit.userForm.collectionPoint	string	user Google form: parameter key for collection point (e.g. entry.123456789)
config.submit.userForm.collectorName	string	user Google form: parameter key for collector name (e.g. entry.123456789)
config.submit.userForm.weight	string	user Google form: parameter key for plastic weight (e.g. entry.123456789)
config.buttons.$action. ...	buttons::Config	CTSU parameters (calibration sketch by delta-G)		(precalibrated)
config.ntp.hostname	string	ntp server hostname		europe.pool.ntp.org
config.ntp.refresh	uint32	ntp resync period in seconds		1 day
config.sdcard.CSpin	uint8	SD card SPI interface Chip Select pin		10