You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
85 lines
2.1 KiB
85 lines
2.1 KiB
/*
|
|
|
|
RELAY MODULE
|
|
|
|
Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
|
|
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <Arduino.h>
|
|
|
|
#include <cstdint>
|
|
#include <memory>
|
|
|
|
#include "system.h"
|
|
#include "rpc.h"
|
|
|
|
constexpr size_t RelaysMax { 32ul };
|
|
|
|
class RelayProviderBase {
|
|
public:
|
|
RelayProviderBase() = default;
|
|
virtual ~RelayProviderBase();
|
|
|
|
// whether the provider is ready
|
|
virtual bool setup();
|
|
|
|
// status requested at boot
|
|
virtual void boot(bool status);
|
|
|
|
// when 'status' was requested, but target status remains the same or is canceled
|
|
virtual void notify(bool status);
|
|
|
|
// when relay 'status' is changed from target to current
|
|
virtual void change(bool status) = 0;
|
|
|
|
// unique id of the provider
|
|
virtual espurna::StringView id() const = 0;
|
|
};
|
|
|
|
PayloadStatus relayParsePayload(espurna::StringView);
|
|
|
|
bool relayStatus(size_t id, bool status, bool report, bool group_report);
|
|
bool relayStatus(size_t id, bool status);
|
|
|
|
// gets either current or target status, where current is the status that we are
|
|
// actually in and target is the status we would be, eventually, unless
|
|
// relayStatus(id, relayStatus()) is called
|
|
bool relayStatus(size_t id);
|
|
bool relayStatusTarget(size_t id);
|
|
|
|
void relayToggle(size_t id, bool report, bool group_report);
|
|
void relayToggle(size_t id);
|
|
|
|
size_t relayCount();
|
|
|
|
espurna::StringView relayPayloadOn();
|
|
espurna::StringView relayPayloadOff();
|
|
espurna::StringView relayPayloadToggle();
|
|
|
|
espurna::StringView relayPayload(PayloadStatus status);
|
|
|
|
void relayPulse(size_t id, espurna::duration::Milliseconds, bool);
|
|
void relayPulse(size_t id, espurna::duration::Milliseconds);
|
|
void relayPulse(size_t id);
|
|
void relaySave(bool persist);
|
|
|
|
using RelayStatusCallback = void(*)(size_t id, bool status);
|
|
using RelayProviderBasePtr = std::unique_ptr<RelayProviderBase>;
|
|
|
|
struct RelayAddResult {
|
|
size_t id { RelaysMax };
|
|
|
|
explicit operator bool() const {
|
|
return id != RelaysMax;
|
|
}
|
|
};
|
|
|
|
RelayAddResult relayAdd(RelayProviderBasePtr&& provider);
|
|
void relayOnStatusNotify(RelayStatusCallback);
|
|
void relayOnStatusChange(RelayStatusCallback);
|
|
|
|
void relaySetupDummy(size_t size, bool reconfigure = false);
|
|
void relaySetup();
|