itemCmd.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 "Arduino.h"
#include "aJSON.h"
typedef char cmdstr[9];
const cmdstr commands_P[] PROGMEM =
{
"","ON","OFF","REST","TOGGLE","HALT","XON","XOFF","INCREASE","DECREASE",
"HEAT","COOL","AUTO","FAN_ONLY","DRY","STOP","HIGH","MEDIUM","LOW",
"TRUE","FALSE","ENABLED","DISABLED","RGB","HSV"
};
#define commandsNum sizeof(commands_P)/sizeof(cmdstr)
#define CMD_ON 1
#define CMD_OFF 2
#define CMD_RESTORE 3
#define CMD_TOGGLE 4
#define CMD_HALT 5
#define CMD_XON 6
#define CMD_XOFF 7
#define CMD_UP 8
#define CMD_DN 9
#define CMD_HEAT 0xa
#define CMD_COOL 0xb
#define CMD_AUTO 0xc
#define CMD_FAN 0xd
#define CMD_DRY 0xe
#define CMD_STOP 0xf
#define CMD_HIGH 0x10
#define CMD_MED 0x11
#define CMD_LOW 0x12
#define CMD_ENABLED 0x13
#define CMD_DISABLED 0x14
#define CMD_TRUE 0x15
#define CMD_FALSE 0x16
#define CMD_RGB 0x17
#define CMD_HSV 0x18
#define CMD_MASK 0xff
#define FLAG_MASK 0xff00
#define CMD_VOID 0
#define CMD_UNKNOWN -1
#define CMD_JSON -2
#define SEND_IMMEDIATE 0x1
#define SEND_COMMAND 0x100
#define SEND_PARAMETERS 0x200
#define SEND_RETRY 0x400
#define SEND_DEFFERED 0x800
#define SEND_DELAYED 0x1000
#define ACTION_NEEDED 0x2000
#define ACTION_IN_PROCESS 0x4000
int txt2cmd (char * payload);
#define ST_VOID 0
#define ST_PERCENTS255 1
#define ST_HSV255 2
#define ST_HS 3
#define ST_RGB 4
#define ST_RGBW 5
#define ST_TENS 6
#define ST_FLOAT 7
#define ST_FLOAT_CELSIUS 8
#define ST_FLOAT_FARENHEIT 9
#define ST_INT32 10
#define ST_UINT32 11
#define ST_STRING 12
//#define ST_TIMESTAMP 13
#define MAP_SCALE 1
#define MAP_VAL_CMD 2
#pragma pack(push, 1)
typedef union
{
long int aslong;
int32_t asInt32;
uint32_t asUint32;
struct
{
uint8_t cmdCode;
uint8_t suffixCode:4;
uint8_t itemArgType:4;
uint8_t cmdEffect; //Reserve
uint8_t cmdParam; //Reserve
};
} itemCmdStore;
typedef union
{
long int aslong;
int32_t asInt32;
uint32_t asUint32;
char* asString;
float asfloat;
struct
{ uint8_t v;
uint8_t s;
uint16_t h:9;
uint16_t colorTemp:7;
};
struct
{ int8_t signed_v;
int8_t signed_s;
int16_t signed_h:9;
int16_t signed_colorTemp:7;
};
struct //Should be NeoPixel packed Color compatible
{
uint8_t b;
uint8_t g;
uint8_t r;
uint8_t w;
};
} itemArgStore;
class Item;
class itemCmd
{
public:
itemCmdStore cmd;
itemArgStore param;
itemCmd(uint8_t _type=ST_VOID, uint8_t _code=CMD_VOID);
itemCmd(float val);
itemCmd(Item *item);
itemCmd assignFrom(itemCmd from, short chanType=-1);
bool loadItem(Item * item, uint16_t optionsFlag=SEND_PARAMETERS);
bool loadItemDef(Item * item, uint16_t optionsFlag=SEND_PARAMETERS );
bool saveItem(Item * item, uint16_t optionsFlag=SEND_PARAMETERS);
itemCmd Int(int32_t i);
itemCmd Int(uint32_t i);
itemCmd Float(float f);
itemCmd Tens(int32_t i);
itemCmd Cmd(uint8_t i);
itemCmd HSV(uint16_t h, uint8_t s, uint8_t v);
itemCmd HSV255(uint16_t h, uint8_t s, uint8_t v);
itemCmd HS(uint16_t h, uint8_t s);
itemCmd RGB(uint8_t r, uint8_t g, uint8_t b);
itemCmd RGBW(uint8_t r, uint8_t g, uint8_t b, uint8_t w);
itemCmd Str(char * str);
bool setH(uint16_t);
bool setS(uint8_t);
bool setColorTemp(int);
int getColorTemp();
uint16_t getH();
uint16_t getS();
itemCmd setArgType(uint8_t);
itemCmd convertTo(uint8_t);
uint8_t getStoragetypeByChanType(short chanType);
itemCmd Percents(int i);
itemCmd Percents255(int i);
uint8_t getSuffix();
itemCmd setSuffix(uint8_t suffix);
bool incrementPercents(int16_t);
bool incrementH(int16_t);
bool incrementS(int16_t);
long int getInt();
float getFloat();
char * getString();
long int getSingleInt();
short getPercents(bool inverse=false);
short getPercents255(bool inverse=false);
bool setPercents(int percents);
uint8_t getCmd();
uint8_t getArgType();
uint8_t getCmdParam();
char * toString(char * Buffer, int bufLen, int sendFlags = SEND_COMMAND | SEND_PARAMETERS, bool scale100 = false);
bool isCommand();
bool isValue();
bool isColor();
itemCmd setDefault();
itemCmd setChanType(short chanType);
void debugOut();
int doMapping(aJsonObject *mappingData);
int doReverseMapping (aJsonObject *mappingData);
int doMappingCmd(aJsonObject *mappingData);
int doReverseMappingCmd (aJsonObject *mappingData);
bool scale100();
};
#pragma pack(pop)
itemArgStore::asfloat
float asfloat
Definition: itemCmd.h:128
itemCmd::incrementPercents
bool incrementPercents(int16_t)
Definition: itemCmd.cpp:238
itemArgStore::s
uint8_t s
Definition: itemCmd.h:132
itemCmd::Percents255
itemCmd Percents255(int i)
Definition: itemCmd.cpp:835
itemArgStore
Definition: itemCmd.h:123
itemCmd
Definition: itemCmd.h:153
itemCmdStore::suffixCode
uint8_t suffixCode
Definition: itemCmd.h:114
itemCmdStore::cmdEffect
uint8_t cmdEffect
Definition: itemCmd.h:117
itemCmdStore::aslong
long int aslong
Definition: itemCmd.h:108
ST_VOID
#define ST_VOID
Definition of all possible types of argument, contained in class.
Definition: itemCmd.h:82
itemCmd::RGBW
itemCmd RGBW(uint8_t r, uint8_t g, uint8_t b, uint8_t w)
Definition: itemCmd.cpp:922
itemCmd::itemCmd
itemCmd(uint8_t _type=ST_VOID, uint8_t _code=CMD_VOID)
Constructor with definition of type and command.
Definition: itemCmd.cpp:46
itemCmd::param
itemArgStore param
Definition: itemCmd.h:156
itemArgStore::asString
char * asString
Definition: itemCmd.h:127
itemCmd::Str
itemCmd Str(char *str)
Definition: itemCmd.cpp:933
itemCmd::Cmd
itemCmd Cmd(uint8_t i)
Definition: itemCmd.cpp:941
itemCmd::doReverseMappingCmd
int doReverseMappingCmd(aJsonObject *mappingData)
Definition: itemCmd.cpp:1063
itemCmd::HSV255
itemCmd HSV255(uint16_t h, uint8_t s, uint8_t v)
Definition: itemCmd.cpp:891
itemCmd::getFloat
float getFloat()
Definition: itemCmd.cpp:672
CMD_VOID
#define CMD_VOID
Definition: itemCmd.h:63
itemCmdStore::itemArgType
uint8_t itemArgType
Definition: itemCmd.h:115
itemCmd::Float
itemCmd Float(float f)
Definition: itemCmd.cpp:867
itemArgStore::aslong
long int aslong
Definition: itemCmd.h:124
itemCmd::setDefault
itemCmd setDefault()
Definition: itemCmd.cpp:122
itemCmd::doMappingCmd
int doMappingCmd(aJsonObject *mappingData)
Definition: itemCmd.cpp:1058
itemArgStore::signed_colorTemp
int16_t signed_colorTemp
Definition: itemCmd.h:140
itemCmd::setS
bool setS(uint8_t)
Definition: itemCmd.cpp:161
itemArgStore::signed_h
int16_t signed_h
Definition: itemCmd.h:139
itemCmd::getS
uint16_t getS()
Definition: itemCmd.cpp:233
itemArgStore::h
uint16_t h
Definition: itemCmd.h:133
itemCmd::toString
char * toString(char *Buffer, int bufLen, int sendFlags=SEND_COMMAND|SEND_PARAMETERS, bool scale100=false)
Definition: itemCmd.cpp:1069
itemCmd::setChanType
itemCmd setChanType(short chanType)
Definition: itemCmd.cpp:83
itemCmdStore::asUint32
uint32_t asUint32
Definition: itemCmd.h:110
itemArgStore::asUint32
uint32_t asUint32
Definition: itemCmd.h:126
itemCmd::Percents
itemCmd Percents(int i)
Definition: itemCmd.cpp:818
b
#define b
Definition: item.cpp:1735
itemCmd::isValue
bool isValue()
Definition: itemCmd.cpp:619
itemCmd::isColor
bool isColor()
Definition: itemCmd.cpp:624
itemCmd::setH
bool setH(uint16_t)
Definition: itemCmd.cpp:141
itemCmd::getCmdParam
uint8_t getCmdParam()
Definition: itemCmd.cpp:812
itemCmd::convertTo
itemCmd convertTo(uint8_t)
Definition: itemCmd.cpp:802
itemCmd::debugOut
void debugOut()
Definition: itemCmd.cpp:1148
itemArgStore::signed_s
int8_t signed_s
Definition: itemCmd.h:138
itemCmd::setArgType
itemCmd setArgType(uint8_t)
Definition: itemCmd.cpp:795
itemCmd::loadItemDef
bool loadItemDef(Item *item, uint16_t optionsFlag=SEND_PARAMETERS)
Definition: itemCmd.cpp:999
itemCmd::setSuffix
itemCmd setSuffix(uint8_t suffix)
Definition: itemCmd.cpp:953
itemCmd::getPercents255
short getPercents255(bool inverse=false)
Definition: itemCmd.cpp:760
itemCmd::getString
char * getString()
Definition: itemCmd.cpp:660
cmdstr
char cmdstr[9]
Definition: itemCmd.h:24
itemCmd::doMapping
int doMapping(aJsonObject *mappingData)
Definition: itemCmd.cpp:1047
itemArgStore::signed_v
int8_t signed_v
Definition: itemCmd.h:137
itemArgStore::w
uint8_t w
Definition: itemCmd.h:147
itemCmd::cmd
itemCmdStore cmd
Definition: itemCmd.h:155
itemCmd::setPercents
bool setPercents(int percents)
Definition: itemCmd.cpp:737
itemArgStore::asInt32
int32_t asInt32
Definition: itemCmd.h:125
itemCmd::getCmd
uint8_t getCmd()
Definition: itemCmd.cpp:785
itemArgStore::r
uint8_t r
Definition: itemCmd.h:146
itemCmd::getStoragetypeByChanType
uint8_t getStoragetypeByChanType(short chanType)
Definition: itemCmd.cpp:91
itemCmd::getInt
long int getInt()
Definition: itemCmd.cpp:632
itemCmd::isCommand
bool isCommand()
Definition: itemCmd.cpp:614
itemCmd::saveItem
bool saveItem(Item *item, uint16_t optionsFlag=SEND_PARAMETERS)
Definition: itemCmd.cpp:1016
itemArgStore::colorTemp
uint16_t colorTemp
Definition: itemCmd.h:134
itemArgStore::v
uint8_t v
Definition: itemCmd.h:131
itemCmd::scale100
bool scale100()
Definition: itemCmd.cpp:1155
itemArgStore::g
uint8_t g
Definition: itemCmd.h:145
itemCmd::setColorTemp
bool setColorTemp(int)
Definition: itemCmd.cpp:183
SEND_COMMAND
#define SEND_COMMAND
Definition: itemCmd.h:68
itemCmd::getColorTemp
int getColorTemp()
Definition: itemCmd.cpp:212
txt2cmd
int txt2cmd(char *payload)
Definition: itemCmd.cpp:18
SEND_PARAMETERS
#define SEND_PARAMETERS
Definition: itemCmd.h:69
Item
Definition: item.h:104
itemCmd::assignFrom
itemCmd assignFrom(itemCmd from, short chanType=-1)
Definition: itemCmd.cpp:319
itemCmd::RGB
itemCmd RGB(uint8_t r, uint8_t g, uint8_t b)
Definition: itemCmd.cpp:912
itemCmd::getH
uint16_t getH()
Definition: itemCmd.cpp:228
PROGMEM
const cmdstr commands_P[] PROGMEM
Definition: itemCmd.h:26
itemCmdStore::cmdCode
uint8_t cmdCode
Definition: itemCmd.h:113
itemCmdStore::cmdParam
uint8_t cmdParam
Definition: itemCmd.h:118
itemCmd::Int
itemCmd Int(int32_t i)
Definition: itemCmd.cpp:853
itemCmd::Tens
itemCmd Tens(int32_t i)
Definition: itemCmd.cpp:874
itemCmd::getSuffix
uint8_t getSuffix()
Definition: itemCmd.cpp:948
itemCmd::getSingleInt
long int getSingleInt()
Definition: itemCmd.cpp:702
itemCmd::getArgType
uint8_t getArgType()
Definition: itemCmd.cpp:790
itemCmd::getPercents
short getPercents(bool inverse=false)
Definition: itemCmd.cpp:708
itemCmd::incrementS
bool incrementS(int16_t)
Definition: itemCmd.cpp:301
itemCmd::loadItem
bool loadItem(Item *item, uint16_t optionsFlag=SEND_PARAMETERS)
Definition: itemCmd.cpp:959
itemCmdStore
Definition: itemCmd.h:107
itemCmdStore::asInt32
int32_t asInt32
Definition: itemCmd.h:109
itemCmd::HS
itemCmd HS(uint16_t h, uint8_t s)
Definition: itemCmd.cpp:902
itemCmd::incrementH
bool incrementH(int16_t)
Definition: itemCmd.cpp:284
itemCmd::HSV
itemCmd HSV(uint16_t h, uint8_t s, uint8_t v)
Definition: itemCmd.cpp:881
itemCmd::doReverseMapping
int doReverseMapping(aJsonObject *mappingData)
Definition: itemCmd.cpp:1052
itemArgStore::b
uint8_t b
Definition: itemCmd.h:144