Open RTS
Full implementation of the Somfy RTS protocol
Loading...
Searching...
No Matches
Related Symbols
rts_remote_store Struct Reference
Open RTS C Library

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

#include <rts_remote_store.h>

Inherited by RTSRemoteStore [protected].

Related Symbols

(Note that these are not member symbols.)

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.

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