SpaIot name space. More...

Classes
class	BusSettings
	SPI 2840X Bus settings. More...

class	Button
	This class represents a button. More...

class	ButtonController
	This class is the base class of all button controllers. More...

class	ButtonSettings
	This class represents the settings of a button. More...

class	ControlPanel
	Control Panel. More...

class	Event
	Spa Events. More...

class	FrameDecoder
	This class decodes information from the technical block of the spa. More...

class	HardwareSettings
	This class represents the hardware settings of a SpaIot device. More...

class	LedSettings
	SPI 2840X Led settings. More...

class	Multiplexer
	Analog multiplexer for buttons. More...

class	Pcf8574Mux
	Multiplexer controlled by a PCF8574. More...

class	ServerSettings
	Server settings class. More...

class	SpaClient
	SpaClient class. More...

class	SpaServer
	SpaServer class. More...

Enumerations
enum	Key { Power = 0 , Filter , Bubble , Jet , Sanitizer , Heater , HeatReached , TempUp , TempDown , TempUnit }
	LED and push buttons identification keys. More...

Functions
const char *	keyName (int key)
	Association between keys and key names. More...

Variables
const std::map< int, String >	KeyName
	Association between keys and key names.

const uint16_t	UnsetValue16 = 0xFFFF
	Indeterminate value on 16 bits.

const uint8_t	UnsetValue8 = 0xFF
	Indeterminate value on 8 bits.

const unsigned long	ButtonIntervalMs = 800
	Time between 2 successive actions on the buttons.

const uint16_t	DesiredTempMax = 40
	Maximum desired temperature in °C.

const uint16_t	DesiredTempMin = 20
	Minimum desired temperature in °C.

const uint16_t	SetupTrigUnitChangeMin = 5
	Number of changes in temperature unit corresponding to the reset request.

const unsigned long	SetupTrigUnitChangeStepMaxMs = 1000
	Maximum time separating successive actions on the unit change button to trigger reset request.

const unsigned long	HoldPressedMs = 300
	Time between press and release a button.

const unsigned long	BeginWaitingTimeMs = 3000
	`begin()` waiting time in milliseconds

const unsigned long	ResetErrorTimeMs = 4000
	Time after which an error can be erased.

const int	DataPin = SPAIOT_DATA_PIN
	Data pin.

const int	ClkPin = SPAIOT_CLK_PIN
	Clock pin.

const int	HoldPin = SPAIOT_HOLD_PIN
	Hold pin.

const HardwareSettings	Scip2Ssp
	Hardware settings for the SSP Spa with Scip2 board. More...

const HardwareSettings	Scip2Sjb
	Hardware settings for the SJB Spa with Scip2 board. More...

const HardwareSettings	SpaIot8266Ssp
	Hardware settings for the SSP Spa with SpaIot board (ESP8266 Version) More...

const HardwareSettings	SpaIot8266Sjb
	Hardware settings for the SJB Spa with SpaIot board (ESP8266 Version) More...

const HardwareSettings	SpaIot32Ssp
	Hardware settings for the SSP Spa with SpaIot board (ESP32 Version) More...

const HardwareSettings	SpaIot32Sjb
	Hardware settings for the SJB Spa with SpaIot board (ESP32 Version) More...

const HardwareSettings	SpaIotS3Ssp
	Hardware settings for the SSP Spa with SpaIot board (ESP32 S3 Version) More...

const HardwareSettings	SpaIotS3Sjb
	Hardware settings for the SJB Spa with SpaIot board (ESP32 S3 Version) More...

const HardwareSettings	SpaIot328574Ssp
	Hardware settings for the SSP Spa with SpaIot Extended board with PCF8574A (ESP32 Version) More...

const HardwareSettings	SpaIot328574Sjb
	Hardware settings for the SJB Spa with SpaIot Extended board with PCF8574A (ESP32 Version) More...

const HardwareSettings	SpaIotS38574Ssp
	Hardware settings for the SSP Spa with SpaIot Extended board with PCF8574A (ESP32 S3 Version) More...

const HardwareSettings	SpaIotS38574Sjb
	Hardware settings for the SJB Spa with SpaIot Extended board with PCF8574A (ESP32 S3 Version) More...

Pcf8574Mux	SpaIotPcf8574Mux
	SpaIot buttons controller with PCF8574A. More...

Buses
const BusSettings	Scip2Bus
	BusSettings for the SpaIot. More...

const BusSettings	SpaIot8266Bus
	BusSettings for the SpaIot ESP8266 Version. More...

const BusSettings	SpaIot32Bus
	BusSettings for the SpaIot ESP32 Version. More...

const BusSettings	SpaIotS3Bus
	BusSettings for the SpaIot ESP32S3 Version. More...

Buttons
const std::map< int, ButtonSettings >	Scip2SspButtons
	ButtonSettings for the SSP Spa with Scip2 board. More...

const std::map< int, ButtonSettings >	SpaIot8266SspButtons
	ButtonSettings for the SSP Spa with SpaIot board (ESP8266 version) More...

const std::map< int, ButtonSettings >	SpaIot32SspButtons
	ButtonSettings for the SSP Spa with SpaIot board (ESP32 version) More...

const std::map< int, ButtonSettings >	SpaIotS3SspButtons
	ButtonSettings for the SSP Spa with SpaIot board (ESP32 S3 version) More...

const std::map< int, ButtonSettings >	SpaIot8574SspButtons
	ButtonSettings for the SSP Spa with SpaIot Extended board with PCF8574A. More...

const std::map< int, ButtonSettings >	Scip2SjbButtons
	ButtonSettings for the SJB Spa with Scip2 board. More...

const std::map< int, ButtonSettings >	SpaIot8266SjbButtons
	ButtonSettings for the SJB Spa with SpaIot board (ESP8266 version) More...

const std::map< int, ButtonSettings >	SpaIot32SjbButtons
	ButtonSettings for the SJB Spa with SpaIot board (ESP32 version) More...

const std::map< int, ButtonSettings >	SpaIotS3SjbButtons
	ButtonSettings for the SJB Spa with SpaIot board (ESP32 S3 version) More...

const std::map< int, ButtonSettings >	SpaIot8574SjbButtons
	ButtonSettings for the SJB Spa with SpaIot Extended board with PCF8574A. More...

Leds
const std::map< int, LedSettings >	SspLeds
	Leds settings for the Ssp SPA. More...

const std::map< int, LedSettings >	SjbLeds
	Leds settings for the Sjb SPA. More...

Multiplexers
Multiplexer	Scip2MuxA
	The first multiplexer for the Scip2 controller. More...

Multiplexer	Scip2MuxB
	The second multiplexer for the Scip2 controller. More...

Multiplexer	SpaIot8266MuxA
	The first multiplexer for the SpaIot controller (ESP8266 version) More...

Multiplexer	SpaIot8266MuxB
	The second multiplexer for the SpaIot controller (ESP8266 version) More...

Multiplexer	SpaIot32MuxA
	The first multiplexer for the SpaIot controller (ESP32 version) More...

Multiplexer	SpaIot32MuxB
	The second multiplexer for the SpaIot controller (ESP32 version) More...

Multiplexer	SpaIotS3MuxA
	The first multiplexer for the SpaIot controller (ESP32S3 version) More...

Multiplexer	SpaIotS3MuxB
	The second multiplexer for the SpaIot controller (ESP32S3 version) More...

Detailed Description

SpaIot name space.

Enumeration Type Documentation

◆ Key

enum SpaIot::Key

LED and push buttons identification keys.

Enumerator
Power	Power Led or Button.
Filter	Filter Led or Button.
Bubble	Bubble Led or Button.
Jet	Jet Led or Button.
Sanitizer	Sanitizer Led or Button.
Heater	Heater Led (Red) or Button.
HeatReached	Heat Reached Led (Green)
TempUp	Temperature Up Button.
TempDown	Temperature Down Button.
TempUnit	Temperature Unity Button (°C/°F)

Function Documentation

◆ keyName()

const char* SpaIot::keyName ( int key )

inline

Association between keys and key names.

Parameters

key The key

Returns: The key name, "Unknown" if the key is not found

References KeyName.

Variable Documentation

◆ SpaIotPcf8574Mux

Pcf8574Mux SpaIot::SpaIotPcf8574Mux

extern

SpaIot buttons controller with PCF8574A.

may be accessed as "SpaIotPcf8574Mux" in the Multiplexer Register.

Classes

Enumerations

Functions