RTSRemoteStore Class Reference

Provides an interface for a datastore which contains details about remote controls and rolling codes. More...

#include <RTSRemoteStore.hpp>

Inherits rts_remote_store.

Inherited by RTSRemoteStore_EEPROM, RTSRemoteStore_MMap, RTSRemoteStore_Memory, and RTSRemoteStore_NVS.

Public Member Functions
void	setCode (uint32_t remoteAddress, uint16_t rollingCode)
	Set the rolling code for this remote, create if doesn't exist.
uint16_t	getCode (uint32_t remoteAddress)
	Get the rolling code for this remote.
uint16_t	nextCode (uint32_t remoteAddress)
	Get the rolling code for this remote, then increment and persist.
bool	knownRemote (uint32_t remoteAddress)
	Check if this is a known remote address.
void	forget (uint32_t remoteAddress)
	Forget a specific remote.
void	clear ()
	Clear all remotes and rolling codes.

Friends
class	RTSRemote
class	RTSReceiver

Additional Inherited Members
Related Symbols inherited from rts_remote_store
void	rts_remote_store_init_nvs (struct rts_remote_store *store)
	Initialize an rts_remote_store which stores remotes and rolling codes in ESP-IDF's NVS (Non-volatile storage) on ESP8266 and ESP32 devices.
void	rts_remote_store_init_mmap (struct rts_remote_store *store, const char *filename)
	Initialize an rts_remote_store which stores remotes and rolling codes in a memory-mapped file on POSIX systems.
void	rts_remote_store_set_code (struct rts_remote_store *store, uint32_t remote_address, uint16_t rolling_code)
	Set the rolling code for this remote, create if doesn't exist.
uint16_t	rts_remote_store_get_code (struct rts_remote_store *store, uint32_t remote_address)
	Get the rolling code for this remote.
uint16_t	rts_remote_store_next_code (struct rts_remote_store *store, uint32_t remote_address)
	Get the rolling code for this remote, then increment and persist.
bool	rts_remote_store_known_remote (struct rts_remote_store *store, uint32_t remote_address)
	Check if this is a known remote address.
void	rts_remote_store_forget (struct rts_remote_store *store, uint32_t remote_address)
	Forget a specific remote.
void	rts_remote_store_clear (struct rts_remote_store *store)
	Clear all remotes and rolling codes.
void	rts_remote_store_close (struct rts_remote_store *store)
	Close and free any resources allocated via a previous call to rts_remote_store_init*()
void	rts_remote_store_init_memory (struct rts_remote_store *store)
	Initialize an rts_remote_store which stores remotes and rolling codes in memory.

Detailed Description

Provides an interface for a datastore which contains details about remote controls and rolling codes.

Implementations must define the get_code, set_code, forget, and clear functions and set the function pointers in the rts_remote_store struct.

Member Function Documentation

setCode()

void RTSRemoteStore::setCode	(	uint32_t	remoteAddress,
		uint16_t	rollingCode
	)

Set the rolling code for this remote, create if doesn't exist.

Parameters

remoteAddress	the address of the remote control
rollingCode	the rolling code to set

getCode()

uint16_t RTSRemoteStore::getCode

(

uint32_t

remoteAddress

)

Get the rolling code for this remote.

Parameters

remoteAddress

the address of the remote control

Returns

the rolling code for this remote

nextCode()

uint16_t RTSRemoteStore::nextCode

(

uint32_t

remoteAddress

)

Get the rolling code for this remote, then increment and persist.

Parameters

remoteAddress

the address of the remote control

Returns

the rolling code for this remote

knownRemote()

bool RTSRemoteStore::knownRemote

(

uint32_t

remoteAddress

)

Check if this is a known remote address.

Parameters

remoteAddress

the address of the remote control

forget()

void RTSRemoteStore::forget

(

uint32_t

remoteAddress

)

Forget a specific remote.

Parameters

remoteAddress

the address of the remote control to forget

---

The documentation for this class was generated from the following files:

• src/openrtsxx/RTSRemoteStore.hpp
• src/openrtsxx/RTSRemoteStore.cpp