controller-legacy/include/models/relay.h

65 lines
1.2 KiB
C
Raw Normal View History

2019-11-15 00:23:43 +00:00
#ifndef CONTROLLER_RELAY_H
#define CONTROLLER_RELAY_H
#include <stdint.h>
2020-04-13 22:50:55 +00:00
#include <time.h>
#include <lmdb.h>
2019-11-15 00:23:43 +00:00
2020-04-16 23:38:25 +00:00
#include <constants.h>
2020-04-13 22:50:55 +00:00
#include <models/schedule.h>
2019-11-15 00:23:43 +00:00
2020-04-13 22:50:55 +00:00
typedef struct
{
uint8_t number;
char name[MAX_NAME_LENGTH + 1];
schedule_t *schedule;
} relay_t;
2019-11-15 00:23:43 +00:00
2020-04-13 22:50:55 +00:00
/**
* @brief Key to save relay information in database
*/
typedef enum
{
DB_KEY_RELAY_NAME = 0,
DB_KEY_RELAY_SCHEDULE_ID = 1,
DB_KEY_RELAY_SCHEDULE_PERIODS = 2,
} db_key_relay_e;
relay_t*
relay_create(uint8_t number);
void
2020-04-23 23:33:48 +00:00
relay_set_name(relay_t *relay, const char *name);
2020-04-13 22:50:55 +00:00
/**
* @brief Load a relay for database or create a new one
*
* @param mdb_env An opened MDB_env to load from
*
* @return A loaded or new instance of relay
*/
relay_t*
relay_load(MDB_env *mdb_env, uint8_t num);
/**
* @brief Save a relay to the database
*
* @param relay Instance of a relay
* @param mdb_env Already created MDB_env
*
* @return Indicator to show success (0) or failure (!0)
*/
int
relay_save(relay_t *relay, MDB_env *mdb_env);
int
relay_is_active(relay_t *relay, time_t timestamp_now);
void
relay_free(relay_t *relay);
void
relay_debug(relay_t *relay);
2019-11-15 00:23:43 +00:00
#endif //CONTROLLER_RELAY_H