item.h
Go to the documentation of this file.
/* Copyright © 2017-2020 Andrey Klimov. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Homepage: http://lazyhome.ru
GIT: https://github.com/anklimov/lighthub
e-mail anklimov@gmail.com
*/
#pragma once
#include "options.h"
#include "abstractout.h"
#include "itemCmd.h"
#define S_NOTFOUND 0
//#define S_SETnCMD 0
#define S_CMD 1
#define S_SET 2
//#define S_ESET 4
#define S_HSV 5
#define S_RGB 6
#define S_FAN 7
#define S_MODE 8
#define S_HUE 9
#define S_SAT 10
#define S_TEMP 11
#define S_VAL 12
#define S_DELAYED 13
#define S_RAW 14
#define S_ADDITIONAL 14
#define CH_DIMMER 0 //DMX 1-4 ch
#define CH_RGBW 1 //DMX 4 ch
#define CH_RGB 2 //DMX 3 ch
#define CH_PWM 3 //PWM output directly to PIN 1-4 CH
#define CH_MODBUS 4 //Modbus AC Dimmer
#define CH_THERMO 5 //Simple ON/OFF thermostat
#define CH_RELAY 6 //ON_OFF relay output
#define CH_GROUP 7 //Group pseudochannel
#define CH_VCTEMP 8 //Vacom PID regulator
#define CH_VC 9 //Vacom modbus motor regulator
#define CH_AC 10 //AC Haier
#define CH_SPILED 11
#define CH_MOTOR 12
#define CH_PID 13
#define CH_MBUS 14
#define CH_UARTBRIDGE 15
#define CH_RELAYX 16
#define CH_RGBWW 17
#define CH_MULTIVENT 18
#define CH_ELEVATOR 19
//#define CHANNEL_TYPES 13
//static uint32_t pollInterval[CHANNEL_TYPES] = {0,0,0,0,MODB};
//static uint32_t nextPollTime[CHANNEL_TYPES] = {0,0,0,0,0,0,0,0,0,0,0,0,0};
#define CH_WHITE 127//
#define POLLING_SLOW 1
#define POLLING_FAST 2
#define POLLING_INT 3
#define I_TYPE 0 //Type of item
#define I_ARG 1 //Chanel-type depended argument or array of arguments (pin, address etc)
#define I_VAL 2 //Latest preset (int or array of presets)
#define I_CMD 3 //Latest CMD received
#define I_EXT 4 //Chanell-depended extension - array
#define I_TIMESTAMP 5
#define MODBUS_CMD_ARG_ADDR 0
#define MODBUS_CMD_ARG_REG 1
#define MODBUS_CMD_ARG_MASK 2
#define MODBUS_CMD_ARG_MAX_SCALE 3
#define MODBUS_CMD_ARG_REG_TYPE 4
#define MODBUS_COIL_REG_TYPE 0
#define MODBUS_DISCRETE_REG_TYPE 1
#define MODBUS_HOLDING_REG_TYPE 2
#define MODBUS_INPUT_REG_TYPE 3
#include "aJSON.h"
extern aJsonObject *items;
extern short thermoSetCurTemp(char *name, float t);
int txt2cmd (char * payload);
bool digGroup (aJsonObject *itemArr, itemCmd *cmd = NULL, char* subItem = NULL);
class Item
{
public:
aJsonObject *itemArr, *itemArg,*itemVal,*itemExt;
uint8_t itemType;
abstractOut * driver;
Item(char * name);
Item(aJsonObject * obj);
~Item();
boolean isValid ();
boolean Setup();
void Stop();
//int Ctrl(short cmd, short n=0, int * Parameters=NULL, int suffixCode=0, char* subItem=NULL);
int Ctrl(itemCmd cmd, char* subItem=NULL, bool allowRecursion = true);
int Ctrl(char * payload, char * subItem=NULL);
int getArg(short n=0);
float getFloatArg(short n=0);
short getArgCount();
//int getVal(short n); //From VAL array. Negative if no array
long int getVal(); //From int val OR array
uint8_t getSubtype();
uint8_t getCmd();
long int getExt(); //From int val OR array
void setExt(long int par);
chPersistent * getPersistent();
chPersistent * setPersistent(chPersistent * par);
void setCmd(uint8_t cmdValue);
short getFlag (short flag=FLAG_MASK);
void setFlag (short flag);
void clearFlag (short flag);
void setVal(long int par);
void setFloatVal(float par);
void setSubtype(uint8_t par);
int Poll(int cause);
int SendStatus(int sendFlags);
int SendStatusImmediate(itemCmd st, int sendFlags, char * subItem=NULL);
int isActive();
int getChanType();
inline int On (){return Ctrl(itemCmd(ST_VOID,CMD_ON));};
inline int Off(){return Ctrl(itemCmd(ST_VOID,CMD_OFF));};
inline int Toggle(){return Ctrl(itemCmd(ST_VOID,CMD_TOGGLE));};
protected:
int VacomSetFan (itemCmd st);
int VacomSetHeat(itemCmd st);
int modbusDimmerSet(itemCmd st);
int modbusDimmerSet(int addr, uint16_t _reg, int _regType, int _mask, uint16_t value);
void mb_fail(int result=0);
void Parse();
int checkModbusDimmer();
int checkModbusDimmer(int data);
int checkModbusRetry();
//boolean checkVCRetry();
//boolean checkHeatRetry();
void sendDelayedStatus();
bool resumeModbus();
int checkFM();
char defaultSubItem[10];
int defaultSuffixCode;
};
typedef union
{
struct
{
int16_t tempX100;
uint16_t timestamp16;
};
int32_t asint;
} thermostatStore;
Item::setCmd
void setCmd(uint8_t cmdValue)
Definition: item.cpp:286
Item::isValid
boolean isValid()
Definition: item.cpp:491
Item::getSubtype
uint8_t getSubtype()
Definition: item.cpp:392
Item::isActive
int isActive()
Definition: item.cpp:1192
Item::Toggle
int Toggle()
Definition: item.h:146
itemCmd.h
itemCmd
Definition: itemCmd.h:153
Item::Ctrl
int Ctrl(itemCmd cmd, char *subItem=NULL, bool allowRecursion=true)
Definition: item.cpp:693
Item::getArg
int getArg(short n=0)
Definition: item.cpp:329
ST_VOID
#define ST_VOID
Definition of all possible types of argument, contained in class.
Definition: itemCmd.h:82
thermostatStore::timestamp16
uint16_t timestamp16
Definition: item.h:178
Item::setPersistent
chPersistent * setPersistent(chPersistent *par)
Definition: item.cpp:471
chPersistent
Definition: abstractout.h:7
Item::~Item
~Item()
Definition: item.cpp:240
Item::setExt
void setExt(long int par)
Definition: item.cpp:448
Item::Parse
void Parse()
Definition: item.cpp:127
Item::getVal
long int getVal()
Definition: item.cpp:381
Item::Off
int Off()
Definition: item.h:145
FLAG_MASK
#define FLAG_MASK
Definition: itemCmd.h:61
options.h
abstractOut
Definition: abstractout.h:8
Item::SendStatus
int SendStatus(int sendFlags)
Definition: item.cpp:1346
items
aJsonObject * items
Definition: main.cpp:92
Item::getChanType
int getChanType()
Definition: item.cpp:1526
Item::clearFlag
void clearFlag(short flag)
Definition: item.cpp:318
thermostatStore
Definition: item.h:174
Item::defaultSubItem
char defaultSubItem[10]
Definition: item.h:168
CMD_OFF
#define CMD_OFF
Definition: itemCmd.h:36
Item::Setup
boolean Setup()
Definition: item.cpp:215
Item::modbusDimmerSet
int modbusDimmerSet(itemCmd st)
Definition: item.cpp:1659
Item::setSubtype
void setSubtype(uint8_t par)
Definition: item.cpp:430
thermostatStore::asint
int32_t asint
Definition: item.h:180
CMD_TOGGLE
#define CMD_TOGGLE
Definition: itemCmd.h:38
Item::defaultSuffixCode
int defaultSuffixCode
Definition: item.h:169
Item::getCmd
uint8_t getCmd()
Definition: item.cpp:278
Item::Stop
void Stop()
Definition: item.cpp:231
Item::checkModbusDimmer
int checkModbusDimmer()
Definition: item.cpp:1954
Item::itemType
uint8_t itemType
Definition: item.h:107
txt2cmd
int txt2cmd(char *payload)
Definition: itemCmd.cpp:18
Item::getPersistent
chPersistent * getPersistent()
Definition: item.cpp:464
CMD_ON
#define CMD_ON
Definition of Commands.
Definition: itemCmd.h:35
thermostatStore::tempX100
int16_t tempX100
Definition: item.h:177
Item::checkModbusRetry
int checkModbusRetry()
Definition: item.cpp:1552
Item::mb_fail
void mb_fail(int result=0)
Definition: item.cpp:1534
Item::itemVal
aJsonObject * itemVal
Definition: item.h:106
Item::checkFM
int checkFM()
Definition: item.cpp:1843
Item::itemExt
aJsonObject * itemExt
Definition: item.h:106
Item::sendDelayedStatus
void sendDelayedStatus()
Definition: item.cpp:1335
thermoSetCurTemp
short thermoSetCurTemp(char *name, float t)
Item::setFloatVal
void setFloatVal(float par)
Definition: item.cpp:422
Item
Definition: item.h:104
Item::itemArg
aJsonObject * itemArg
Definition: item.h:106
Item::getFlag
short getFlag(short flag=FLAG_MASK)
Definition: item.cpp:296
digGroup
bool digGroup(aJsonObject *itemArr, itemCmd *cmd=NULL, char *subItem=NULL)
Definition: item.cpp:653
Item::resumeModbus
bool resumeModbus()
Definition: item.cpp:1591
Item::SendStatusImmediate
int SendStatusImmediate(itemCmd st, int sendFlags, char *subItem=NULL)
Definition: item.cpp:1363
abstractout.h
Item::On
int On()
Definition: item.h:144
Item::VacomSetHeat
int VacomSetHeat(itemCmd st)
move to float todo
Definition: item.cpp:1738
Item::getFloatArg
float getFloatArg(short n=0)
Definition: item.cpp:340
Item::VacomSetFan
int VacomSetFan(itemCmd st)
Definition: item.cpp:1690
data
byte data[37]
Definition: out_ac.cpp:31
Item::setFlag
void setFlag(short flag)
Definition: item.cpp:306
Item::driver
abstractOut * driver
Definition: item.h:108
Item::Poll
int Poll(int cause)
Definition: item.cpp:1262
Item::setVal
void setVal(long int par)
Definition: item.cpp:414
Item::getExt
long int getExt()
Definition: item.cpp:437
Item::Item
Item(char *name)
Definition: item.cpp:248
Item::getArgCount
short getArgCount()
Definition: item.cpp:361
Item::itemArr
aJsonObject * itemArr
Definition: item.h:106