doxygen/out__relay_8h_source.html

#pragma once

#include "options.h"

#ifndef RELAY_DISABLE


#include <abstractout.h>

#include <item.h>


class out_relay : public abstractOut {

public:

    void link(Item * _item){abstractOut::link(_item); if (_item) getConfig();};

    void getConfig();

    void relay(bool state);

    int Setup() override;

    int Poll(short cause) override;

    int Stop() override;


    int getChanType() override;

    int Ctrl(itemCmd cmd, char* subItem=NULL, bool toExecute=true, bool authorized = false) override;


protected:

    short pin;

    bool inverted;

    uint32_t period;

};


#endif

abstractout.h

Item
A single LightHub item (virtual channel).
Definition item.h:232

abstractOut::abstractOut
abstractOut()
Definition abstractout.h:22

abstractOut::link
virtual void link(Item *_item)
Definition abstractout.h:24

itemCmd
Command + value container passed between items, drivers and MQTT.
Definition itemCmd.h:306

out_relay
Relay (ON/OFF output) driver (CH_RELAY = 6 / CH_RELAYX = 16).
Definition out_relay.h:27

out_relay::link
void link(Item *_item)
Attach to an item and read its pin/period configuration.
Definition out_relay.h:30

out_relay::Setup
int Setup() override
Initialize the pin (OUTPUT, inactive) and remember the state if the item is active.
Definition out_relay.cpp:34

out_relay::inverted
bool inverted
Definition out_relay.h:49

out_relay::period
uint32_t period
Definition out_relay.h:50

out_relay::Ctrl
int Ctrl(itemCmd cmd, char *subItem=NULL, bool toExecute=true, bool authorized=false) override
Handle /set (duration/turn-on) and /cmd (ON/OFF/TOGGLE/XON/XOFF/HALT/REST) commands.
Definition out_relay.cpp:104

out_relay::pin
short pin
Definition out_relay.h:48

out_relay::getChanType
int getChanType() override
Channel type of the driver.
Definition out_relay.cpp:186

out_relay::Poll
int Poll(short cause) override
For CH_RELAYX: toggle the relay on/off according to the configured period and /set value.
Definition out_relay.cpp:72

out_relay::getConfig
void getConfig()
Read pin and pulse period from the item arguments (negative pin = inverted).
Definition out_relay.cpp:12

out_relay::relay
void relay(bool state)
Physically switch the relay and publish the new action state.
Definition out_relay.cpp:61

out_relay::Stop
int Stop() override
Release the pin and mark the driver uninitialized.
Definition out_relay.cpp:53

item.h
Item (virtual channel) system of LightHub.

options.h