2019-08-31 20:23:32 +01:00
/*
2019-10-27 10:13:24 +00:00
xdrv_23_zigbee . ino - zigbee support for Tasmota
2019-08-31 20:23:32 +01:00
2019-12-31 13:23:34 +00:00
Copyright ( C ) 2020 Theo Arends and Stephan Hadinger
2019-08-31 20:23:32 +01:00
This program is free software : you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation , either version 3 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU General Public License for more details .
You should have received a copy of the GNU General Public License
along with this program . If not , see < http : //www.gnu.org/licenses/>.
*/
# ifdef USE_ZIGBEE
# define XDRV_23 23
2020-01-25 16:42:53 +00:00
const char kZbCommands [ ] PROGMEM = D_PRFX_ZB " | " // prefix
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
D_CMND_ZIGBEEZNPSEND " | " D_CMND_ZIGBEEZNPRECEIVE " | "
# endif // USE_ZIGBEE_ZNP
# ifdef USE_ZIGBEE_EZSP
D_CMND_ZIGBEE_EZSP_SEND " | " D_CMND_ZIGBEE_EZSP_RECEIVE " | "
# endif // USE_ZIGBEE_EZSP
D_CMND_ZIGBEE_PERMITJOIN " | "
D_CMND_ZIGBEE_STATUS " | " D_CMND_ZIGBEE_RESET " | " D_CMND_ZIGBEE_SEND " | " D_CMND_ZIGBEE_PROBE " | "
2020-03-01 10:25:59 +00:00
D_CMND_ZIGBEE_FORGET " | " D_CMND_ZIGBEE_SAVE " | " D_CMND_ZIGBEE_NAME " | "
2020-03-26 19:58:59 +00:00
D_CMND_ZIGBEE_BIND " | " D_CMND_ZIGBEE_UNBIND " | " D_CMND_ZIGBEE_PING " | " D_CMND_ZIGBEE_MODELID " | "
2020-04-11 17:50:46 +01:00
D_CMND_ZIGBEE_LIGHT " | " D_CMND_ZIGBEE_RESTORE " | " D_CMND_ZIGBEE_BIND_STATE " | "
D_CMND_ZIGBEE_CONFIG
2020-03-01 10:25:59 +00:00
;
2019-08-31 20:23:32 +01:00
2019-11-24 11:24:35 +00:00
void ( * const ZigbeeCommand [ ] ) ( void ) PROGMEM = {
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
& CmndZbZNPSend , & CmndZbZNPReceive ,
# endif // USE_ZIGBEE_ZNP
# ifdef USE_ZIGBEE_EZSP
& CmndZbEZSPSend , & CmndZbEZSPReceive ,
# endif // USE_ZIGBEE_EZSP
& CmndZbPermitJoin ,
& CmndZbStatus , & CmndZbReset , & CmndZbSend , & CmndZbProbe ,
2020-03-01 10:25:59 +00:00
& CmndZbForget , & CmndZbSave , & CmndZbName ,
2020-03-26 19:58:59 +00:00
& CmndZbBind , & CmndZbUnbind , & CmndZbPing , & CmndZbModelId ,
2020-03-30 18:23:06 +01:00
& CmndZbLight , & CmndZbRestore , & CmndZbBindState ,
2020-04-11 17:50:46 +01:00
& CmndZbConfig ,
2019-12-23 15:53:54 +00:00
} ;
2019-08-31 20:23:32 +01:00
/********************************************************************************************/
2020-03-23 21:46:26 +00:00
// Initialize internal structures
2019-08-31 20:23:32 +01:00
void ZigbeeInit ( void )
{
2020-05-17 17:33:42 +01:00
// Check if settings in Flash are set
2020-04-11 17:50:46 +01:00
if ( 0 = = Settings . zb_channel ) {
AddLog_P2 ( LOG_LEVEL_INFO , PSTR ( D_LOG_ZIGBEE " Initializing Zigbee parameters from defaults " ) ) ;
Settings . zb_ext_panid = USE_ZIGBEE_EXTPANID ;
Settings . zb_precfgkey_l = USE_ZIGBEE_PRECFGKEY_L ;
Settings . zb_precfgkey_h = USE_ZIGBEE_PRECFGKEY_H ;
Settings . zb_pan_id = USE_ZIGBEE_PANID ;
Settings . zb_channel = USE_ZIGBEE_CHANNEL ;
Settings . zb_free_byte = 0 ;
}
// update commands with the current settings
Z_UpdateConfig ( Settings . zb_channel , Settings . zb_pan_id , Settings . zb_ext_panid , Settings . zb_precfgkey_l , Settings . zb_precfgkey_h ) ;
2020-06-19 19:54:37 +01:00
ZigbeeInitSerial ( ) ;
2019-08-31 20:23:32 +01:00
}
/*********************************************************************************************\
* Commands
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2019-12-12 21:22:34 +00:00
uint32_t strToUInt ( const JsonVariant & val ) {
2019-10-13 11:56:52 +01:00
// if the string starts with 0x, it is considered Hex, otherwise it is an int
if ( val . is < unsigned int > ( ) ) {
return val . as < unsigned int > ( ) ;
} else {
2019-12-12 21:22:34 +00:00
if ( val . is < const char * > ( ) ) {
String sval = val . as < String > ( ) ;
return strtoull ( sval . c_str ( ) , nullptr , 0 ) ;
2019-10-13 11:56:52 +01:00
}
}
return 0 ; // couldn't parse anything
}
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
2020-03-23 21:46:26 +00:00
// Do a factory reset of the CC2530
2019-11-24 11:24:35 +00:00
const unsigned char ZIGBEE_FACTORY_RESET [ ] PROGMEM =
2019-11-03 11:41:44 +00:00
{ Z_SREQ | Z_SAPI , SAPI_WRITE_CONFIGURATION , CONF_STARTUP_OPTION , 0x01 /* len */ , 0x01 /* STARTOPT_CLEAR_CONFIG */ } ;
//"2605030101"; // Z_SREQ | Z_SAPI, SAPI_WRITE_CONFIGURATION, CONF_STARTUP_OPTION, 0x01 len, 0x01 STARTOPT_CLEAR_CONFIG
2020-06-16 19:01:14 +01:00
# endif // USE_ZIGBEE_ZNP
2020-02-02 19:53:49 +00:00
void CmndZbReset ( void ) {
2019-10-13 11:56:52 +01:00
if ( ZigbeeSerial ) {
switch ( XdrvMailbox . payload ) {
case 1 :
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
2019-10-13 11:56:52 +01:00
ZigbeeZNPSend ( ZIGBEE_FACTORY_RESET , sizeof ( ZIGBEE_FACTORY_RESET ) ) ;
2020-06-16 19:01:14 +01:00
# endif // USE_ZIGBEE_ZNP
2020-01-17 23:02:01 +00:00
eraseZigbeeDevices ( ) ;
2019-10-13 11:56:52 +01:00
restart_flag = 2 ;
2020-03-16 17:55:58 +00:00
ResponseCmndChar_P ( PSTR ( D_JSON_ZIGBEE_CC2530 " " D_JSON_RESET_AND_RESTARTING ) ) ;
2019-10-13 11:56:52 +01:00
break ;
default :
2020-03-16 17:55:58 +00:00
ResponseCmndChar_P ( PSTR ( D_JSON_ONE_TO_RESET ) ) ;
2019-10-13 11:56:52 +01:00
}
}
}
2020-03-23 21:46:26 +00:00
/********************************************************************************************/
2020-04-22 15:07:52 +01:00
//
2020-03-23 21:46:26 +00:00
// High-level function
// Send a command specified as an HEX string for the workload.
// The target endpoint is computed if zero, i.e. sent to the first known endpoint of the device.
// If cluster-specific, a timer may be set calling `zigbeeSetCommandTimer()`, for ex to coalesce attributes or Aqara presence sensor
//
// Inputs:
// - shortaddr: 16-bits short address, or 0x0000 if group address
// - groupaddr: 16-bits group address, or 0x0000 if unicast using shortaddr
// - endpoint: 8-bits target endpoint (source is always 0x01), if 0x00, it will be guessed from ZbStatus information (basically the first endpoint of the device)
// - clusterSpecific: boolean, is the message general cluster or cluster specific, used to create the FC byte of ZCL
// - clusterIf: 16-bits cluster number
// - param: pointer to HEX string for payload, should not be nullptr
// Returns: None
//
2020-03-30 18:23:06 +01:00
void zigbeeZCLSendStr ( uint16_t shortaddr , uint16_t groupaddr , uint8_t endpoint , bool clusterSpecific , uint16_t manuf ,
2020-02-23 15:46:00 +00:00
uint16_t cluster , uint8_t cmd , const char * param ) {
size_t size = param ? strlen ( param ) : 0 ;
2019-10-13 11:56:52 +01:00
SBuffer buf ( ( size + 2 ) / 2 ) ; // actual bytes buffer for data
2020-02-23 15:46:00 +00:00
if ( param ) {
while ( * param ) {
uint8_t code = parseHex_P ( & param , 2 ) ;
buf . add8 ( code ) ;
}
2019-10-13 11:56:52 +01:00
}
2020-05-17 17:33:42 +01:00
if ( ( 0 = = endpoint ) & & ( BAD_SHORTADDR ! = shortaddr ) ) {
2020-03-14 13:17:30 +00:00
// endpoint is not specified, let's try to find it from shortAddr, unless it's a group address
2020-03-17 17:46:05 +00:00
endpoint = zigbee_devices . findFirstEndpoint ( shortaddr ) ;
2020-03-23 21:46:26 +00:00
//AddLog_P2(LOG_LEVEL_DEBUG, PSTR("ZbSend: guessing endpoint 0x%02X"), endpoint);
2019-10-13 11:56:52 +01:00
}
2020-03-14 13:17:30 +00:00
AddLog_P2 ( LOG_LEVEL_DEBUG , PSTR ( " ZbSend: shortaddr 0x%04X, groupaddr 0x%04X, cluster 0x%04X, endpoint 0x%02X, cmd 0x%02X, data %s " ) ,
shortaddr , groupaddr , cluster , endpoint , cmd , param ) ;
2019-10-13 11:56:52 +01:00
2020-05-17 17:33:42 +01:00
if ( ( 0 = = endpoint ) & & ( BAD_SHORTADDR ! = shortaddr ) ) { // endpoint null is ok for group address
2020-01-25 16:42:53 +00:00
AddLog_P2 ( LOG_LEVEL_INFO , PSTR ( " ZbSend: unspecified endpoint " ) ) ;
2019-10-13 11:56:52 +01:00
return ;
2020-03-23 21:46:26 +00:00
}
2019-10-13 11:56:52 +01:00
// everything is good, we can send the command
2020-03-30 18:23:06 +01:00
ZigbeeZCLSend_Raw ( shortaddr , groupaddr , cluster , endpoint , cmd , clusterSpecific , manuf , buf . getBuffer ( ) , buf . len ( ) , true , zigbee_devices . getNextSeqNumber ( shortaddr ) ) ;
2019-12-15 15:02:41 +00:00
// now set the timer, if any, to read back the state later
if ( clusterSpecific ) {
2020-03-14 13:17:30 +00:00
zigbeeSetCommandTimer ( shortaddr , groupaddr , cluster , endpoint ) ;
2019-12-15 15:02:41 +00:00
}
2019-10-13 11:56:52 +01:00
}
2020-06-03 21:39:04 +01:00
// Parse "Report", "Write" or "Response" attribute
// Operation is one of: ZCL_REPORT_ATTRIBUTES (0x0A), ZCL_WRITE_ATTRIBUTES (0x02) or ZCL_READ_ATTRIBUTES_RESPONSE (0x01)
void ZbSendReportWrite ( const JsonObject & val_pubwrite , uint16_t device , uint16_t groupaddr , uint16_t cluster , uint8_t endpoint , uint16_t manuf , uint32_t operation ) {
2020-05-29 21:52:45 +01:00
SBuffer buf ( 200 ) ; // buffer to store the binary output of attibutes
2020-06-03 21:39:04 +01:00
if ( nullptr = = XdrvMailbox . command ) {
XdrvMailbox . command = ( char * ) " " ; // prevent a crash when calling ReponseCmndChar and there was no previous command
}
2020-05-29 21:52:45 +01:00
// iterate on keys
2020-06-03 21:39:04 +01:00
for ( JsonObject : : const_iterator it = val_pubwrite . begin ( ) ; it ! = val_pubwrite . end ( ) ; + + it ) {
2020-05-29 21:52:45 +01:00
const char * key = it - > key ;
const JsonVariant & value = it - > value ;
uint16_t attr_id = 0xFFFF ;
uint16_t cluster_id = 0xFFFF ;
uint8_t type_id = Znodata ;
2020-06-03 21:39:04 +01:00
int16_t multiplier = 1 ; // multiplier to adjust the key value
float val_f = 0.0f ; // alternative value if multiplier is used
2020-05-29 21:52:45 +01:00
// check if the name has the format "XXXX/YYYY" where XXXX is the cluster, YYYY the attribute id
// alternative "XXXX/YYYY%ZZ" where ZZ is the type (for unregistered attributes)
char * delimiter = strchr ( key , ' / ' ) ;
char * delimiter2 = strchr ( key , ' % ' ) ;
if ( delimiter ) {
cluster_id = strtoul ( key , & delimiter , 16 ) ;
if ( ! delimiter2 ) {
attr_id = strtoul ( delimiter + 1 , nullptr , 16 ) ;
} else {
attr_id = strtoul ( delimiter + 1 , & delimiter2 , 16 ) ;
type_id = strtoul ( delimiter2 + 1 , nullptr , 16 ) ;
}
}
// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("cluster_id = 0x%04X, attr_id = 0x%04X"), cluster_id, attr_id);
// do we already know the type, i.e. attribute and cluster are also known
if ( Znodata = = type_id ) {
// scan attributes to find by name, and retrieve type
for ( uint32_t i = 0 ; i < ARRAY_SIZE ( Z_PostProcess ) ; i + + ) {
const Z_AttributeConverter * converter = & Z_PostProcess [ i ] ;
bool match = false ;
uint16_t local_attr_id = pgm_read_word ( & converter - > attribute ) ;
uint16_t local_cluster_id = CxToCluster ( pgm_read_byte ( & converter - > cluster_short ) ) ;
uint8_t local_type_id = pgm_read_byte ( & converter - > type ) ;
2020-06-03 21:39:04 +01:00
int16_t local_multiplier = pgm_read_word ( & converter - > multiplier ) ;
2020-05-29 21:52:45 +01:00
// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("Try cluster = 0x%04X, attr = 0x%04X, type_id = 0x%02X"), local_cluster_id, local_attr_id, local_type_id);
if ( delimiter ) {
if ( ( cluster_id = = local_cluster_id ) & & ( attr_id = = local_attr_id ) ) {
type_id = local_type_id ;
break ;
}
} else if ( converter - > name ) {
// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("Comparing '%s' with '%s'"), attr_name, converter->name);
if ( 0 = = strcasecmp_P ( key , converter - > name ) ) {
// match
cluster_id = local_cluster_id ;
attr_id = local_attr_id ;
type_id = local_type_id ;
2020-06-03 21:39:04 +01:00
multiplier = local_multiplier ;
2020-05-29 21:52:45 +01:00
break ;
}
}
}
}
2020-06-03 21:39:04 +01:00
// Buffer ready, do some sanity checks
2020-05-29 21:52:45 +01:00
// AddLog_P2(LOG_LEVEL_DEBUG, PSTR("cluster_id = 0x%04X, attr_id = 0x%04X, type_id = 0x%02X"), cluster_id, attr_id, type_id);
if ( ( 0xFFFF = = attr_id ) | | ( 0xFFFF = = cluster_id ) ) {
Response_P ( PSTR ( " { \" %s \" : \" %s'%s' \" } " ) , XdrvMailbox . command , PSTR ( " Unknown attribute " ) , key ) ;
return ;
}
if ( Znodata = = type_id ) {
Response_P ( PSTR ( " { \" %s \" : \" %s'%s' \" } " ) , XdrvMailbox . command , PSTR ( " Unknown attribute type for attribute " ) , key ) ;
return ;
}
if ( 0xFFFF = = cluster ) {
cluster = cluster_id ; // set the cluster for this packet
} else if ( cluster ! = cluster_id ) {
ResponseCmndChar_P ( PSTR ( " No more than one cluster id per command " ) ) ;
return ;
}
2020-06-03 21:39:04 +01:00
// apply multiplier if needed
bool use_val = true ;
if ( ( 0 ! = multiplier ) & & ( 1 ! = multiplier ) ) {
val_f = value ;
if ( multiplier > 0 ) { // inverse of decoding
val_f = val_f / multiplier ;
} else {
2020-06-05 17:24:31 +01:00
val_f = val_f * ( - multiplier ) ;
2020-06-03 21:39:04 +01:00
}
use_val = false ;
}
2020-05-29 21:52:45 +01:00
// push the value in the buffer
2020-06-03 21:39:04 +01:00
int32_t res = encodeSingleAttribute ( buf , use_val ? value : * ( const JsonVariant * ) nullptr , val_f , attr_id , type_id , operation = = ZCL_READ_ATTRIBUTES_RESPONSE ) ; // force status if Reponse
2020-05-29 21:52:45 +01:00
if ( res < 0 ) {
Response_P ( PSTR ( " { \" %s \" : \" %s'%s' 0x%02X \" } " ) , XdrvMailbox . command , PSTR ( " Unsupported attribute type " ) , key , type_id ) ;
return ;
}
}
// did we have any attribute?
if ( 0 = = buf . len ( ) ) {
ResponseCmndChar_P ( PSTR ( " No attribute in list " ) ) ;
return ;
}
// all good, send the packet
2020-06-03 21:39:04 +01:00
ZigbeeZCLSend_Raw ( device , groupaddr , cluster , endpoint , operation , false /* not cluster specific */ , manuf , buf . getBuffer ( ) , buf . len ( ) , false /* noresponse */ , zigbee_devices . getNextSeqNumber ( device ) ) ;
2020-05-29 21:52:45 +01:00
ResponseCmndDone ( ) ;
}
// Parse the "Send" attribute and send the command
void ZbSendSend ( const JsonVariant & val_cmd , uint16_t device , uint16_t groupaddr , uint16_t cluster , uint8_t endpoint , uint16_t manuf ) {
uint8_t cmd = 0 ;
String cmd_str = " " ; // the actual low-level command, either specified or computed
const char * cmd_s ; // pointer to payload string
bool clusterSpecific = true ;
static char delim [ ] = " , " ; // delimiters for parameters
// probe the type of the argument
// If JSON object, it's high level commands
// If String, it's a low level command
if ( val_cmd . is < JsonObject > ( ) ) {
// we have a high-level command
const JsonObject & cmd_obj = val_cmd . as < const JsonObject & > ( ) ;
int32_t cmd_size = cmd_obj . size ( ) ;
if ( cmd_size > 1 ) {
Response_P ( PSTR ( " Only 1 command allowed (%d) " ) , cmd_size ) ;
return ;
} else if ( 1 = = cmd_size ) {
// We have exactly 1 command, parse it
JsonObject : : const_iterator it = cmd_obj . begin ( ) ; // just get the first key/value
String key = it - > key ;
const JsonVariant & value = it - > value ;
uint32_t x = 0 , y = 0 , z = 0 ;
uint16_t cmd_var ;
2020-06-03 21:39:04 +01:00
uint16_t local_cluster_id ;
2020-05-29 21:52:45 +01:00
2020-06-03 21:39:04 +01:00
const __FlashStringHelper * tasmota_cmd = zigbeeFindCommand ( key . c_str ( ) , & local_cluster_id , & cmd_var ) ;
2020-05-29 21:52:45 +01:00
if ( tasmota_cmd ) {
cmd_str = tasmota_cmd ;
} else {
Response_P ( PSTR ( " Unrecognized zigbee command: %s " ) , key . c_str ( ) ) ;
return ;
}
2020-06-03 21:39:04 +01:00
// check cluster
if ( 0xFFFF = = cluster ) {
cluster = local_cluster_id ;
} else if ( cluster ! = local_cluster_id ) {
ResponseCmndChar_P ( PSTR ( " No more than one cluster id per command " ) ) ;
return ;
}
2020-05-29 21:52:45 +01:00
// parse the JSON value, depending on its type fill in x,y,z
if ( value . is < bool > ( ) ) {
x = value . as < bool > ( ) ? 1 : 0 ;
} else if ( value . is < unsigned int > ( ) ) {
x = value . as < unsigned int > ( ) ;
} else {
// if non-bool or non-int, trying char*
const char * s_const = value . as < const char * > ( ) ;
if ( s_const ! = nullptr ) {
char s [ strlen ( s_const ) + 1 ] ;
strcpy ( s , s_const ) ;
if ( ( nullptr ! = s ) & & ( 0x00 ! = * s ) ) { // ignore any null or empty string, could represent 'null' json value
char * sval = strtok ( s , delim ) ;
if ( sval ) {
x = ZigbeeAliasOrNumber ( sval ) ;
sval = strtok ( nullptr , delim ) ;
if ( sval ) {
y = ZigbeeAliasOrNumber ( sval ) ;
sval = strtok ( nullptr , delim ) ;
if ( sval ) {
z = ZigbeeAliasOrNumber ( sval ) ;
}
}
}
}
}
}
//AddLog_P2(LOG_LEVEL_DEBUG, PSTR("ZbSend: command_template = %s"), cmd_str.c_str());
if ( 0xFF = = cmd_var ) { // if command number is a variable, replace it with x
cmd = x ;
x = y ; // and shift other variables
y = z ;
} else {
cmd = cmd_var ; // or simply copy the cmd number
}
cmd_str = zigbeeCmdAddParams ( cmd_str . c_str ( ) , x , y , z ) ; // fill in parameters
//AddLog_P2(LOG_LEVEL_DEBUG, PSTR("ZbSend: command_final = %s"), cmd_str.c_str());
cmd_s = cmd_str . c_str ( ) ;
} else {
// we have zero command, pass through until last error for missing command
}
} else if ( val_cmd . is < const char * > ( ) ) {
// low-level command
cmd_str = val_cmd . as < String > ( ) ;
// Now parse the string to extract cluster, command, and payload
// Parse 'cmd' in the form "AAAA_BB/CCCCCCCC" or "AAAA!BB/CCCCCCCC"
// where AA is the cluster number, BBBB the command number, CCCC... the payload
// First delimiter is '_' for a global command, or '!' for a cluster specific command
const char * data = cmd_str . c_str ( ) ;
2020-06-03 21:39:04 +01:00
uint16_t local_cluster_id = parseHex ( & data , 4 ) ;
// check cluster
if ( 0xFFFF = = cluster ) {
cluster = local_cluster_id ;
} else if ( cluster ! = local_cluster_id ) {
ResponseCmndChar_P ( PSTR ( " No more than one cluster id per command " ) ) ;
return ;
}
2020-05-29 21:52:45 +01:00
// delimiter
if ( ( ' _ ' = = * data ) | | ( ' ! ' = = * data ) ) {
if ( ' _ ' = = * data ) { clusterSpecific = false ; }
data + + ;
} else {
ResponseCmndChar_P ( PSTR ( " Wrong delimiter for payload " ) ) ;
return ;
}
// parse cmd number
cmd = parseHex ( & data , 2 ) ;
// move to end of payload
// delimiter is optional
if ( ' / ' = = * data ) { data + + ; } // skip delimiter
cmd_s = data ;
} else {
// we have an unsupported command type, just ignore it and fallback to missing command
}
AddLog_P2 ( LOG_LEVEL_DEBUG , PSTR ( " ZigbeeZCLSend device: 0x%04X, group: 0x%04X, endpoint:%d, cluster:0x%04X, cmd:0x%02X, send: \" %s \" " ) ,
device , groupaddr , endpoint , cluster , cmd , cmd_s ) ;
zigbeeZCLSendStr ( device , groupaddr , endpoint , clusterSpecific , manuf , cluster , cmd , cmd_s ) ;
ResponseCmndDone ( ) ;
}
// Parse the "Send" attribute and send the command
void ZbSendRead ( const JsonVariant & val_attr , uint16_t device , uint16_t groupaddr , uint16_t cluster , uint8_t endpoint , uint16_t manuf ) {
// ZbSend {"Device":"0xF289","Cluster":0,"Endpoint":3,"Read":5}
// ZbSend {"Device":"0xF289","Cluster":"0x0000","Endpoint":"0x0003","Read":"0x0005"}
// ZbSend {"Device":"0xF289","Cluster":0,"Endpoint":3,"Read":[5,6,7,4]}
// ZbSend {"Device":"0xF289","Endpoint":3,"Read":{"ModelId":true}}
// ZbSend {"Device":"0xF289","Read":{"ModelId":true}}
// params
size_t attrs_len = 0 ;
uint8_t * attrs = nullptr ; // empty string is valid
uint16_t val = strToUInt ( val_attr ) ;
if ( val_attr . is < JsonArray > ( ) ) {
const JsonArray & attr_arr = val_attr . as < const JsonArray & > ( ) ;
attrs_len = attr_arr . size ( ) * 2 ;
attrs = new uint8_t [ attrs_len ] ;
uint32_t i = 0 ;
for ( auto value : attr_arr ) {
uint16_t val = strToUInt ( value ) ;
attrs [ i + + ] = val & 0xFF ;
attrs [ i + + ] = val > > 8 ;
}
} else if ( val_attr . is < JsonObject > ( ) ) {
const JsonObject & attr_obj = val_attr . as < const JsonObject & > ( ) ;
attrs_len = attr_obj . size ( ) * 2 ;
attrs = new uint8_t [ attrs_len ] ;
uint32_t actual_attr_len = 0 ;
// iterate on keys
for ( JsonObject : : const_iterator it = attr_obj . begin ( ) ; it ! = attr_obj . end ( ) ; + + it ) {
const char * key = it - > key ;
// const JsonVariant &value = it->value; // we don't need the value here, only keys are relevant
bool found = false ;
// scan attributes to find by name, and retrieve type
for ( uint32_t i = 0 ; i < ARRAY_SIZE ( Z_PostProcess ) ; i + + ) {
const Z_AttributeConverter * converter = & Z_PostProcess [ i ] ;
bool match = false ;
uint16_t local_attr_id = pgm_read_word ( & converter - > attribute ) ;
uint16_t local_cluster_id = CxToCluster ( pgm_read_byte ( & converter - > cluster_short ) ) ;
// uint8_t local_type_id = pgm_read_byte(&converter->type);
if ( ( converter - > name ) & & ( 0 = = strcasecmp_P ( key , converter - > name ) ) ) {
// match name
// check if there is a conflict with cluster
// TODO
attrs [ actual_attr_len + + ] = local_attr_id & 0xFF ;
attrs [ actual_attr_len + + ] = local_attr_id > > 8 ;
found = true ;
2020-06-03 21:39:04 +01:00
// check cluster
if ( 0xFFFF = = cluster ) {
cluster = local_cluster_id ;
} else if ( cluster ! = local_cluster_id ) {
ResponseCmndChar_P ( PSTR ( " No more than one cluster id per command " ) ) ;
if ( attrs ) { delete [ ] attrs ; }
return ;
}
2020-05-29 21:52:45 +01:00
break ; // found, exit loop
}
}
if ( ! found ) {
AddLog_P2 ( LOG_LEVEL_INFO , PSTR ( " ZIG: Unknown attribute name (ignored): %s " ) , key ) ;
}
}
attrs_len = actual_attr_len ;
} else {
attrs_len = 2 ;
attrs = new uint8_t [ attrs_len ] ;
attrs [ 0 ] = val & 0xFF ; // little endian
attrs [ 1 ] = val > > 8 ;
}
if ( attrs_len > 0 ) {
ZigbeeZCLSend_Raw ( device , groupaddr , cluster , endpoint , ZCL_READ_ATTRIBUTES , false , manuf , attrs , attrs_len , true /* we do want a response */ , zigbee_devices . getNextSeqNumber ( device ) ) ;
ResponseCmndDone ( ) ;
} else {
ResponseCmndChar_P ( PSTR ( " Missing parameters " ) ) ;
}
if ( attrs ) { delete [ ] attrs ; }
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbSend`
//
2020-05-29 21:52:45 +01:00
// Examples:
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"0006/0000":0}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"Power":0}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"AqaraRotate":0}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"AqaraRotate":12.5}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"006/0000%39":12.5}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"AnalogInApplicationType":1000000}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"TimeZone":-1000000}}
// ZbSend {"Device":"0x0000","Endpoint":1,"Write":{"Manufacturer":"Tasmota","ModelId":"Tasmota Z2T Router"}}
2020-02-02 19:53:49 +00:00
void CmndZbSend ( void ) {
2020-03-23 21:46:26 +00:00
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":1} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":"3"} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":"0xFF"} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":null} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":false} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":true} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":"true"} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"ShutterClose":null} }
2020-05-29 21:52:45 +01:00
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Power":1} }
2020-03-23 21:46:26 +00:00
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Color":"1,2"} }
// ZbSend { "device":"0x1234", "endpoint":"0x03", "send":{"Color":"0x1122,0xFFEE"} }
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2019-11-03 11:41:44 +00:00
DynamicJsonBuffer jsonBuf ;
2020-03-23 21:46:26 +00:00
const JsonObject & json = jsonBuf . parseObject ( ( const char * ) XdrvMailbox . data ) ;
2020-03-16 17:55:58 +00:00
if ( ! json . success ( ) ) { ResponseCmndChar_P ( PSTR ( D_JSON_INVALID_JSON ) ) ; return ; }
2019-11-03 11:41:44 +00:00
// params
2020-05-29 21:52:45 +01:00
uint16_t device = BAD_SHORTADDR ; // BAD_SHORTADDR is broadcast, so considered invalid
uint16_t groupaddr = 0x0000 ; // group address valid only if device == BAD_SHORTADDR
uint16_t cluster = 0xFFFF ; // no default
uint8_t endpoint = 0x00 ; // 0x00 is invalid for the dst endpoint
uint16_t manuf = 0x0000 ; // Manuf Id in ZCL frame
2019-11-03 11:41:44 +00:00
2020-05-29 21:52:45 +01:00
// parse "Device" and "Group"
const JsonVariant & val_device = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_DEVICE ) ) ;
2020-03-30 18:23:06 +01:00
if ( nullptr ! = & val_device ) {
device = zigbee_devices . parseDeviceParam ( val_device . as < char * > ( ) ) ;
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = device ) { ResponseCmndChar_P ( PSTR ( " Invalid parameter " ) ) ; return ; }
2020-03-30 18:23:06 +01:00
}
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = device ) { // if not found, check if we have a group
2020-05-29 21:52:45 +01:00
const JsonVariant & val_group = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_GROUP ) ) ;
2020-03-30 18:23:06 +01:00
if ( nullptr ! = & val_group ) {
groupaddr = strToUInt ( val_group ) ;
} else { // no device nor group
ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ;
return ;
2020-03-14 13:17:30 +00:00
}
2020-02-02 19:53:49 +00:00
}
2020-06-03 21:39:04 +01:00
// from here, either device has a device shortaddr, or if BAD_SHORTADDR then use group address
// Note: groupaddr == 0 is valid
2020-02-02 19:53:49 +00:00
2020-05-29 21:52:45 +01:00
// read other parameters
const JsonVariant & val_cluster = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_CLUSTER ) ) ;
if ( nullptr ! = & val_cluster ) { cluster = strToUInt ( val_cluster ) ; }
const JsonVariant & val_endpoint = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_ENDPOINT ) ) ;
2019-11-03 11:41:44 +00:00
if ( nullptr ! = & val_endpoint ) { endpoint = strToUInt ( val_endpoint ) ; }
2020-05-29 21:52:45 +01:00
const JsonVariant & val_manuf = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_MANUF ) ) ;
2020-03-30 18:23:06 +01:00
if ( nullptr ! = & val_manuf ) { manuf = strToUInt ( val_manuf ) ; }
2019-11-03 11:41:44 +00:00
2020-05-29 21:52:45 +01:00
// infer endpoint
if ( BAD_SHORTADDR = = device ) {
2020-06-03 21:39:04 +01:00
endpoint = 0xFF ; // endpoint not used for group addresses, so use a dummy broadcast endpoint
} else if ( 0 = = endpoint ) { // if it was not already specified, try to guess it
2020-05-29 21:52:45 +01:00
endpoint = zigbee_devices . findFirstEndpoint ( device ) ;
AddLog_P2 ( LOG_LEVEL_DEBUG , PSTR ( " ZIG: guessing endpoint %d " ) , endpoint ) ;
}
2020-06-03 21:39:04 +01:00
if ( 0 = = endpoint ) { // after this, if it is still zero, then it's an error
ResponseCmndChar_P ( PSTR ( " Missing endpoint " ) ) ;
return ;
}
// from here endpoint is valid and non-zero
// cluster may be already specified or 0xFFFF
2020-03-14 13:17:30 +00:00
2020-05-29 21:52:45 +01:00
const JsonVariant & val_cmd = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_SEND ) ) ;
const JsonVariant & val_read = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_READ ) ) ;
const JsonVariant & val_write = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_WRITE ) ) ;
const JsonVariant & val_publish = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_REPORT ) ) ;
2020-06-03 21:39:04 +01:00
const JsonVariant & val_response = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_RESPONSE ) ) ;
uint32_t multi_cmd = ( nullptr ! = & val_cmd ) + ( nullptr ! = & val_read ) + ( nullptr ! = & val_write ) + ( nullptr ! = & val_publish ) + ( nullptr ! = & val_response ) ;
2020-05-29 21:52:45 +01:00
if ( multi_cmd > 1 ) {
2020-06-03 21:39:04 +01:00
ResponseCmndChar_P ( PSTR ( " Can only have one of: 'Send', 'Read', 'Write', 'Report' or 'Reponse' " ) ) ;
2020-05-29 21:52:45 +01:00
return ;
}
2020-06-03 21:39:04 +01:00
// from here we have one and only one command
2020-03-14 13:17:30 +00:00
2020-05-29 21:52:45 +01:00
if ( nullptr ! = & val_cmd ) {
// "Send":{...commands...}
2020-06-03 21:39:04 +01:00
// we accept either a string or a JSON object
2020-05-29 21:52:45 +01:00
ZbSendSend ( val_cmd , device , groupaddr , cluster , endpoint , manuf ) ;
} else if ( nullptr ! = & val_read ) {
// "Read":{...attributes...}, "Read":attribute or "Read":[...attributes...]
2020-06-03 21:39:04 +01:00
// we accept eitehr a number, a string, an array of numbers/strings, or a JSON object
2020-05-29 21:52:45 +01:00
ZbSendRead ( val_read , device , groupaddr , cluster , endpoint , manuf ) ;
} else if ( nullptr ! = & val_write ) {
2020-06-03 21:39:04 +01:00
// only KSON object
if ( ! val_write . is < JsonObject > ( ) ) {
2020-05-29 21:52:45 +01:00
ResponseCmndChar_P ( PSTR ( " Missing parameters " ) ) ;
return ;
2019-11-03 11:41:44 +00:00
}
2020-05-29 21:52:45 +01:00
// "Write":{...attributes...}
2020-06-03 21:39:04 +01:00
ZbSendReportWrite ( val_write , device , groupaddr , cluster , endpoint , manuf , ZCL_WRITE_ATTRIBUTES ) ;
2020-05-29 21:52:45 +01:00
} else if ( nullptr ! = & val_publish ) {
2020-06-03 21:39:04 +01:00
// "Report":{...attributes...}
// only KSON object
if ( ! val_publish . is < JsonObject > ( ) ) {
2020-05-29 21:52:45 +01:00
ResponseCmndChar_P ( PSTR ( " Missing parameters " ) ) ;
return ;
}
2020-06-03 21:39:04 +01:00
ZbSendReportWrite ( val_publish , device , groupaddr , cluster , endpoint , manuf , ZCL_REPORT_ATTRIBUTES ) ;
} else if ( nullptr ! = & val_response ) {
2020-05-29 21:52:45 +01:00
// "Report":{...attributes...}
2020-06-03 21:39:04 +01:00
// only KSON object
if ( ! val_response . is < JsonObject > ( ) ) {
ResponseCmndChar_P ( PSTR ( " Missing parameters " ) ) ;
return ;
}
ZbSendReportWrite ( val_response , device , groupaddr , cluster , endpoint , manuf , ZCL_READ_ATTRIBUTES_RESPONSE ) ;
2019-11-03 11:41:44 +00:00
} else {
2020-06-03 21:39:04 +01:00
Response_P ( PSTR ( " Missing zigbee 'Send', 'Write', 'Report' or 'Response' " ) ) ;
2019-11-03 11:41:44 +00:00
return ;
}
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbBind`
//
2020-03-26 19:58:59 +00:00
void ZbBindUnbind ( bool unbind ) { // false = bind, true = unbind
2020-03-23 21:46:26 +00:00
// ZbBind {"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> }
2020-03-26 19:58:59 +00:00
// ZbUnbind {"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> }
2020-02-02 19:53:49 +00:00
// local endpoint is always 1, IEEE addresses are calculated
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-02-02 19:53:49 +00:00
DynamicJsonBuffer jsonBuf ;
2020-03-23 21:46:26 +00:00
const JsonObject & json = jsonBuf . parseObject ( ( const char * ) XdrvMailbox . data ) ;
2020-03-16 17:55:58 +00:00
if ( ! json . success ( ) ) { ResponseCmndChar_P ( PSTR ( D_JSON_INVALID_JSON ) ) ; return ; }
2020-02-02 19:53:49 +00:00
// params
2020-05-17 17:33:42 +01:00
uint16_t srcDevice = BAD_SHORTADDR ; // BAD_SHORTADDR is broadcast, so considered invalid
uint16_t dstDevice = BAD_SHORTADDR ; // BAD_SHORTADDR is broadcast, so considered invalid
2020-03-01 10:25:59 +00:00
uint64_t dstLongAddr = 0 ;
uint8_t endpoint = 0x00 ; // 0x00 is invalid for the src endpoint
uint8_t toendpoint = 0x00 ; // 0x00 is invalid for the dst endpoint
uint16_t toGroup = 0x0000 ; // group address
2020-02-02 19:53:49 +00:00
uint16_t cluster = 0 ; // 0xFFFF is invalid
uint32_t group = 0xFFFFFFFF ; // 16 bits values, otherwise 0xFFFFFFFF is unspecified
2020-03-01 10:25:59 +00:00
// Information about source device: "Device", "Endpoint", "Cluster"
// - the source endpoint must have a known IEEE address
2020-05-29 21:52:45 +01:00
const JsonVariant & val_device = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_DEVICE ) ) ;
2020-02-02 19:53:49 +00:00
if ( nullptr ! = & val_device ) {
2020-03-01 10:25:59 +00:00
srcDevice = zigbee_devices . parseDeviceParam ( val_device . as < char * > ( ) ) ;
2020-02-02 19:53:49 +00:00
}
2020-05-17 17:33:42 +01:00
if ( ( nullptr = = & val_device ) | | ( BAD_SHORTADDR = = srcDevice ) ) { ResponseCmndChar_P ( PSTR ( " Unknown source device " ) ) ; return ; }
2020-03-01 10:25:59 +00:00
// check if IEEE address is known
uint64_t srcLongAddr = zigbee_devices . getDeviceLongAddr ( srcDevice ) ;
2020-03-16 17:55:58 +00:00
if ( 0 = = srcLongAddr ) { ResponseCmndChar_P ( PSTR ( " Unknown source IEEE address " ) ) ; return ; }
2020-03-01 10:25:59 +00:00
// look for source endpoint
2020-05-29 21:52:45 +01:00
const JsonVariant & val_endpoint = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_ENDPOINT ) ) ;
2020-02-02 19:53:49 +00:00
if ( nullptr ! = & val_endpoint ) { endpoint = strToUInt ( val_endpoint ) ; }
2020-03-01 10:25:59 +00:00
// look for source cluster
2020-05-29 21:52:45 +01:00
const JsonVariant & val_cluster = GetCaseInsensitive ( json , PSTR ( D_CMND_ZIGBEE_CLUSTER ) ) ;
2020-02-02 19:53:49 +00:00
if ( nullptr ! = & val_cluster ) { cluster = strToUInt ( val_cluster ) ; }
2020-03-01 10:25:59 +00:00
// Either Device address
// In this case the following parameters are mandatory
// - "ToDevice" and the device must have a known IEEE address
// - "ToEndpoint"
2020-05-24 08:57:11 +01:00
const JsonVariant & dst_device = GetCaseInsensitive ( json , PSTR ( " ToDevice " ) ) ;
2020-03-01 10:25:59 +00:00
if ( nullptr ! = & dst_device ) {
dstDevice = zigbee_devices . parseDeviceParam ( dst_device . as < char * > ( ) ) ;
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = dstDevice ) { ResponseCmndChar_P ( PSTR ( " Invalid parameter " ) ) ; return ; }
2020-03-01 10:25:59 +00:00
if ( 0x0000 = = dstDevice ) {
dstLongAddr = localIEEEAddr ;
} else {
dstLongAddr = zigbee_devices . getDeviceLongAddr ( dstDevice ) ;
}
2020-03-16 17:55:58 +00:00
if ( 0 = = dstLongAddr ) { ResponseCmndChar_P ( PSTR ( " Unknown dest IEEE address " ) ) ; return ; }
2020-03-01 10:25:59 +00:00
2020-05-24 08:57:11 +01:00
const JsonVariant & val_toendpoint = GetCaseInsensitive ( json , PSTR ( " ToEndpoint " ) ) ;
2020-03-01 10:25:59 +00:00
if ( nullptr ! = & val_toendpoint ) { toendpoint = strToUInt ( val_endpoint ) ; } else { toendpoint = endpoint ; }
}
// Or Group Address - we don't need a dstEndpoint in this case
2020-05-24 08:57:11 +01:00
const JsonVariant & to_group = GetCaseInsensitive ( json , PSTR ( " ToGroup " ) ) ;
2020-03-01 10:25:59 +00:00
if ( nullptr ! = & to_group ) { toGroup = strToUInt ( to_group ) ; }
// make sure we don't have conflicting parameters
2020-05-17 17:33:42 +01:00
if ( & to_group & & dstLongAddr ) { ResponseCmndChar_P ( PSTR ( " Cannot have both \" ToDevice \" and \" ToGroup \" " ) ) ; return ; }
if ( ! & to_group & & ! dstLongAddr ) { ResponseCmndChar_P ( PSTR ( " Missing \" ToDevice \" or \" ToGroup \" " ) ) ; return ; }
2020-02-02 19:53:49 +00:00
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
2020-03-14 13:17:30 +00:00
SBuffer buf ( 34 ) ;
2020-02-02 19:53:49 +00:00
buf . add8 ( Z_SREQ | Z_ZDO ) ;
2020-03-26 19:58:59 +00:00
if ( unbind ) {
buf . add8 ( ZDO_UNBIND_REQ ) ;
} else {
buf . add8 ( ZDO_BIND_REQ ) ;
}
2020-03-01 10:25:59 +00:00
buf . add16 ( srcDevice ) ;
buf . add64 ( srcLongAddr ) ;
2020-02-02 19:53:49 +00:00
buf . add8 ( endpoint ) ;
buf . add16 ( cluster ) ;
2020-03-01 10:25:59 +00:00
if ( dstLongAddr ) {
buf . add8 ( Z_Addr_IEEEAddress ) ; // DstAddrMode - 0x03 = ADDRESS_64_BIT
buf . add64 ( dstLongAddr ) ;
buf . add8 ( toendpoint ) ;
} else {
buf . add8 ( Z_Addr_Group ) ; // DstAddrMode - 0x01 = GROUP_ADDRESS
buf . add16 ( toGroup ) ;
}
2020-02-02 19:53:49 +00:00
ZigbeeZNPSend ( buf . getBuffer ( ) , buf . len ( ) ) ;
2020-06-16 19:01:14 +01:00
# endif // USE_ZIGBEE_ZNP
2020-02-02 19:53:49 +00:00
ResponseCmndDone ( ) ;
}
2020-03-26 19:58:59 +00:00
//
// Command ZbBind
//
void CmndZbBind ( void ) {
ZbBindUnbind ( false ) ;
}
//
// Command ZbBind
//
void CmndZbUnbind ( void ) {
ZbBindUnbind ( true ) ;
}
2020-03-30 18:23:06 +01:00
//
// Command `ZbBindState`
//
void CmndZbBindState ( void ) {
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data ) ;
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2020-03-30 18:23:06 +01:00
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
2020-03-30 18:23:06 +01:00
SBuffer buf ( 10 ) ;
buf . add8 ( Z_SREQ | Z_ZDO ) ; // 25
buf . add8 ( ZDO_MGMT_BIND_REQ ) ; // 33
buf . add16 ( shortaddr ) ; // shortaddr
buf . add8 ( 0 ) ; // StartIndex = 0
ZigbeeZNPSend ( buf . getBuffer ( ) , buf . len ( ) ) ;
2020-06-16 19:01:14 +01:00
# endif // USE_ZIGBEE_ZNP
2020-03-30 18:23:06 +01:00
ResponseCmndDone ( ) ;
}
2019-10-13 11:56:52 +01:00
// Probe a specific device to get its endpoints and supported clusters
2020-02-02 19:53:49 +00:00
void CmndZbProbe ( void ) {
2020-02-23 15:46:00 +00:00
CmndZbProbeOrPing ( true ) ;
}
2020-03-23 21:46:26 +00:00
//
// Common code for `ZbProbe` and `ZbPing`
//
2020-02-23 15:46:00 +00:00
void CmndZbProbeOrPing ( boolean probe ) {
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-01-17 23:02:01 +00:00
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data ) ;
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2019-10-13 11:56:52 +01:00
// everything is good, we can send the command
2020-02-23 15:46:00 +00:00
Z_SendIEEEAddrReq ( shortaddr ) ;
if ( probe ) {
Z_SendActiveEpReq ( shortaddr ) ;
}
2019-10-13 11:56:52 +01:00
ResponseCmndDone ( ) ;
2019-08-31 20:23:32 +01:00
}
2020-02-23 15:46:00 +00:00
// Ping a device, actually a simplified version of ZbProbe
void CmndZbPing ( void ) {
CmndZbProbeOrPing ( false ) ;
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbName`
2020-01-17 23:02:01 +00:00
// Specify, read or erase a Friendly Name
2020-03-23 21:46:26 +00:00
//
2020-02-02 19:53:49 +00:00
void CmndZbName ( void ) {
2020-01-17 23:02:01 +00:00
// Syntax is:
2020-03-23 21:46:26 +00:00
// ZbName <device_id>,<friendlyname> - assign a friendly name
// ZbName <device_id> - display the current friendly name
// ZbName <device_id>, - remove friendly name
2020-01-17 23:02:01 +00:00
//
// Where <device_id> can be: short_addr, long_addr, device_index, friendly_name
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-01-17 23:02:01 +00:00
// check if parameters contain a comma ','
char * p ;
char * str = strtok_r ( XdrvMailbox . data , " , " , & p ) ;
// parse first part, <device_id>
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data , true ) ; // in case of short_addr, it must be already registered
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2020-01-17 23:02:01 +00:00
if ( p = = nullptr ) {
2020-03-14 13:17:30 +00:00
const char * friendlyName = zigbee_devices . getFriendlyName ( shortaddr ) ;
Response_P ( PSTR ( " { \" 0x%04X \" :{ \" " D_JSON_ZIGBEE_NAME " \" : \" %s \" }} " ) , shortaddr , friendlyName ? friendlyName : " " ) ;
2020-01-17 23:02:01 +00:00
} else {
zigbee_devices . setFriendlyName ( shortaddr , p ) ;
2020-01-19 21:59:02 +00:00
Response_P ( PSTR ( " { \" 0x%04X \" :{ \" " D_JSON_ZIGBEE_NAME " \" : \" %s \" }} " ) , shortaddr , p ) ;
2020-01-17 23:02:01 +00:00
}
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbName`
2020-03-01 10:25:59 +00:00
// Specify, read or erase a ModelId, only for debug purposes
2020-03-23 21:46:26 +00:00
//
2020-03-01 10:25:59 +00:00
void CmndZbModelId ( void ) {
// Syntax is:
2020-03-23 21:46:26 +00:00
// ZbName <device_id>,<friendlyname> - assign a friendly name
// ZbName <device_id> - display the current friendly name
// ZbName <device_id>, - remove friendly name
2020-03-01 10:25:59 +00:00
//
// Where <device_id> can be: short_addr, long_addr, device_index, friendly_name
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-03-01 10:25:59 +00:00
// check if parameters contain a comma ','
char * p ;
char * str = strtok_r ( XdrvMailbox . data , " , " , & p ) ;
// parse first part, <device_id>
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data , true ) ; // in case of short_addr, it must be already registered
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2020-03-01 10:25:59 +00:00
if ( p = = nullptr ) {
2020-03-14 13:17:30 +00:00
const char * modelId = zigbee_devices . getModelId ( shortaddr ) ;
Response_P ( PSTR ( " { \" 0x%04X \" :{ \" " D_JSON_ZIGBEE_MODELID " \" : \" %s \" }} " ) , shortaddr , modelId ? modelId : " " ) ;
2020-03-01 10:25:59 +00:00
} else {
zigbee_devices . setModelId ( shortaddr , p ) ;
Response_P ( PSTR ( " { \" 0x%04X \" :{ \" " D_JSON_ZIGBEE_MODELID " \" : \" %s \" }} " ) , shortaddr , p ) ;
}
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbLight`
2020-03-14 13:17:30 +00:00
// Specify, read or erase a Light type for Hue/Alexa integration
void CmndZbLight ( void ) {
// Syntax is:
// ZbLight <device_id>,<x> - assign a bulb type 0-5
// ZbLight <device_id> - display the current bulb type and status
//
// Where <device_id> can be: short_addr, long_addr, device_index, friendly_name
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-03-14 13:17:30 +00:00
// check if parameters contain a comma ','
char * p ;
char * str = strtok_r ( XdrvMailbox . data , " , " , & p ) ;
// parse first part, <device_id>
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data , true ) ; // in case of short_addr, it must be already registered
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2020-03-14 13:17:30 +00:00
if ( p ) {
int8_t bulbtype = strtol ( p , nullptr , 10 ) ;
2020-03-23 07:25:01 +00:00
if ( bulbtype > 5 ) { bulbtype = 5 ; }
if ( bulbtype < - 1 ) { bulbtype = - 1 ; }
2020-03-14 13:17:30 +00:00
zigbee_devices . setHueBulbtype ( shortaddr , bulbtype ) ;
}
String dump = zigbee_devices . dumpLightState ( shortaddr ) ;
Response_P ( PSTR ( " { \" " D_PRFX_ZB D_CMND_ZIGBEE_LIGHT " \" :%s} " ) , dump . c_str ( ) ) ;
MqttPublishPrefixTopic_P ( RESULT_OR_STAT , PSTR ( D_PRFX_ZB D_CMND_ZIGBEE_LIGHT ) ) ;
XdrvRulesProcess ( ) ;
ResponseCmndDone ( ) ;
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbForget`
2020-01-17 23:02:01 +00:00
// Remove an old Zigbee device from the list of known devices, use ZigbeeStatus to know all registered devices
2020-03-23 21:46:26 +00:00
//
2020-02-02 19:53:49 +00:00
void CmndZbForget ( void ) {
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-01-17 23:02:01 +00:00
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data ) ;
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2020-01-17 23:02:01 +00:00
// everything is good, we can send the command
if ( zigbee_devices . removeDevice ( shortaddr ) ) {
ResponseCmndDone ( ) ;
} else {
2020-03-16 17:55:58 +00:00
ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ;
2020-01-17 23:02:01 +00:00
}
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbSave`
2020-01-17 23:02:01 +00:00
// Save Zigbee information to flash
2020-03-23 21:46:26 +00:00
//
2020-02-02 19:53:49 +00:00
void CmndZbSave ( void ) {
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-01-17 23:02:01 +00:00
saveZigbeeDevices ( ) ;
ResponseCmndDone ( ) ;
}
2020-03-22 15:11:01 +00:00
// Restore a device configuration previously exported via `ZbStatus2``
// Format:
// Either the entire `ZbStatus3` export, or an array or just the device configuration.
// If array, if can contain multiple devices
// ZbRestore {"ZbStatus3":[{"Device":"0x5ADF","Name":"Petite_Lampe","IEEEAddr":"0x90FD9FFFFE03B051","ModelId":"TRADFRI bulb E27 WS opal 980lm","Manufacturer":"IKEA of Sweden","Endpoints":["0x01","0xF2"]}]}
// ZbRestore [{"Device":"0x5ADF","Name":"Petite_Lampe","IEEEAddr":"0x90FD9FFFFE03B051","ModelId":"TRADFRI bulb E27 WS opal 980lm","Manufacturer":"IKEA of Sweden","Endpoints":["0x01","0xF2"]}]
// ZbRestore {"Device":"0x5ADF","Name":"Petite_Lampe","IEEEAddr":"0x90FD9FFFFE03B051","ModelId":"TRADFRI bulb E27 WS opal 980lm","Manufacturer":"IKEA of Sweden","Endpoints":["0x01","0xF2"]}
void CmndZbRestore ( void ) {
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
DynamicJsonBuffer jsonBuf ;
2020-03-23 21:46:26 +00:00
const JsonVariant json_parsed = jsonBuf . parse ( ( const char * ) XdrvMailbox . data ) ; // const to force a copy of parameter
2020-03-22 15:11:01 +00:00
const JsonVariant * json = & json_parsed ; // root of restore, to be changed if needed
bool success = false ;
// check if parsing succeeded
if ( json_parsed . is < JsonObject > ( ) ) {
success = json_parsed . as < const JsonObject & > ( ) . success ( ) ;
} else if ( json_parsed . is < JsonArray > ( ) ) {
success = json_parsed . as < const JsonArray & > ( ) . success ( ) ;
}
if ( ! success ) { ResponseCmndChar_P ( PSTR ( D_JSON_INVALID_JSON ) ) ; return ; }
// Check is root contains `ZbStatus<x>` key, if so change the root
const JsonVariant * zbstatus = & startsWithCaseInsensitive ( * json , PSTR ( " ZbStatus " ) ) ;
if ( nullptr ! = zbstatus ) {
json = zbstatus ;
}
// check if the root is an array
if ( json - > is < JsonArray > ( ) ) {
const JsonArray & arr = json - > as < const JsonArray & > ( ) ;
for ( auto elt : arr ) {
// call restore on each item
int32_t res = zigbee_devices . deviceRestore ( elt ) ;
if ( res < 0 ) {
ResponseCmndChar_P ( PSTR ( " Restore failed " ) ) ;
return ;
}
}
} else if ( json - > is < JsonObject > ( ) ) {
int32_t res = zigbee_devices . deviceRestore ( * json ) ;
if ( res < 0 ) {
ResponseCmndChar_P ( PSTR ( " Restore failed " ) ) ;
return ;
}
// call restore on a single object
} else {
ResponseCmndChar_P ( PSTR ( " Missing parameters " ) ) ;
return ;
}
ResponseCmndDone ( ) ;
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbPermitJoin`
2019-09-29 14:38:26 +01:00
// Allow or Deny pairing of new Zigbee devices
2020-03-23 21:46:26 +00:00
//
2020-03-14 13:17:30 +00:00
void CmndZbPermitJoin ( void ) {
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2019-09-15 10:10:59 +01:00
uint32_t payload = XdrvMailbox . payload ;
2020-03-14 13:17:30 +00:00
uint16_t dstAddr = 0xFFFC ; // default addr
uint8_t duration = 60 ; // default 60s
2019-09-15 10:10:59 +01:00
2020-03-14 13:17:30 +00:00
if ( payload < = 0 ) {
duration = 0 ;
} else if ( 99 = = payload ) {
duration = 0xFF ; // unlimited time
2019-09-15 10:10:59 +01:00
}
2020-03-14 13:17:30 +00:00
2020-06-16 19:01:14 +01:00
# ifdef USE_ZIGBEE_ZNP
2020-03-14 13:17:30 +00:00
SBuffer buf ( 34 ) ;
buf . add8 ( Z_SREQ | Z_ZDO ) ; // 25
buf . add8 ( ZDO_MGMT_PERMIT_JOIN_REQ ) ; // 36
buf . add8 ( 0x0F ) ; // AddrMode
buf . add16 ( 0xFFFC ) ; // DstAddr
buf . add8 ( duration ) ;
buf . add8 ( 0x00 ) ; // TCSignificance
ZigbeeZNPSend ( buf . getBuffer ( ) , buf . len ( ) ) ;
2020-06-16 19:01:14 +01:00
# endif // USE_ZIGBEE_ZNP
2020-03-14 13:17:30 +00:00
2019-09-15 10:10:59 +01:00
ResponseCmndDone ( ) ;
}
2020-03-23 21:46:26 +00:00
//
// Command `ZbStatus`
//
2020-02-02 19:53:49 +00:00
void CmndZbStatus ( void ) {
2020-01-17 23:02:01 +00:00
if ( ZigbeeSerial ) {
2020-03-16 17:55:58 +00:00
if ( zigbee . init_phase ) { ResponseCmndChar_P ( PSTR ( D_ZIGBEE_NOT_STARTED ) ) ; return ; }
2020-01-17 23:02:01 +00:00
uint16_t shortaddr = zigbee_devices . parseDeviceParam ( XdrvMailbox . data ) ;
if ( XdrvMailbox . payload > 0 ) {
2020-05-17 17:33:42 +01:00
if ( BAD_SHORTADDR = = shortaddr ) { ResponseCmndChar_P ( PSTR ( " Unknown device " ) ) ; return ; }
2020-01-17 23:02:01 +00:00
}
2020-04-22 15:07:52 +01:00
2020-01-17 23:02:01 +00:00
String dump = zigbee_devices . dump ( XdrvMailbox . index , shortaddr ) ;
Response_P ( PSTR ( " { \" %s%d \" :%s} " ) , XdrvMailbox . command , XdrvMailbox . index , dump . c_str ( ) ) ;
}
}
2020-04-11 17:50:46 +01:00
//
// Command `ZbConfig`
//
void CmndZbConfig ( void ) {
// ZbConfig
// ZbConfig {"Channel":11,"PanID":"0x1A63","ExtPanID":"0xCCCCCCCCCCCCCCCC","KeyL":"0x0F0D0B0907050301L","KeyH":"0x0D0C0A0806040200L"}
uint8_t zb_channel = Settings . zb_channel ;
uint16_t zb_pan_id = Settings . zb_pan_id ;
uint64_t zb_ext_panid = Settings . zb_ext_panid ;
uint64_t zb_precfgkey_l = Settings . zb_precfgkey_l ;
uint64_t zb_precfgkey_h = Settings . zb_precfgkey_h ;
// if (zigbee.init_phase) { ResponseCmndChar_P(PSTR(D_ZIGBEE_NOT_STARTED)); return; }
RemoveAllSpaces ( XdrvMailbox . data ) ;
if ( strlen ( XdrvMailbox . data ) > 0 ) {
DynamicJsonBuffer jsonBuf ;
const JsonObject & json = jsonBuf . parseObject ( ( const char * ) XdrvMailbox . data ) ;
if ( ! json . success ( ) ) { ResponseCmndChar_P ( PSTR ( D_JSON_INVALID_JSON ) ) ; return ; }
// Channel
2020-05-24 08:57:11 +01:00
const JsonVariant & val_channel = GetCaseInsensitive ( json , PSTR ( " Channel " ) ) ;
2020-04-11 17:50:46 +01:00
if ( nullptr ! = & val_channel ) { zb_channel = strToUInt ( val_channel ) ; }
2020-04-11 18:01:39 +01:00
if ( zb_channel < 11 ) { zb_channel = 11 ; }
if ( zb_channel > 26 ) { zb_channel = 26 ; }
2020-04-11 17:50:46 +01:00
// PanID
2020-05-24 08:57:11 +01:00
const JsonVariant & val_pan_id = GetCaseInsensitive ( json , PSTR ( " PanID " ) ) ;
2020-04-11 17:50:46 +01:00
if ( nullptr ! = & val_pan_id ) { zb_pan_id = strToUInt ( val_pan_id ) ; }
// ExtPanID
2020-05-24 08:57:11 +01:00
const JsonVariant & val_ext_pan_id = GetCaseInsensitive ( json , PSTR ( " ExtPanID " ) ) ;
2020-04-11 17:50:46 +01:00
if ( nullptr ! = & val_ext_pan_id ) { zb_ext_panid = strtoull ( val_ext_pan_id . as < const char * > ( ) , nullptr , 0 ) ; }
// KeyL
2020-05-24 08:57:11 +01:00
const JsonVariant & val_key_l = GetCaseInsensitive ( json , PSTR ( " KeyL " ) ) ;
2020-04-11 17:50:46 +01:00
if ( nullptr ! = & val_key_l ) { zb_precfgkey_l = strtoull ( val_key_l . as < const char * > ( ) , nullptr , 0 ) ; }
// KeyH
2020-05-24 08:57:11 +01:00
const JsonVariant & val_key_h = GetCaseInsensitive ( json , PSTR ( " KeyH " ) ) ;
2020-04-11 17:50:46 +01:00
if ( nullptr ! = & val_key_h ) { zb_precfgkey_h = strtoull ( val_key_h . as < const char * > ( ) , nullptr , 0 ) ; }
// Check if a parameter was changed after all
if ( ( zb_channel ! = Settings . zb_channel ) | |
( zb_pan_id ! = Settings . zb_pan_id ) | |
( zb_ext_panid ! = Settings . zb_ext_panid ) | |
( zb_precfgkey_l ! = Settings . zb_precfgkey_l ) | |
( zb_precfgkey_h ! = Settings . zb_precfgkey_h ) ) {
Settings . zb_channel = zb_channel ;
Settings . zb_pan_id = zb_pan_id ;
Settings . zb_ext_panid = zb_ext_panid ;
Settings . zb_precfgkey_l = zb_precfgkey_l ;
Settings . zb_precfgkey_h = zb_precfgkey_h ;
restart_flag = 2 ; // save and reboot
}
}
// display the current or new configuration
char hex_ext_panid [ 20 ] = " 0x " ;
Uint64toHex ( zb_ext_panid , & hex_ext_panid [ 2 ] , 64 ) ;
char hex_precfgkey_l [ 20 ] = " 0x " ;
Uint64toHex ( zb_precfgkey_l , & hex_precfgkey_l [ 2 ] , 64 ) ;
char hex_precfgkey_h [ 20 ] = " 0x " ;
Uint64toHex ( zb_precfgkey_h , & hex_precfgkey_h [ 2 ] , 64 ) ;
// {"ZbConfig":{"Channel":11,"PanID":"0x1A63","ExtPanID":"0xCCCCCCCCCCCCCCCC","KeyL":"0x0F0D0B0907050301L","KeyH":"0x0D0C0A0806040200L"}}
Response_P ( PSTR ( " { \" " D_PRFX_ZB D_JSON_ZIGBEE_CONFIG " \" :{ "
" \" Channel \" :%d "
" , \" PanID \" : \" 0x%04X \" "
" , \" ExtPanID \" : \" %s \" "
" , \" KeyL \" : \" %s \" "
" , \" KeyH \" : \" %s \" "
" }} " ) ,
zb_channel , zb_pan_id ,
hex_ext_panid ,
hex_precfgkey_l , hex_precfgkey_h ) ;
}
2019-08-31 20:23:32 +01:00
/*********************************************************************************************\
* Interface
\ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
bool Xdrv23 ( uint8_t function )
{
bool result = false ;
if ( zigbee . active ) {
switch ( function ) {
2019-12-15 15:02:41 +00:00
case FUNC_EVERY_50_MSECOND :
if ( ! zigbee . init_phase ) {
zigbee_devices . runTimer ( ) ;
}
break ;
2019-08-31 20:23:32 +01:00
case FUNC_LOOP :
2020-03-23 21:46:26 +00:00
if ( ZigbeeSerial ) { ZigbeeInputLoop ( ) ; }
2019-08-31 20:23:32 +01:00
if ( zigbee . state_machine ) {
ZigbeeStateMachine_Run ( ) ;
}
break ;
case FUNC_PRE_INIT :
ZigbeeInit ( ) ;
break ;
case FUNC_COMMAND :
2020-01-25 16:42:53 +00:00
result = DecodeCommand ( kZbCommands , ZigbeeCommand ) ;
2019-08-31 20:23:32 +01:00
break ;
}
}
return result ;
}
# endif // USE_ZIGBEE