2018-09-25 13:08:36 +01:00
#!/usr/bin/env python
# -*- coding: utf-8 -*-
2019-09-06 09:42:39 +01:00
VER = ' 2.3.0033 '
2018-09-25 13:08:36 +01:00
"""
2018-10-27 09:37:33 +01:00
decode - config . py - Backup / Restore Sonoff - Tasmota configuration data
2018-09-25 13:08:36 +01:00
2019-01-04 10:26:29 +00:00
Copyright ( C ) 2019 Norbert Richter < nr @prsolution.eu >
2018-09-25 13:08:36 +01:00
2018-11-14 07:03:55 +00:00
This program is free software : you can redistribute it and / or modify
2018-09-25 13:08:36 +01:00
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 / > .
2018-09-29 12:37:42 +01:00
2018-09-25 13:08:36 +01:00
Requirements :
- Python
2018-09-26 14:18:01 +01:00
- pip install json pycurl urllib2 configargparse
2018-09-25 13:08:36 +01:00
2018-09-29 12:37:42 +01:00
2018-09-25 13:08:36 +01:00
Instructions :
2018-09-29 12:37:42 +01:00
Execute command with option - d to retrieve config data from a host
2018-10-27 09:37:33 +01:00
or use - f to read a configuration file saved using Tasmota Web - UI
For further information read ' decode-config.md '
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
For help execute command with argument - h ( or - H for advanced help )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
Usage : decode - config . py [ - f < filename > ] [ - d < host > ] [ - P < port > ]
[ - u < username > ] [ - p < password > ] [ - i < filename > ]
2018-11-12 15:08:09 +00:00
[ - o < filename > ] [ - t json | bin | dmp ] [ - E ] [ - e ] [ - F ]
2018-10-27 09:37:33 +01:00
[ - - json - indent < indent > ] [ - - json - compact ]
2018-11-12 15:08:09 +00:00
[ - - json - hide - pw ] [ - - json - show - pw ]
[ - - cmnd - indent < indent > ] [ - - cmnd - groups ]
[ - - cmnd - nogroups ] [ - - cmnd - sort ] [ - - cmnd - unsort ]
[ - c < filename > ] [ - S ] [ - T json | cmnd | command ]
2019-05-11 12:46:58 +01:00
[ - g { Control , Devices , Display , Domoticz , Internal , KNX , Light , MQTT , Management , Power , Rules , Sensor , Serial , SetOption , SonoffRF , System , Timer , Wifi } [ { Control , Devices , Display , Domoticz , Internal , KNX , Light , MQTT , Management , Power , Rules , Sensor , Serial , SetOption , SonoffRF , System , Timer , Wifi } . . . ] ]
2018-11-12 15:08:09 +00:00
[ - - ignore - warnings ] [ - h ] [ - H ] [ - v ] [ - V ]
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
Backup / Restore Sonoff - Tasmota configuration data . Args that start with ' -- '
( eg . - f ) can also be set in a config file ( specified via - c ) . Config file
syntax allows : key = value , flag = true , stuff = [ a , b , c ] ( for details , see syntax at
2018-09-25 13:08:36 +01:00
https : / / goo . gl / R74nmi ) . If an arg is specified in more than one place , then
commandline values override config file values which override defaults .
2018-10-27 09:37:33 +01:00
Source :
Read / Write Tasmota configuration from / to
- f , - - file , - - tasmota - file < filename >
file to retrieve / write Tasmota configuration from / to
( default : None ) '
- d , - - device , - - host < host >
hostname or IP address to retrieve / send Tasmota
configuration from / to ( default : None )
- P , - - port < port > TCP / IP port number to use for the host connection
( default : 80 )
- u , - - username < username >
2018-09-29 12:37:42 +01:00
host HTTP access username ( default : admin )
2018-10-27 09:37:33 +01:00
- p , - - password < password >
2018-09-29 12:37:42 +01:00
host HTTP access password ( default : None )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
Backup / Restore :
2018-11-12 15:08:09 +00:00
Backup & restore specification
2018-10-27 09:37:33 +01:00
- i , - - restore - file < filename >
file to restore configuration from ( default : None ) .
2018-11-14 07:03:55 +00:00
Replacements : @v = firmware version from config ,
@f = device friendly name from config , @h = device
hostname from config , @H = device hostname from device
( - d arg only )
2018-10-27 09:37:33 +01:00
- o , - - backup - file < filename >
file to backup configuration to ( default : None ) .
2018-11-14 07:03:55 +00:00
Replacements : @v = firmware version from config ,
@f = device friendly name from config , @h = device
hostname from config , @H = device hostname from device
( - d arg only )
2018-11-12 15:08:09 +00:00
- t , - - backup - type json | bin | dmp
2018-10-27 09:37:33 +01:00
backup filetype ( default : ' json ' )
- E , - - extension append filetype extension for - i and - o filename
( default )
- e , - - no - extension do not append filetype extension , use - i and - o
filename as passed
2018-11-12 15:08:09 +00:00
- F , - - force - restore force restore even configuration is identical
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
JSON output :
JSON format specification
2018-10-27 09:37:33 +01:00
- - json - indent < indent >
2018-09-26 14:18:01 +01:00
pretty - printed JSON output using indent level
2018-10-27 09:37:33 +01:00
( default : ' None ' ) . - 1 disables indent .
2018-10-02 12:42:21 +01:00
- - json - compact compact JSON output by eliminate whitespace
2018-11-12 15:08:09 +00:00
- - json - hide - pw hide passwords
- - json - show - pw , - - json - unhide - pw
unhide passwords ( default )
Tasmota command output :
Tasmota command output format specification
- - cmnd - indent < indent >
Tasmota command grouping indent level ( default : ' 2 ' ) .
0 disables indent
- - cmnd - groups group Tasmota commands ( default )
- - cmnd - nogroups leave Tasmota commands ungrouped
- - cmnd - sort sort Tasmota commands ( default )
- - cmnd - unsort leave Tasmota commands unsorted
Common :
Optional arguments
- c , - - config < filename >
program config file - can be used to set default
command args ( default : None )
- S , - - output display output regardsless of backup / restore usage
( default do not output on backup or restore usage )
- T , - - output - format json | cmnd | command
display output format ( default : ' json ' )
2019-05-11 12:46:58 +01:00
- g , - - group { Control , Devices , Display , Domoticz , Internal , KNX , Light , MQTT , Management , Power , Rules , Sensor , Serial , SetOption , SonoffRF , System , Timer , Wifi }
2018-11-12 15:08:09 +00:00
limit data processing to command groups ( default no
filter )
- - ignore - warnings do not exit on warnings . Not recommended , used by your
own responsibility !
2018-10-27 09:37:33 +01:00
Info :
2018-11-12 15:08:09 +00:00
Extra information
2018-10-27 09:37:33 +01:00
- h , - - help show usage help message and exit
- H , - - full - help show full help message and exit
- v , - - verbose produce more output about what the program does
2018-09-25 13:08:36 +01:00
- V , - - version show program ' s version number and exit
2018-09-26 14:18:01 +01:00
Either argument - d < host > or - f < filename > must be given .
2018-09-25 13:08:36 +01:00
2018-10-02 12:42:21 +01:00
Returns :
0 : successful
2018-10-27 09:37:33 +01:00
1 : restore skipped
2 : program argument error
3 : file not found
4 : data size mismatch
5 : data CRC error
6 : unsupported configuration version
7 : configuration file read error
8 : JSON file decoding error
9 : Restore file data error
10 : Device data download error
11 : Device data upload error
20 : python module missing
21 : Internal error
> 21 : python library exit code
4 xx , 5 xx : HTTP errors
2018-10-02 12:42:21 +01:00
2018-09-25 13:08:36 +01:00
"""
2018-10-27 09:37:33 +01:00
class ExitCode :
OK = 0
RESTORE_SKIPPED = 1
ARGUMENT_ERROR = 2
FILE_NOT_FOUND = 3
DATA_SIZE_MISMATCH = 4
DATA_CRC_ERROR = 5
UNSUPPORTED_VERSION = 6
FILE_READ_ERROR = 7
JSON_READ_ERROR = 8
RESTORE_DATA_ERROR = 9
DOWNLOAD_CONFIG_ERROR = 10
UPLOAD_CONFIG_ERROR = 11
MODULE_NOT_FOUND = 20
INTERNAL_ERROR = 21
2018-11-12 15:08:09 +00:00
# ======================================================================
# imports
# ======================================================================
2018-09-25 13:08:36 +01:00
import os . path
import io
2018-10-27 09:37:33 +01:00
import sys , platform
2018-10-02 12:42:21 +01:00
def ModuleImportError ( module ) :
er = str ( module )
2018-10-27 09:37:33 +01:00
print >> sys . stderr , " {} . Try ' pip install {} ' to install it " . format ( er , er . split ( ' ' ) [ len ( er . split ( ' ' ) ) - 1 ] )
sys . exit ( ExitCode . MODULE_NOT_FOUND )
2018-09-29 12:37:42 +01:00
try :
2018-10-27 09:37:33 +01:00
from datetime import datetime
2018-11-12 15:08:09 +00:00
import time
2018-11-07 12:42:13 +00:00
import copy
2018-10-02 12:42:21 +01:00
import struct
2018-10-27 09:37:33 +01:00
import socket
2018-10-02 12:42:21 +01:00
import re
import math
2018-10-27 09:37:33 +01:00
import inspect
2018-10-02 12:42:21 +01:00
import json
2018-09-29 12:37:42 +01:00
import configargparse
2018-09-25 13:08:36 +01:00
import pycurl
import urllib2
2018-10-02 12:42:21 +01:00
except ImportError , e :
ModuleImportError ( e )
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
# ======================================================================
# globals
# ======================================================================
2018-10-27 09:37:33 +01:00
PROG = ' {} v {} by Norbert Richter <nr@prsolution.eu> ' . format ( os . path . basename ( sys . argv [ 0 ] ) , VER )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
CONFIG_FILE_XOR = 0x5A
BINARYFILE_MAGIC = 0x63576223
STR_ENCODING = ' utf8 '
2018-11-12 15:08:09 +00:00
HIDDEN_PASSWORD = ' ******** '
INTERNAL = ' Internal '
2018-10-27 09:37:33 +01:00
DEFAULTS = {
2018-09-25 13:08:36 +01:00
' source ' :
{
' device ' : None ,
2018-10-27 09:37:33 +01:00
' port ' : 80 ,
2018-09-25 13:08:36 +01:00
' username ' : ' admin ' ,
' password ' : None ,
' tasmotafile ' : None ,
} ,
2018-10-27 09:37:33 +01:00
' backup ' :
{
' restorefile ' : None ,
' backupfile ' : None ,
' backupfileformat ' : ' json ' ,
' extension ' : True ,
2018-11-12 15:08:09 +00:00
' forcerestore ' : False ,
2018-10-27 09:37:33 +01:00
} ,
' jsonformat ' :
2018-09-25 13:08:36 +01:00
{
2018-09-26 14:18:01 +01:00
' jsonindent ' : None ,
' jsoncompact ' : False ,
2018-10-27 09:37:33 +01:00
' jsonsort ' : True ,
2018-10-29 15:26:45 +00:00
' jsonhidepw ' : False ,
2018-09-25 13:08:36 +01:00
} ,
2018-11-12 15:08:09 +00:00
' cmndformat ' :
{
' cmndindent ' : 2 ,
' cmndgroup ' : True ,
' cmndsort ' : True ,
} ,
' common ' :
{
' output ' : False ,
' outputformat ' : ' json ' ,
' configfile ' : None ,
' ignorewarning ' : False ,
' filter ' : None ,
} ,
2018-09-25 13:08:36 +01:00
}
2018-10-27 09:37:33 +01:00
args = { }
2018-10-02 12:42:21 +01:00
exitcode = 0
2018-11-12 15:08:09 +00:00
# ======================================================================
# Settings mapping
# ======================================================================
2018-10-02 12:42:21 +01:00
"""
Settings dictionary describes the config file fields definition :
2018-11-12 15:08:09 +00:00
< setting > = { < name > : < def > }
< name > : " string "
a python valid dictionary key ( string )
< def > : ( < format > , < addrdef > , < datadef > [ , < converter > ] )
a tuple containing the following items :
< format > : < formatstring > | < setting >
data type & format definition
< formatstring > : < string >
defines the use of data at < addrdef >
format is defined in ' struct module format string '
see
https : / / docs . python . org / 2.7 / library / struct . html #format-strings
< setting > : < setting >
A dictionary describes a ( sub ) setting dictonary
and can recursively define another < setting >
< addrdef > : < baseaddr > | ( < baseaddr > , < bits > , < bitshift > )
address definition
< baseaddr > : < uint >
The address ( starting from 0 ) within binary config data .
< bits > : < uint >
number of bits used ( positive integer )
< bitshift > : < int >
bit shift < bitshift > :
< bitshift > > = 0 : shift the result right
< bitshift > < 0 : shift the result left
< datadef > : < arraydef > | ( < arraydef > , < validate > [ , cmd ] )
data definition
< arraydef > : None | < dim > | [ < dim > ] | [ < dim > , < dim > . . . ]
2018-10-29 15:26:45 +00:00
None :
2018-11-12 15:08:09 +00:00
Single value , not an array
< dim > : < int >
[ < dim > ]
2018-10-29 15:26:45 +00:00
Defines a one - dimensional array of size < n >
2018-11-12 15:08:09 +00:00
[ < dim > , < dim > . . . ]
Defines a one - or multi - dimensional array
< validate > : < function >
value validation function
< cmd > : ( < group > , < tasmotacmnd > )
Tasmota command definition
< group > : < string >
command group string
2019-05-11 12:46:58 +01:00
< tasmotacmnd > : < function > | ( < function > , . . . )
2018-11-12 15:08:09 +00:00
convert data into Tasmota command function
< converter > : < readconverter > | ( < readconverter > , < writeconverter > )
read / write converter
< readconverter > : None | < function >
Will be used in Bin2Mapping to convert values read
from the binary data object into mapping dictionary
None
None indicates not read conversion
< function >
to convert value from binary object to JSON .
< writeconverter > : None | False | < function >
Will be used in Mapping2Bin to convert values read
from mapping dictionary before write to binary
data object
None
None indicates not write conversion
False
False indicates the value is readonly and will
not be written into the binary object .
< function >
to convert value from JSON back to binary object
Common definitions
< function > : < functionname > | < string > | None
function to be called or string to evaluate :
< functionname > :
A function name will be called with one or two parameter :
The value to be processed
( optional ) the current array index ( 1 , n )
< string >
A string will be evaluate as is . The following
placeholder can be used to replace it by runtime values :
' $ ' :
will be replaced by the mapping name value
' # ' :
will be replace by array index ( if any )
' @ ' :
can be used as reference to other mapping values
see definition below for examples
< string > : ' string ' | " string "
characters enclosed in ' or "
< int > : integer
numbers in the range - 2147483648 through 2147483647
< uint > : unsigned integer
numbers in the range 0 through 4294967295
2018-10-02 12:42:21 +01:00
"""
2018-11-12 15:08:09 +00:00
# ----------------------------------------------------------------------
# Settings helper
# ----------------------------------------------------------------------
2018-10-27 09:37:33 +01:00
def passwordread ( value ) :
2018-11-12 15:08:09 +00:00
return HIDDEN_PASSWORD if args . jsonhidepw else value
2018-10-27 09:37:33 +01:00
def passwordwrite ( value ) :
2018-11-12 15:08:09 +00:00
return None if value == HIDDEN_PASSWORD else value
def bitsRead ( x , n = 0 , c = 1 ) :
"""
Reads bit ( s ) of a number
@param x :
the number from which to read
@param n :
which bit position to read
@param c :
how many bits to read ( 1 if omitted )
@return :
the bit value ( s )
"""
if isinstance ( x , str ) :
x = int ( x , 0 )
if isinstance ( x , str ) :
n = int ( n , 0 )
2018-10-02 12:42:21 +01:00
2018-11-12 15:08:09 +00:00
if n > = 0 :
x >> = n
else :
x << = abs ( n )
if c > 0 :
x & = ( 1 << c ) - 1
return x
2018-11-16 17:09:02 +00:00
def MqttFingerprint ( value , idx = None ) :
fingerprint = " "
for i in value :
fingerprint + = " {:02x} " . format ( ord ( i ) )
return " MqttFingerprint {} {} " . format ( ' ' if idx is None else idx , fingerprint . strip ( ) )
2019-08-19 12:40:06 +01:00
def WebSensor ( value , idx ) :
cmd = [ ]
for i in range ( 0 , 32 ) :
cmd . append ( " WebSensor {} {} " . format ( i + ( idx - 1 ) * 32 , " 1 " if ( int ( value , 16 ) & ( 1 << i ) ) != 0 else " 0 " ) )
return cmd
2018-11-16 17:09:02 +00:00
2018-11-12 15:08:09 +00:00
# ----------------------------------------------------------------------
# Tasmota configuration data definition
# ----------------------------------------------------------------------
2018-10-14 12:18:16 +01:00
Setting_5_10_0 = {
2018-11-12 15:08:09 +00:00
# <format>, <addrdef>, <datadef> [,<converter>]
' cfg_holder ' : ( ' <L ' , 0x000 , ( None , None , ( INTERNAL , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
' save_flag ' : ( ' <L ' , 0x004 , ( None , None , ( ' System ' , None ) ) , ( None , False ) ) ,
' version ' : ( ' <L ' , 0x008 , ( None , None , ( INTERNAL , None ) ) , ( ' hex($) ' , False ) ) ,
' bootcount ' : ( ' <L ' , 0x00C , ( None , None , ( ' System ' , None ) ) , ( None , False ) ) ,
2018-10-02 12:42:21 +01:00
' flag ' : ( {
2019-05-11 12:46:58 +01:00
' save_state ' : ( ' <L ' , ( 0x010 , 1 , 0 ) , ( None , None , ( ' SetOption ' , ' " SetOption0 {} " .format($) ' ) ) ) ,
' button_restrict ' : ( ' <L ' , ( 0x010 , 1 , 1 ) , ( None , None , ( ' SetOption ' , ' " SetOption1 {} " .format($) ' ) ) ) ,
' value_units ' : ( ' <L ' , ( 0x010 , 1 , 2 ) , ( None , None , ( ' SetOption ' , ' " SetOption2 {} " .format($) ' ) ) ) ,
' mqtt_enabled ' : ( ' <L ' , ( 0x010 , 1 , 3 ) , ( None , None , ( ' SetOption ' , ' " SetOption3 {} " .format($) ' ) ) ) ,
' mqtt_response ' : ( ' <L ' , ( 0x010 , 1 , 4 ) , ( None , None , ( ' SetOption ' , ' " SetOption4 {} " .format($) ' ) ) ) ,
' mqtt_power_retain ' : ( ' <L ' , ( 0x010 , 1 , 5 ) , ( None , None , ( ' MQTT ' , ' " PowerRetain {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' mqtt_button_retain ' : ( ' <L ' , ( 0x010 , 1 , 6 ) , ( None , None , ( ' MQTT ' , ' " ButtonRetain {} " .format($) ' ) ) ) ,
' mqtt_switch_retain ' : ( ' <L ' , ( 0x010 , 1 , 7 ) , ( None , None , ( ' MQTT ' , ' " SwitchRetain {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' temperature_conversion ' : ( ' <L ' , ( 0x010 , 1 , 8 ) , ( None , None , ( ' SetOption ' , ' " SetOption8 {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' mqtt_sensor_retain ' : ( ' <L ' , ( 0x010 , 1 , 9 ) , ( None , None , ( ' MQTT ' , ' " SensorRetain {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' mqtt_offline ' : ( ' <L ' , ( 0x010 , 1 , 10 ) , ( None , None , ( ' SetOption ' , ' " SetOption10 {} " .format($) ' ) ) ) ,
' button_swap ' : ( ' <L ' , ( 0x010 , 1 , 11 ) , ( None , None , ( ' SetOption ' , ' " SetOption11 {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' stop_flash_rotate ' : ( ' <L ' , ( 0x010 , 1 , 12 ) , ( None , None , ( ' Management ' , ' " SetOption12 {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' button_single ' : ( ' <L ' , ( 0x010 , 1 , 13 ) , ( None , None , ( ' SetOption ' , ' " SetOption13 {} " .format($) ' ) ) ) ,
' interlock ' : ( ' <L ' , ( 0x010 , 1 , 14 ) , ( None , None , ( ' SetOption ' , ' " SetOption14 {} " .format($) ' ) ) ) ,
' pwm_control ' : ( ' <L ' , ( 0x010 , 1 , 15 ) , ( None , None , ( ' SetOption ' , ' " SetOption15 {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' ws_clock_reverse ' : ( ' <L ' , ( 0x010 , 1 , 16 ) , ( None , None , ( ' SetOption ' , ' " SetOption16 {} " .format($) ' ) ) ) ,
' decimal_text ' : ( ' <L ' , ( 0x010 , 1 , 17 ) , ( None , None , ( ' SetOption ' , ' " SetOption17 {} " .format($) ' ) ) ) ,
2019-04-17 17:40:47 +01:00
} , 0x010 , ( None , None , ( ' * ' , None ) ) , ( None , None ) ) ,
2018-11-12 15:08:09 +00:00
' save_data ' : ( ' <h ' , 0x014 , ( None , ' 0 <= $ <= 3600 ' , ( ' Management ' , ' " SaveData {} " .format($) ' ) ) ) ,
' timezone ' : ( ' b ' , 0x016 , ( None , ' -13 <= $ <= 13 or $==99 ' , ( ' Management ' , ' " Timezone {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' ota_url ' : ( ' 101s ' , 0x017 , ( None , None , ( ' Management ' , ' " OtaUrl {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' mqtt_prefix ' : ( ' 11s ' , 0x07C , ( [ 3 ] , None , ( ' MQTT ' , ' " Prefix {} {} " .format(#,$) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' seriallog_level ' : ( ' B ' , 0x09E , ( None , ' 0 <= $ <= 5 ' , ( ' Management ' , ' " SerialLog {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' sta_config ' : ( ' B ' , 0x09F , ( None , ' 0 <= $ <= 5 ' , ( ' Wifi ' , ' " WifiConfig {} " .format($) ' ) ) ) ,
' sta_active ' : ( ' B ' , 0x0A0 , ( None , ' 0 <= $ <= 1 ' , ( ' Wifi ' , ' " AP {} " .format($) ' ) ) ) ,
' sta_ssid ' : ( ' 33s ' , 0x0A1 , ( [ 2 ] , None , ( ' Wifi ' , ' " SSId {} {} " .format(#,$) ' ) ) ) ,
' sta_pwd ' : ( ' 65s ' , 0x0E3 , ( [ 2 ] , None , ( ' Wifi ' , ' " Password {} {} " .format(#,$) ' ) ) , ( passwordread , passwordwrite ) ) ,
' hostname ' : ( ' 33s ' , 0x165 , ( None , None , ( ' Wifi ' , ' " Hostname {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' syslog_host ' : ( ' 33s ' , 0x186 , ( None , None , ( ' Management ' , ' " LogHost {} " .format($) ' ) ) ) ,
' syslog_port ' : ( ' <H ' , 0x1A8 , ( None , ' 1 <= $ <= 32766 ' , ( ' Management ' , ' " LogPort {} " .format($) ' ) ) ) ,
' syslog_level ' : ( ' B ' , 0x1AA , ( None , ' 0 <= $ <= 4 ' , ( ' Management ' , ' " SysLog {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' webserver ' : ( ' B ' , 0x1AB , ( None , ' 0 <= $ <= 2 ' , ( ' Wifi ' , ' " WebServer {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' weblog_level ' : ( ' B ' , 0x1AC , ( None , ' 0 <= $ <= 4 ' , ( ' Management ' , ' " WebLog {} " .format($) ' ) ) ) ,
2018-11-16 17:09:02 +00:00
' mqtt_fingerprint ' : ( ' 60s ' , 0x1AD , ( None , None , ( ' MQTT ' , None ) ) ) ,
2018-11-12 15:08:09 +00:00
' mqtt_host ' : ( ' 33s ' , 0x1E9 , ( None , None , ( ' MQTT ' , ' " MqttHost {} " .format($) ' ) ) ) ,
' mqtt_port ' : ( ' <H ' , 0x20A , ( None , None , ( ' MQTT ' , ' " MqttPort {} " .format($) ' ) ) ) ,
' mqtt_client ' : ( ' 33s ' , 0x20C , ( None , None , ( ' MQTT ' , ' " MqttClient {} " .format($) ' ) ) ) ,
' mqtt_user ' : ( ' 33s ' , 0x22D , ( None , None , ( ' MQTT ' , ' " MqttUser {} " .format($) ' ) ) ) ,
' mqtt_pwd ' : ( ' 33s ' , 0x24E , ( None , None , ( ' MQTT ' , ' " MqttPassword {} " .format($) ' ) ) , ( passwordread , passwordwrite ) ) ,
' mqtt_topic ' : ( ' 33s ' , 0x26F , ( None , None , ( ' MQTT ' , ' " FullTopic {} " .format($) ' ) ) ) ,
' button_topic ' : ( ' 33s ' , 0x290 , ( None , None , ( ' MQTT ' , ' " ButtonTopic {} " .format($) ' ) ) ) ,
' mqtt_grptopic ' : ( ' 33s ' , 0x2B1 , ( None , None , ( ' MQTT ' , ' " GroupTopic {} " .format($) ' ) ) ) ,
2018-11-16 17:09:02 +00:00
' mqtt_fingerprinth ' : ( ' B ' , 0x2D2 , ( [ 20 ] , None , ( ' MQTT ' , None ) ) ) ,
2018-11-12 15:08:09 +00:00
' pwm_frequency ' : ( ' <H ' , 0x2E6 , ( None , ' $==1 or 100 <= $ <= 4000 ' , ( ' Management ' , ' " PwmFrequency {} " .format($) ' ) ) ) ,
2018-10-02 12:42:21 +01:00
' power ' : ( {
2019-05-11 12:46:58 +01:00
' power1 ' : ( ' <L ' , ( 0x2E8 , 1 , 0 ) , ( None , None , ( ' Control ' , ' " Power1 {} " .format($) ' ) ) ) ,
' power2 ' : ( ' <L ' , ( 0x2E8 , 1 , 1 ) , ( None , None , ( ' Control ' , ' " Power2 {} " .format($) ' ) ) ) ,
' power3 ' : ( ' <L ' , ( 0x2E8 , 1 , 2 ) , ( None , None , ( ' Control ' , ' " Power3 {} " .format($) ' ) ) ) ,
' power4 ' : ( ' <L ' , ( 0x2E8 , 1 , 3 ) , ( None , None , ( ' Control ' , ' " Power4 {} " .format($) ' ) ) ) ,
' power5 ' : ( ' <L ' , ( 0x2E8 , 1 , 4 ) , ( None , None , ( ' Control ' , ' " Power5 {} " .format($) ' ) ) ) ,
' power6 ' : ( ' <L ' , ( 0x2E8 , 1 , 5 ) , ( None , None , ( ' Control ' , ' " Power6 {} " .format($) ' ) ) ) ,
' power7 ' : ( ' <L ' , ( 0x2E8 , 1 , 6 ) , ( None , None , ( ' Control ' , ' " Power7 {} " .format($) ' ) ) ) ,
' power8 ' : ( ' <L ' , ( 0x2E8 , 1 , 7 ) , ( None , None , ( ' Control ' , ' " Power8 {} " .format($) ' ) ) ) ,
} , 0x2E8 , ( None , None , ( ' Control ' , None ) ) , ( None , None ) ) ,
2018-11-12 15:08:09 +00:00
' pwm_value ' : ( ' <H ' , 0x2EC , ( [ 5 ] , ' 0 <= $ <= 1023 ' , ( ' Management ' , ' " Pwm {} {} " .format(#,$) ' ) ) ) ,
' altitude ' : ( ' <h ' , 0x2F6 , ( None , ' -30000 <= $ <= 30000 ' , ( ' Sensor ' , ' " Altitude {} " .format($) ' ) ) ) ,
' tele_period ' : ( ' <H ' , 0x2F8 , ( None , ' 0 <= $ <= 1 or 10 <= $ <= 3600 ' , ( ' MQTT ' , ' " TelePeriod {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' ledstate ' : ( ' B ' , 0x2FB , ( None , ' 0 <= ($ & 0x7) <= 7 ' , ( ' Control ' , ' " LedState {} " .format(($ & 0x7)) ' ) ) ) ,
2018-11-14 07:03:55 +00:00
' param ' : ( ' B ' , 0x2FC , ( [ 23 ] , None , ( ' SetOption ' , ' " SetOption {} {} " .format(#+31,$) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' state_text ' : ( ' 11s ' , 0x313 , ( [ 4 ] , None , ( ' MQTT ' , ' " StateText {} {} " .format(#,$) ' ) ) ) ,
' domoticz_update_timer ' : ( ' <H ' , 0x340 , ( None , ' 0 <= $ <= 3600 ' , ( ' Domoticz ' , ' " DomoticzUpdateTimer {} " .format($) ' ) ) ) ,
' pwm_range ' : ( ' <H ' , 0x342 , ( None , ' $==1 or 255 <= $ <= 1023 ' , ( ' Management ' , ' " PwmRange {} " .format($) ' ) ) ) ,
' domoticz_relay_idx ' : ( ' <L ' , 0x344 , ( [ 4 ] , None , ( ' Domoticz ' , ' " DomoticzIdx {} {} " .format(#,$) ' ) ) ) ,
' domoticz_key_idx ' : ( ' <L ' , 0x354 , ( [ 4 ] , None , ( ' Domoticz ' , ' " DomoticzKeyIdx {} {} " .format(#,$) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' energy_power_calibration ' : ( ' <L ' , 0x364 , ( None , None , ( ' Power ' , ' " PowerSet {} " .format($) ' ) ) ) ,
' energy_voltage_calibration ' : ( ' <L ' , 0x368 , ( None , None , ( ' Power ' , ' " VoltageSet {} " .format($) ' ) ) ) ,
' energy_current_calibration ' : ( ' <L ' , 0x36C , ( None , None , ( ' Power ' , ' " CurrentSet {} " .format($) ' ) ) ) ,
' energy_kWhtoday ' : ( ' <L ' , 0x370 , ( None , ' 0 <= $ <= 4250000 ' , ( ' Power ' , ' " EnergyReset1 {} " .format(int(round(float($)/100))) ' ) ) ) ,
' energy_kWhyesterday ' : ( ' <L ' , 0x374 , ( None , ' 0 <= $ <= 4250000 ' , ( ' Power ' , ' " EnergyReset2 {} " .format(int(round(float($)/100))) ' ) ) ) ,
' energy_kWhdoy ' : ( ' <H ' , 0x378 , ( None , None , ( ' Power ' , None ) ) ) ,
' energy_min_power ' : ( ' <H ' , 0x37A , ( None , None , ( ' Power ' , ' " PowerLow {} " .format($) ' ) ) ) ,
' energy_max_power ' : ( ' <H ' , 0x37C , ( None , None , ( ' Power ' , ' " PowerHigh {} " .format($) ' ) ) ) ,
' energy_min_voltage ' : ( ' <H ' , 0x37E , ( None , None , ( ' Power ' , ' " VoltageLow {} " .format($) ' ) ) ) ,
' energy_max_voltage ' : ( ' <H ' , 0x380 , ( None , None , ( ' Power ' , ' " VoltageHigh {} " .format($) ' ) ) ) ,
' energy_min_current ' : ( ' <H ' , 0x382 , ( None , None , ( ' Power ' , ' " CurrentLow {} " .format($) ' ) ) ) ,
' energy_max_current ' : ( ' <H ' , 0x384 , ( None , None , ( ' Power ' , ' " CurrentHigh {} " .format($) ' ) ) ) ,
' energy_max_power_limit ' : ( ' <H ' , 0x386 , ( None , None , ( ' Power ' , ' " MaxPower {} " .format($) ' ) ) ) ,
' energy_max_power_limit_hold ' : ( ' <H ' , 0x388 , ( None , None , ( ' Power ' , ' " MaxPowerHold {} " .format($) ' ) ) ) ,
' energy_max_power_limit_window ' : ( ' <H ' , 0x38A , ( None , None , ( ' Power ' , ' " MaxPowerWindow {} " .format($) ' ) ) ) ,
' energy_max_power_safe_limit ' : ( ' <H ' , 0x38C , ( None , None , ( ' Power ' , ' " SavePower {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
' energy_max_power_safe_limit_hold ' :
2019-05-11 12:46:58 +01:00
( ' <H ' , 0x38E , ( None , None , ( ' Power ' , ' " SavePowerHold {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
' energy_max_power_safe_limit_window ' :
2019-05-11 12:46:58 +01:00
( ' <H ' , 0x390 , ( None , None , ( ' Power ' , ' " SavePowerWindow {} " .format($) ' ) ) ) ,
' energy_max_energy ' : ( ' <H ' , 0x392 , ( None , None , ( ' Power ' , ' " MaxEnergy {} " .format($) ' ) ) ) ,
' energy_max_energy_start ' : ( ' <H ' , 0x394 , ( None , None , ( ' Power ' , ' " MaxEnergyStart {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' mqtt_retry ' : ( ' <H ' , 0x396 , ( None , ' 10 <= $ <= 32000 ' , ( ' MQTT ' , ' " MqttRetry {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' poweronstate ' : ( ' B ' , 0x398 , ( None , ' 0 <= $ <= 5 ' , ( ' Control ' , ' " PowerOnState {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' last_module ' : ( ' B ' , 0x399 , ( None , None , ( ' System ' , None ) ) ) ,
2019-05-11 12:46:58 +01:00
' blinktime ' : ( ' <H ' , 0x39A , ( None , ' 2 <= $ <= 3600 ' , ( ' Control ' , ' " BlinkTime {} " .format($) ' ) ) ) ,
' blinkcount ' : ( ' <H ' , 0x39C , ( None , ' 0 <= $ <= 32000 ' , ( ' Control ' , ' " BlinkCount {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' friendlyname ' : ( ' 33s ' , 0x3AC , ( [ 4 ] , None , ( ' Management ' , ' " FriendlyName {} {} " .format(#,$) ' ) ) ) ,
' switch_topic ' : ( ' 33s ' , 0x430 , ( None , None , ( ' MQTT ' , ' " SwitchTopic {} " .format($) ' ) ) ) ,
' sleep ' : ( ' B ' , 0x453 , ( None , ' 0 <= $ <= 250 ' , ( ' Management ' , ' " Sleep {} " .format($) ' ) ) ) ,
' domoticz_switch_idx ' : ( ' <H ' , 0x454 , ( [ 4 ] , None , ( ' Domoticz ' , ' " DomoticzSwitchIdx {} {} " .format(#,$) ' ) ) ) ,
' domoticz_sensor_idx ' : ( ' <H ' , 0x45C , ( [ 12 ] , None , ( ' Domoticz ' , ' " DomoticzSensorIdx {} {} " .format(#,$) ' ) ) ) ,
' module ' : ( ' B ' , 0x474 , ( None , None , ( ' Management ' , ' " Module {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' ws_color ' : ( ' B ' , 0x475 , ( [ 4 , 3 ] , None , ( ' Light ' , None ) ) ) ,
' ws_width ' : ( ' B ' , 0x481 , ( [ 3 ] , None , ( ' Light ' , None ) ) ) ,
2018-11-12 15:08:09 +00:00
' my_gp ' : ( ' B ' , 0x484 , ( [ 18 ] , None , ( ' Management ' , ' " Gpio {} {} " .format(#,$) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' light_pixels ' : ( ' <H ' , 0x496 , ( None , ' 1 <= $ <= 512 ' , ( ' Light ' , ' " Pxels {} " .format($) ' ) ) ) ,
' light_color ' : ( ' B ' , 0x498 , ( [ 5 ] , None , ( ' Light ' , None ) ) ) ,
' light_correction ' : ( ' B ' , 0x49D , ( None , ' 0 <= $ <= 1 ' , ( ' Light ' , ' " LedTable {} " .format($) ' ) ) ) ,
' light_dimmer ' : ( ' B ' , 0x49E , ( None , ' 0 <= $ <= 100 ' , ( ' Light ' , ' " Wakeup {} " .format($) ' ) ) ) ,
' light_fade ' : ( ' B ' , 0x4A1 , ( None , ' 0 <= $ <= 1 ' , ( ' Light ' , ' " Fade {} " .format($) ' ) ) ) ,
' light_speed ' : ( ' B ' , 0x4A2 , ( None , ' 1 <= $ <= 20 ' , ( ' Light ' , ' " Speed {} " .format($) ' ) ) ) ,
' light_scheme ' : ( ' B ' , 0x4A3 , ( None , None , ( ' Light ' , ' " Scheme {} " .format($) ' ) ) ) ,
' light_width ' : ( ' B ' , 0x4A4 , ( None , ' 0 <= $ <= 4 ' , ( ' Light ' , ' " Width {} " .format($) ' ) ) ) ,
' light_wakeup ' : ( ' <H ' , 0x4A6 , ( None , ' 0 <= $ <= 3100 ' , ( ' Light ' , ' " WakeUpDuration {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' web_password ' : ( ' 33s ' , 0x4A9 , ( None , None , ( ' Wifi ' , ' " WebPassword {} " .format($) ' ) ) , ( passwordread , passwordwrite ) ) ,
2019-05-11 12:46:58 +01:00
' switchmode ' : ( ' B ' , 0x4CA , ( [ 4 ] , ' 0 <= $ <= 7 ' , ( ' Control ' , ' " SwitchMode {} {} " .format(#,$) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' ntp_server ' : ( ' 33s ' , 0x4CE , ( [ 3 ] , None , ( ' Wifi ' , ' " NtpServer {} {} " .format(#,$) ' ) ) ) ,
' ina219_mode ' : ( ' B ' , 0x531 , ( None , ' 0 <= $ <= 7 ' , ( ' Sensor ' , ' " Sensor13 {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' pulse_timer ' : ( ' <H ' , 0x532 , ( [ 8 ] , ' 0 <= $ <= 64900 ' , ( ' Control ' , ' " PulseTime {} {} " .format(#,$) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' ip_address ' : ( ' <L ' , 0x544 , ( [ 4 ] , None , ( ' Wifi ' , ' " IPAddress {} {} " .format(#,$) ' ) ) , ( " socket.inet_ntoa(struct.pack( ' <L ' , $)) " , " struct.unpack( ' <L ' , socket.inet_aton($))[0] " ) ) ,
2019-05-11 12:46:58 +01:00
' energy_kWhtotal ' : ( ' <L ' , 0x554 , ( None , ' 0 <= $ <= 4250000000 ' , ( ' Power ' , ' " EnergyReset3 {} " .format(int(round(float($)/100))) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' mqtt_fulltopic ' : ( ' 100s ' , 0x558 , ( None , None , ( ' MQTT ' , ' " FullTopic {} " .format($) ' ) ) ) ,
2018-10-02 12:42:21 +01:00
' flag2 ' : ( {
2019-05-11 12:46:58 +01:00
' current_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 15 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Power ' , ' " AmpRes {} " .format($) ' ) ) ) ,
' voltage_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 17 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Power ' , ' " VoltRes {} " .format($) ' ) ) ) ,
' wattage_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 19 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Power ' , ' " WattRes {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' emulation ' : ( ' <L ' , ( 0x5BC , 2 , 21 ) , ( None , ' 0 <= $ <= 2 ' , ( ' Management ' , ' " Emulation {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' energy_resolution ' : ( ' <L ' , ( 0x5BC , 3 , 23 ) , ( None , ' 0 <= $ <= 5 ' , ( ' Power ' , ' " EnergyRes {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' pressure_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 26 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Sensor ' , ' " PressRes {} " .format($) ' ) ) ) ,
' humidity_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 28 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Sensor ' , ' " HumRes {} " .format($) ' ) ) ) ,
' temperature_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 30 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Sensor ' , ' " TempRes {} " .format($) ' ) ) ) ,
2019-04-17 17:40:47 +01:00
} , 0x5BC , ( None , None , ( ' * ' , None ) ) , ( None , None ) ) ,
2018-11-12 15:08:09 +00:00
' pulse_counter ' : ( ' <L ' , 0x5C0 , ( [ 4 ] , None , ( ' Sensor ' , ' " Counter {} {} " .format(#,$) ' ) ) ) ,
' pulse_counter_type ' : ( ' <H ' , 0x5D0 , ( None , None , ( ' Sensor ' , ' " CounterType {} " .format($) ' ) ) ) ,
' pulse_counter_type ' : ( {
' pulse_counter_type1 ' : ( ' <H ' , ( 0x5D0 , 1 , 0 ) , ( None , None , ( ' Sensor ' , ' " CounterType1 {} " .format($) ' ) ) ) ,
' pulse_counter_type2 ' : ( ' <H ' , ( 0x5D0 , 1 , 1 ) , ( None , None , ( ' Sensor ' , ' " CounterType2 {} " .format($) ' ) ) ) ,
' pulse_counter_type3 ' : ( ' <H ' , ( 0x5D0 , 1 , 2 ) , ( None , None , ( ' Sensor ' , ' " CounterType3 {} " .format($) ' ) ) ) ,
' pulse_counter_type4 ' : ( ' <H ' , ( 0x5D0 , 1 , 3 ) , ( None , None , ( ' Sensor ' , ' " CounterType4 {} " .format($) ' ) ) ) ,
2019-04-17 17:40:47 +01:00
} , 0x5D0 , ( None , None , ( ' Sensor ' , None ) ) , ( None , None ) ) ,
2018-11-12 15:08:09 +00:00
' pulse_counter_debounce ' : ( ' <H ' , 0x5D2 , ( None , ' 0 <= $ <= 3200 ' , ( ' Sensor ' , ' " CounterDebounce {} " .format($) ' ) ) ) ,
' rf_code ' : ( ' B ' , 0x5D4 , ( [ 17 , 9 ] , None , ( ' SonoffRF ' , None ) ) , ' " 0x {:02x} " .format($) ' ) ,
2018-10-14 12:18:16 +01:00
}
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_5_11_0 = copy . deepcopy ( Setting_5_10_0 )
2018-11-12 15:08:09 +00:00
Setting_5_11_0 . update ( {
' display_model ' : ( ' B ' , 0x2D2 , ( None , ' 0 <= $ <= 16 ' , ( ' Display ' , ' " Model {} " .format($) ' ) ) ) ,
' display_mode ' : ( ' B ' , 0x2D3 , ( None , ' 0 <= $ <= 5 ' , ( ' Display ' , ' " Mode {} " .format($) ' ) ) ) ,
' display_refresh ' : ( ' B ' , 0x2D4 , ( None , ' 1 <= $ <= 7 ' , ( ' Display ' , ' " Refresh {} " .format($) ' ) ) ) ,
' display_rows ' : ( ' B ' , 0x2D5 , ( None , ' 1 <= $ <= 32 ' , ( ' Display ' , ' " Rows {} " .format($) ' ) ) ) ,
' display_cols ' : ( ' B ' , 0x2D6 , ( [ 2 ] , ' 1 <= $ <= 40 ' , ( ' Display ' , ' " Cols {} {} " .format(#,$) ' ) ) ) ,
' display_address ' : ( ' B ' , 0x2D8 , ( [ 8 ] , None , ( ' Display ' , ' " Address {} {} " .format(#,$) ' ) ) ) ,
' display_dimmer ' : ( ' B ' , 0x2E0 , ( None , ' 0 <= $ <= 100 ' , ( ' Display ' , ' " Dimmer {} " .format($) ' ) ) ) ,
' display_size ' : ( ' B ' , 0x2E1 , ( None , ' 1 <= $ <= 4 ' , ( ' Display ' , ' " Size {} " .format($) ' ) ) ) ,
} )
2018-11-05 08:09:53 +00:00
Setting_5_11_0 [ ' flag ' ] [ 0 ] . update ( {
2019-05-11 12:46:58 +01:00
' light_signal ' : ( ' <L ' , ( 0x010 , 1 , 18 ) , ( None , None , ( ' SetOption ' , ' " SetOption18 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-10-27 09:37:33 +01:00
Setting_5_11_0 . pop ( ' mqtt_fingerprinth ' , None )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_5_12_0 = copy . deepcopy ( Setting_5_11_0 )
2018-11-05 08:09:53 +00:00
Setting_5_12_0 [ ' flag ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' hass_discovery ' : ( ' <L ' , ( 0x010 , 1 , 19 ) , ( None , None , ( ' SetOption ' , ' " SetOption19 {} " .format($) ' ) ) ) ,
2019-05-11 12:46:58 +01:00
' not_power_linked ' : ( ' <L ' , ( 0x010 , 1 , 20 ) , ( None , None , ( ' SetOption ' , ' " SetOption20 {} " .format($) ' ) ) ) ,
' no_power_on_check ' : ( ' <L ' , ( 0x010 , 1 , 21 ) , ( None , None , ( ' SetOption ' , ' " SetOption21 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_5_13_1 = copy . deepcopy ( Setting_5_12_0 )
2018-11-05 08:09:53 +00:00
Setting_5_13_1 [ ' flag ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' mqtt_serial ' : ( ' <L ' , ( 0x010 , 1 , 22 ) , ( None , None , ( ' SetOption ' , ' " SetOption22 {} " .format($) ' ) ) ) ,
' rules_enabled ' : ( ' <L ' , ( 0x010 , 1 , 23 ) , ( None , None , ( ' SetOption ' , ' " SetOption23 {} " .format($) ' ) ) ) ,
' rules_once ' : ( ' <L ' , ( 0x010 , 1 , 24 ) , ( None , None , ( ' SetOption ' , ' " SetOption24 {} " .format($) ' ) ) ) ,
' knx_enabled ' : ( ' <L ' , ( 0x010 , 1 , 25 ) , ( None , None , ( ' KNX ' , ' " KNX_ENABLED {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
Setting_5_13_1 . update ( {
' baudrate ' : ( ' B ' , 0x09D , ( None , None , ( ' Serial ' , ' " Baudrate {} " .format($) ' ) ) , ( ' $ * 1200 ' , ' $ / 1200 ' ) ) ,
2018-11-16 17:09:02 +00:00
' mqtt_fingerprint ' : ( ' 20s ' , 0x1AD , ( [ 2 ] , None , ( ' MQTT ' , MqttFingerprint ) ) ) ,
2019-05-11 12:46:58 +01:00
' energy_power_delta ' : ( ' B ' , 0x33F , ( None , None , ( ' Power ' , ' " PowerDelta {} " .format($) ' ) ) ) ,
' light_rotation ' : ( ' <H ' , 0x39E , ( None , None , ( ' Light ' , ' " Rotation {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' serial_delimiter ' : ( ' B ' , 0x451 , ( None , None , ( ' Serial ' , ' " SerialDelimiter {} " .format($) ' ) ) ) ,
' sbaudrate ' : ( ' B ' , 0x452 , ( None , None , ( ' Serial ' , ' " SBaudrate {} " .format($) ' ) ) , ( ' $ * 1200 ' , ' $ / 1200 ' ) ) ,
' knx_GA_registered ' : ( ' B ' , 0x4A5 , ( None , None , ( ' KNX ' , None ) ) ) ,
' knx_CB_registered ' : ( ' B ' , 0x4A8 , ( None , None , ( ' KNX ' , None ) ) ) ,
' timer ' : ( {
2019-05-11 12:46:58 +01:00
' _ ' : ( ' <L ' , 0x670 , ( None , None , ( ' Timer ' , ' " Timer {} {{ \\ \" Arm \\ \" : {arm} , \\ \" Mode \\ \" : {mode} , \\ \" Time \\ \" : \\ \" {tsign} {time} \\ \" , \\ \" Window \\ \" : {window} , \\ \" Days \\ \" : \\ \" {days} \\ \" , \\ \" Repeat \\ \" : {repeat} , \\ \" Output \\ \" : {device} , \\ \" Action \\ \" : {power} }} " .format(#, arm=bitsRead($,31),mode=bitsRead($,29,2),tsign= " - " if bitsRead($,29,2)>0 and bitsRead($,0,11)>(12*60) else " " ,time=time.strftime( " % H: % M " ,time.gmtime((bitsRead($,0,11) if bitsRead($,29,2)==0 else bitsRead($,0,11) if bitsRead($,0,11)<=(12*60) else bitsRead($,0,11)-(12*60))*60)),window=bitsRead($,11,4),repeat=bitsRead($,15),days= " {:07b} " .format(bitsRead($,16,7))[::-1],device=bitsRead($,23,4)+1,power=bitsRead($,27,2) ) ' ) ) , ( ' " 0x {:08x} " .format($) ' , False ) ) ,
' time ' : ( ' <L ' , ( 0x670 , 11 , 0 ) , ( None , ' 0 <= $ < 1440 ' , ( ' Timer ' , None ) ) ) ,
' window ' : ( ' <L ' , ( 0x670 , 4 , 11 ) , ( None , None , ( ' Timer ' , None ) ) ) ,
' repeat ' : ( ' <L ' , ( 0x670 , 1 , 15 ) , ( None , None , ( ' Timer ' , None ) ) ) ,
' days ' : ( ' <L ' , ( 0x670 , 7 , 16 ) , ( None , None , ( ' Timer ' , None ) ) , ' " 0b {:07b} " .format($) ' ) ,
' device ' : ( ' <L ' , ( 0x670 , 4 , 23 ) , ( None , None , ( ' Timer ' , None ) ) ) ,
' power ' : ( ' <L ' , ( 0x670 , 2 , 27 ) , ( None , None , ( ' Timer ' , None ) ) ) ,
' mode ' : ( ' <L ' , ( 0x670 , 2 , 29 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Timer ' , None ) ) ) ,
' arm ' : ( ' <L ' , ( 0x670 , 1 , 31 ) , ( None , None , ( ' Timer ' , None ) ) ) ,
} , 0x670 , ( [ 16 ] , None , ( ' Timer ' , None ) ) ) ,
' latitude ' : ( ' i ' , 0x6B0 , ( None , None , ( ' Timer ' , ' " Latitude {} " .format($) ' ) ) , ( ' float($) / 1000000 ' , ' int($ * 1000000) ' ) ) ,
' longitude ' : ( ' i ' , 0x6B4 , ( None , None , ( ' Timer ' , ' " Longitude {} " .format($) ' ) ) , ( ' float($) / 1000000 ' , ' int($ * 1000000) ' ) ) ,
2018-11-12 15:08:09 +00:00
' knx_physsical_addr ' : ( ' <H ' , 0x6B8 , ( None , None , ( ' KNX ' , None ) ) ) ,
' knx_GA_addr ' : ( ' <H ' , 0x6BA , ( [ 10 ] , None , ( ' KNX ' , None ) ) ) ,
' knx_CB_addr ' : ( ' <H ' , 0x6CE , ( [ 10 ] , None , ( ' KNX ' , None ) ) ) ,
' knx_GA_param ' : ( ' B ' , 0x6E2 , ( [ 10 ] , None , ( ' KNX ' , None ) ) ) ,
' knx_CB_param ' : ( ' B ' , 0x6EC , ( [ 10 ] , None , ( ' KNX ' , None ) ) ) ,
2019-05-11 12:46:58 +01:00
' rules ' : ( ' 512s ' , 0x800 , ( None , None , ( ' Rules ' , ' " Rule {} " .format( " \\ " " if len($)==0 else $) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
} )
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_5_14_0 = copy . deepcopy ( Setting_5_13_1 )
2018-11-05 08:09:53 +00:00
Setting_5_14_0 [ ' flag ' ] [ 0 ] . update ( {
2019-05-11 12:46:58 +01:00
' device_index_enable ' : ( ' <L ' , ( 0x010 , 1 , 26 ) , ( None , None , ( ' SetOption ' , ' " SetOption26 {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
} )
Setting_5_14_0 [ ' flag ' ] [ 0 ] . pop ( ' rules_once ' , None )
Setting_5_14_0 . update ( {
' tflag ' : ( {
' hemis ' : ( ' <H ' , ( 0x2E2 , 1 , 0 ) , ( None , None , ( ' Management ' , None ) ) ) ,
' week ' : ( ' <H ' , ( 0x2E2 , 3 , 1 ) , ( None , ' 0 <= $ <= 4 ' , ( ' Management ' , None ) ) ) ,
' month ' : ( ' <H ' , ( 0x2E2 , 4 , 4 ) , ( None , ' 1 <= $ <= 12 ' , ( ' Management ' , None ) ) ) ,
' dow ' : ( ' <H ' , ( 0x2E2 , 3 , 8 ) , ( None , ' 1 <= $ <= 7 ' , ( ' Management ' , None ) ) ) ,
' hour ' : ( ' <H ' , ( 0x2E2 , 5 , 11 ) , ( None , ' 0 <= $ <= 23 ' , ( ' Management ' , None ) ) ) ,
2019-04-17 17:40:47 +01:00
} , 0x2E2 , ( [ 2 ] , None , ( ' Management ' , None ) ) , ( None , None ) ) ,
2018-11-14 07:03:55 +00:00
' param ' : ( ' B ' , 0x2FC , ( [ 18 ] , None , ( ' SetOption ' , ' " SetOption {} {} " .format(#+31,$) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' toffset ' : ( ' <h ' , 0x30E , ( [ 2 ] , None , ( ' Management ' , ' " {cmnd} {hemis} , {week} , {month} , {dow} , {hour} , {toffset} " .format(cmnd= " TimeSTD " if idx==1 else " TimeDST " , hemis=@[ " tflag " ][#-1][ " hemis " ], week=@[ " tflag " ][#-1][ " week " ], month=@[ " tflag " ][#-1][ " month " ], dow=@[ " tflag " ][#-1][ " dow " ], hour=@[ " tflag " ][#-1][ " hour " ], toffset=value) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_0_0 = copy . deepcopy ( Setting_5_14_0 )
2018-10-14 12:18:16 +01:00
Setting_6_0_0 . update ( {
2018-11-12 15:08:09 +00:00
' cfg_holder ' : ( ' <H ' , 0x000 , ( None , None , ( ' System ' , None ) ) , ) ,
' cfg_size ' : ( ' <H ' , 0x002 , ( None , None , ( INTERNAL , None ) ) , ( None , False ) ) ,
' bootcount ' : ( ' <H ' , 0x00C , ( None , None , ( ' System ' , None ) ) , ( None , False ) ) ,
' cfg_crc ' : ( ' <H ' , 0x00E , ( None , None , ( INTERNAL , None ) ) , ' " 0x {:04x} " .format($) ' ) ,
2018-10-02 12:42:21 +01:00
' rule_enabled ' : ( {
2019-05-11 12:46:58 +01:00
' rule1 ' : ( ' B ' , ( 0x49F , 1 , 0 ) , ( None , None , ( ' Rules ' , ' " Rule1 {} " .format($) ' ) ) ) ,
' rule2 ' : ( ' B ' , ( 0x49F , 1 , 1 ) , ( None , None , ( ' Rules ' , ' " Rule2 {} " .format($) ' ) ) ) ,
' rule3 ' : ( ' B ' , ( 0x49F , 1 , 2 ) , ( None , None , ( ' Rules ' , ' " Rule3 {} " .format($) ' ) ) ) ,
} , 0x49F , ( None , None , ( ' Rules ' , None ) ) , ( None , None ) ) ,
2018-10-02 12:42:21 +01:00
' rule_once ' : ( {
2019-05-11 12:46:58 +01:00
' rule1 ' : ( ' B ' , ( 0x4A0 , 1 , 0 ) , ( None , None , ( ' Rules ' , ' " Rule1 {} " .format($+4) ' ) ) ) ,
' rule2 ' : ( ' B ' , ( 0x4A0 , 1 , 1 ) , ( None , None , ( ' Rules ' , ' " Rule2 {} " .format($+4) ' ) ) ) ,
' rule3 ' : ( ' B ' , ( 0x4A0 , 1 , 2 ) , ( None , None , ( ' Rules ' , ' " Rule3 {} " .format($+4) ' ) ) ) ,
} , 0x4A0 , ( None , None , ( ' Rules ' , None ) ) , ( None , None ) ) ,
' mems ' : ( ' 10s ' , 0x7CE , ( [ 5 ] , None , ( ' Rules ' , ' " Mem {} {} " .format(#, " \\ " " if len($)==0 else $) ' ) ) ) ,
' rules ' : ( ' 512s ' , 0x800 , ( [ 3 ] , None , ( ' Rules ' , ' " Rule {} {} " .format(#, " \\ " " if len($)==0 else $) ' ) ) ) ,
2018-10-14 12:18:16 +01:00
} )
2018-11-05 08:09:53 +00:00
Setting_6_0_0 [ ' flag ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' knx_enable_enhancement ' : ( ' <L ' , ( 0x010 , 1 , 27 ) , ( None , None , ( ' KNX ' , ' " KNX_ENHANCED {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_1_1 = copy . deepcopy ( Setting_6_0_0 )
2018-11-12 15:08:09 +00:00
Setting_6_1_1 . update ( {
' flag3 ' : ( ' <L ' , 0x3A0 , ( None , None , ( ' System ' , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
2019-05-11 12:46:58 +01:00
' switchmode ' : ( ' B ' , 0x3A4 , ( [ 8 ] , ' 0 <= $ <= 7 ' , ( ' Control ' , ' " SwitchMode {} {} " .format(#,$) ' ) ) ) ,
2018-10-02 12:42:21 +01:00
' mcp230xx_config ' : ( {
2019-05-11 12:46:58 +01:00
' _ ' : ( ' <L ' , 0x6F6 , ( None , None , ( ' Devices ' , ' " Sensor29 {pin} , {pinmode} , {pullup} , {intmode} " .format(pin=#-1, pinmode=@[ " mcp230xx_config " ][#-1][ " pinmode " ], pullup=@[ " mcp230xx_config " ][#-1][ " pullup " ], intmode=@[ " mcp230xx_config " ][#-1][ " int_report_mode " ]) ' ) ) , ( ' " 0x {:08x} " .format($) ' , False ) ) ,
' pinmode ' : ( ' <L ' , ( 0x6F6 , 3 , 0 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
' pullup ' : ( ' <L ' , ( 0x6F6 , 1 , 3 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
' saved_state ' : ( ' <L ' , ( 0x6F6 , 1 , 4 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
' int_report_mode ' : ( ' <L ' , ( 0x6F6 , 2 , 5 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
' int_report_defer ' : ( ' <L ' , ( 0x6F6 , 4 , 7 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
' int_count_en ' : ( ' <L ' , ( 0x6F6 , 1 , 11 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
} , 0x6F6 , ( [ 16 ] , None , ( ' Devices ' , None ) ) , ( None , None ) ) ,
2018-11-12 15:08:09 +00:00
} )
2018-11-05 08:09:53 +00:00
Setting_6_1_1 [ ' flag ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' rf_receive_decimal ' : ( ' <L ' , ( 0x010 , 1 , 28 ) , ( None , None , ( ' SetOption ' , ' " SetOption28 {} " .format($) ' ) ) ) ,
' ir_receive_decimal ' : ( ' <L ' , ( 0x010 , 1 , 29 ) , ( None , None , ( ' SetOption ' , ' " SetOption29 {} " .format($) ' ) ) ) ,
' hass_light ' : ( ' <L ' , ( 0x010 , 1 , 30 ) , ( None , None , ( ' SetOption ' , ' " SetOption30 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1 = copy . deepcopy ( Setting_6_1_1 )
2018-11-12 15:08:09 +00:00
Setting_6_2_1 . update ( {
2018-10-02 12:42:21 +01:00
' rule_stop ' : ( {
2019-05-11 12:46:58 +01:00
' rule1 ' : ( ' B ' , ( 0x1A7 , 1 , 0 ) , ( None , None , ( ' Rules ' , ' " Rule1 {} " .format($+8) ' ) ) ) ,
' rule2 ' : ( ' B ' , ( 0x1A7 , 1 , 1 ) , ( None , None , ( ' Rules ' , ' " Rule2 {} " .format($+8) ' ) ) ) ,
' rule3 ' : ( ' B ' , ( 0x1A7 , 1 , 2 ) , ( None , None , ( ' Rules ' , ' " Rule3 {} " .format($+8) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
} , 0x1A7 , None ) ,
' display_rotate ' : ( ' B ' , 0x2FA , ( None , ' 0 <= $ <= 3 ' , ( ' Display ' , ' " Rotate {} " .format($) ' ) ) ) ,
' display_font ' : ( ' B ' , 0x312 , ( None , ' 1 <= $ <= 4 ' , ( ' Display ' , ' " Font {} " .format($) ' ) ) ) ,
2018-10-02 12:42:21 +01:00
' flag3 ' : ( {
2019-05-11 12:46:58 +01:00
' timers_enable ' : ( ' <L ' , ( 0x3A0 , 1 , 0 ) , ( None , None , ( ' Timer ' , ' " Timers {} " .format($) ' ) ) ) ,
2018-11-12 15:08:09 +00:00
' user_esp8285_enable ' : ( ' <L ' , ( 0x3A0 , 1 , 31 ) , ( None , None , ( ' System ' , None ) ) ) ,
2019-04-17 17:40:47 +01:00
} , 0x3A0 , ( None , None , ( ' * ' , None ) ) , ( None , None ) ) ,
2019-05-11 12:46:58 +01:00
' button_debounce ' : ( ' <H ' , 0x542 , ( None , ' 40 <= $ <= 1000 ' , ( ' Control ' , ' " ButtonDebounce {} " .format($) ' ) ) ) ,
' switch_debounce ' : ( ' <H ' , 0x66E , ( None , ' 40 <= $ <= 1000 ' , ( ' Control ' , ' " SwitchDebounce {} " .format($) ' ) ) ) ,
' mcp230xx_int_prio ' : ( ' B ' , 0x716 , ( None , None , ( ' Devices ' , None ) ) ) ,
' mcp230xx_int_timer ' : ( ' <H ' , 0x718 , ( None , None , ( ' Devices ' , None ) ) ) ,
2018-11-12 15:08:09 +00:00
} )
2018-11-05 08:09:53 +00:00
Setting_6_2_1 [ ' flag ' ] [ 0 ] . pop ( ' rules_enabled ' , None )
Setting_6_2_1 [ ' flag ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' mqtt_serial_raw ' : ( ' <L ' , ( 0x010 , 1 , 23 ) , ( None , None , ( ' SetOption ' , ' " SetOption23 {} " .format($) ' ) ) ) ,
' global_state ' : ( ' <L ' , ( 0x010 , 1 , 31 ) , ( None , None , ( ' SetOption ' , ' " SetOption31 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
Setting_6_2_1 [ ' flag2 ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
# currently unsupported Tasmota command, should be Sensor32, still needs to implement
' axis_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 13 ) , ( None , None , ( ' System ' , None ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1_2 = copy . deepcopy ( Setting_6_2_1 )
2018-11-05 08:09:53 +00:00
Setting_6_2_1_2 [ ' flag3 ' ] [ 0 ] . update ( {
2018-11-14 07:03:55 +00:00
' user_esp8285_enable ' : ( ' <L ' , ( 0x3A0 , 1 , 1 ) , ( None , None , ( ' SetOption ' , ' " SetOption51 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1_3 = copy . deepcopy ( Setting_6_2_1_2 )
2018-11-05 08:09:53 +00:00
Setting_6_2_1_3 [ ' flag2 ' ] [ 0 ] . update ( {
2019-05-11 12:46:58 +01:00
' frequency_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 11 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Power ' , ' " FreqRes {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
Setting_6_2_1_3 [ ' flag3 ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' time_append_timezone ' : ( ' <L ' , ( 0x3A0 , 1 , 2 ) , ( None , None , ( ' SetOption ' , ' " SetOption52 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1_6 = copy . deepcopy ( Setting_6_2_1_3 )
2018-10-14 12:18:16 +01:00
Setting_6_2_1_6 . update ( {
2019-05-11 12:46:58 +01:00
' energy_power_calibration ' : ( ' <L ' , 0x364 , ( None , None , ( ' Power ' , None ) ) ) ,
' energy_voltage_calibration ' : ( ' <L ' , 0x368 , ( None , None , ( ' Power ' , None ) ) ) ,
' energy_current_calibration ' : ( ' <L ' , 0x36C , ( None , None , ( ' Power ' , None ) ) ) ,
' energy_frequency_calibration ' : ( ' <L ' , 0x7C8 , ( None , ' 45000 < $ < 65000 ' , ( ' Power ' , ' " FrequencySet {} " .format($) ' ) ) ) ,
2018-10-14 12:18:16 +01:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1_10 = copy . deepcopy ( Setting_6_2_1_6 )
2018-10-14 12:18:16 +01:00
Setting_6_2_1_10 . update ( {
2018-11-12 15:08:09 +00:00
' rgbwwTable ' : ( ' B ' , 0x71A , ( [ 5 ] , None , ( ' System ' , None ) ) ) , # RGBWWTable 255,135,70,255,255
2018-10-14 12:18:16 +01:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1_14 = copy . deepcopy ( Setting_6_2_1_10 )
2018-10-14 12:18:16 +01:00
Setting_6_2_1_14 . update ( {
2018-11-12 15:08:09 +00:00
' weight_item ' : ( ' <H ' , 0x7BC , ( None , None , ( ' Management ' , ' " Sensor34 6 {} " .format($) ' ) ) , ( ' int($ * 10) ' , ' float($) / 10 ' ) ) , # undocumented
' weight_max ' : ( ' <H ' , 0x7BE , ( None , None , ( ' Management ' , ' " Sensor34 5 {} " .format($) ' ) ) , ( ' float($) / 1000 ' , ' int($ * 1000) ' ) ) , # undocumented
' weight_reference ' : ( ' <L ' , 0x7C0 , ( None , None , ( ' Management ' , ' " Sensor34 3 {} " .format($) ' ) ) ) , # undocumented
' weight_calibration ' : ( ' <L ' , 0x7C4 , ( None , None , ( ' Management ' , ' " Sensor34 4 {} " .format($) ' ) ) ) , # undocumented
2019-05-11 12:46:58 +01:00
' web_refresh ' : ( ' <H ' , 0x7CC , ( None , ' 1000 <= $ <= 10000 ' , ( ' Wifi ' , ' " WebRefresh {} " .format($) ' ) ) ) , # undocumented
2018-10-14 12:18:16 +01:00
} )
2018-11-05 08:09:53 +00:00
Setting_6_2_1_14 [ ' flag2 ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' weight_resolution ' : ( ' <L ' , ( 0x5BC , 2 , 9 ) , ( None , ' 0 <= $ <= 3 ' , ( ' Management ' , ' " WeightRes {} " .format($) ' ) ) ) , # undocumented
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_2_1_19 = copy . deepcopy ( Setting_6_2_1_14 )
2018-10-27 09:37:33 +01:00
Setting_6_2_1_19 . update ( {
2018-11-12 15:08:09 +00:00
' weight_item ' : ( ' <L ' , 0x7B8 , ( None , None , ( ' Management ' , ' " Sensor34 6 {} " .format($) ' ) ) , ( ' int($ * 10) ' , ' float($) / 10 ' ) ) , # undocumented
2018-10-27 09:37:33 +01:00
} )
2018-11-12 15:08:09 +00:00
Setting_6_2_1_20 = Setting_6_2_1_19
2018-11-05 08:09:53 +00:00
Setting_6_2_1_20 [ ' flag3 ' ] [ 0 ] . update ( {
2018-11-14 07:03:55 +00:00
' gui_hostname_ip ' : ( ' <L ' , ( 0x3A0 , 1 , 3 ) , ( None , None , ( ' SetOption ' , ' " SetOption53 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_3_0 = copy . deepcopy ( Setting_6_2_1_20 )
2018-10-31 06:45:19 +00:00
Setting_6_3_0 . update ( {
2019-05-11 12:46:58 +01:00
' energy_kWhtotal_time ' : ( ' <L ' , 0x7B4 , ( None , None , ( ' System ' , None ) ) ) ,
2018-10-31 06:45:19 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_3_0_2 = copy . deepcopy ( Setting_6_3_0 )
2018-11-05 08:09:53 +00:00
Setting_6_3_0_2 . update ( {
2019-05-11 12:46:58 +01:00
' timezone_minutes ' : ( ' B ' , 0x66D , ( None , None , ( ' System ' , None ) ) ) ,
2018-11-01 13:44:13 +00:00
} )
2018-11-05 08:09:53 +00:00
Setting_6_3_0_2 [ ' flag ' ] [ 0 ] . pop ( ' rules_once ' , None )
Setting_6_3_0_2 [ ' flag ' ] [ 0 ] . update ( {
2018-11-12 15:08:09 +00:00
' pressure_conversion ' : ( ' <L ' , ( 0x010 , 1 , 24 ) , ( None , None , ( ' SetOption ' , ' " SetOption24 {} " .format($) ' ) ) ) ,
2018-11-05 08:09:53 +00:00
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-07 12:42:13 +00:00
Setting_6_3_0_4 = copy . deepcopy ( Setting_6_3_0_2 )
Setting_6_3_0_4 . update ( {
2019-05-11 12:46:58 +01:00
' drivers ' : ( ' <L ' , 0x794 , ( [ 3 ] , None , ( ' System ' , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
' monitors ' : ( ' <L ' , 0x7A0 , ( None , None , ( ' System ' , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
' sensors ' : ( ' <L ' , 0x7A4 , ( [ 3 ] , None , ( ' System ' , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
' displays ' : ( ' <L ' , 0x7B0 , ( None , None , ( ' System ' , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
2018-11-07 12:42:13 +00:00
} )
Setting_6_3_0_4 [ ' flag3 ' ] [ 0 ] . update ( {
2018-11-14 07:03:55 +00:00
' tuya_apply_o20 ' : ( ' <L ' , ( 0x3A0 , 1 , 4 ) , ( None , None , ( ' SetOption ' , ' " SetOption54 {} " .format($) ' ) ) ) ,
2018-11-07 12:42:13 +00:00
} )
2018-11-20 16:06:54 +00:00
# ======================================================================
2018-11-16 17:09:02 +00:00
Setting_6_3_0_8 = copy . deepcopy ( Setting_6_3_0_4 )
Setting_6_3_0_8 [ ' flag3 ' ] [ 0 ] . update ( {
' hass_short_discovery_msg ' : ( ' <L ' , ( 0x3A0 , 1 , 5 ) , ( None , None , ( ' SetOption ' , ' " SetOption55 {} " .format($) ' ) ) ) ,
} )
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-11-20 16:06:54 +00:00
Setting_6_3_0_10 = copy . deepcopy ( Setting_6_3_0_8 )
Setting_6_3_0_10 [ ' flag3 ' ] [ 0 ] . update ( {
' use_wifi_scan ' : ( ' <L ' , ( 0x3A0 , 1 , 6 ) , ( None , None , ( ' SetOption ' , ' " SetOption56 {} " .format($) ' ) ) ) ,
' use_wifi_rescan ' : ( ' <L ' , ( 0x3A0 , 1 , 7 ) , ( None , None , ( ' SetOption ' , ' " SetOption57 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2018-11-27 10:24:19 +00:00
Setting_6_3_0_11 = copy . deepcopy ( Setting_6_3_0_10 )
Setting_6_3_0_11 [ ' flag3 ' ] [ 0 ] . update ( {
' receive_raw ' : ( ' <L ' , ( 0x3A0 , 1 , 8 ) , ( None , None , ( ' SetOption ' , ' " SetOption58 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
Setting_6_3_0_13 = copy . deepcopy ( Setting_6_3_0_11 )
Setting_6_3_0_13 [ ' flag3 ' ] [ 0 ] . update ( {
2018-12-03 07:33:21 +00:00
' hass_tele_on_power ' : ( ' <L ' , ( 0x3A0 , 1 , 9 ) , ( None , None , ( ' SetOption ' , ' " SetOption59 {} " .format($) ' ) ) ) ,
2018-11-27 10:24:19 +00:00
} )
# ======================================================================
Setting_6_3_0_14 = copy . deepcopy ( Setting_6_3_0_13 )
Setting_6_3_0_14 [ ' flag2 ' ] [ 0 ] . update ( {
2019-05-11 12:46:58 +01:00
' calc_resolution ' : ( ' <L ' , ( 0x5BC , 3 , 6 ) , ( None , ' 0 <= $ <= 7 ' , ( ' Rules ' , ' " CalcRes {} " .format($) ' ) ) ) ,
2018-11-27 10:24:19 +00:00
} )
# ======================================================================
2018-12-03 07:33:21 +00:00
Setting_6_3_0_15 = copy . deepcopy ( Setting_6_3_0_14 )
Setting_6_3_0_15 [ ' flag3 ' ] [ 0 ] . update ( {
' sleep_normal ' : ( ' <L ' , ( 0x3A0 , 1 , 10 ) , ( None , None , ( ' SetOption ' , ' " SetOption60 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2018-12-08 09:28:12 +00:00
Setting_6_3_0_16 = copy . deepcopy ( Setting_6_3_0_15 )
Setting_6_3_0_16 [ ' mcp230xx_config ' ] [ 0 ] . update ( {
2019-05-11 12:46:58 +01:00
' int_retain_flag ' : ( ' <L ' , ( 0x6F6 , 1 , 12 ) , ( None , None , ( ' Devices ' , None ) ) ) ,
2018-12-08 09:28:12 +00:00
} )
2018-12-11 07:19:04 +00:00
Setting_6_3_0_16 [ ' flag3 ' ] [ 0 ] . update ( {
' button_switch_force_local ' : ( ' <L ' , ( 0x3A0 , 1 , 11 ) , ( None , None , ( ' SetOption ' , ' " SetOption61 {} " .format($) ' ) ) ) ,
} )
2018-12-08 09:28:12 +00:00
# ======================================================================
2018-12-23 12:38:38 +00:00
Setting_6_4_0_2 = copy . deepcopy ( Setting_6_3_0_16 )
Setting_6_4_0_2 [ ' flag3 ' ] [ 0 ] . pop ( ' hass_short_discovery_msg ' , None )
# ======================================================================
2019-01-04 09:24:46 +00:00
Setting_6_4_1_4 = copy . deepcopy ( Setting_6_4_0_2 )
Setting_6_4_1_4 [ ' flag3 ' ] [ 0 ] . update ( {
' mdns_enabled ' : ( ' <L ' , ( 0x3A0 , 1 , 5 ) , ( None , None , ( ' SetOption ' , ' " SetOption55 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2019-01-07 17:15:11 +00:00
Setting_6_4_1_7 = copy . deepcopy ( Setting_6_4_1_4 )
Setting_6_4_1_7 [ ' flag3 ' ] [ 0 ] . update ( {
' no_pullup ' : ( ' <L ' , ( 0x3A0 , 1 , 12 ) , ( None , None , ( ' SetOption ' , ' " SetOption62 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2019-01-13 16:33:33 +00:00
Setting_6_4_1_8 = copy . deepcopy ( Setting_6_4_1_7 )
Setting_6_4_1_8 [ ' flag3 ' ] [ 0 ] . update ( {
' split_interlock ' : ( ' <L ' , ( 0x3A0 , 1 , 13 ) , ( None , None , ( ' SetOption ' , ' " SetOption63 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2019-01-28 15:40:46 +00:00
Setting_6_4_1_11 = copy . deepcopy ( Setting_6_4_1_8 )
Setting_6_4_1_11 [ ' flag3 ' ] [ 0 ] . pop ( ' split_interlock ' , None )
Setting_6_4_1_11 . update ( {
2019-05-11 12:46:58 +01:00
' interlock ' : ( ' B ' , 0x4CA , ( [ 4 ] , None , ( ' Control ' , None ) ) , ' " 0x {:02x} " .format($) ' ) ,
2019-01-28 15:40:46 +00:00
} )
2019-04-17 17:40:47 +01:00
Setting_6_4_1_11 [ ' flag ' ] [ 0 ] . update ( {
2019-05-11 12:46:58 +01:00
' interlock ' : ( ' <L ' , ( 0x010 , 1 , 14 ) , ( None , None , ( ' Control ' , ' " Interlock {} " .format($) ' ) ) ) ,
2019-04-17 17:40:47 +01:00
} )
2019-01-28 15:40:46 +00:00
# ======================================================================
2019-02-03 10:03:11 +00:00
Setting_6_4_1_13 = copy . deepcopy ( Setting_6_4_1_11 )
Setting_6_4_1_13 . update ( {
' SensorBits1 ' : ( {
' mhz19b_abc_disable ' : ( ' B ' , ( 0x717 , 1 , 7 ) , ( None , None , ( ' Sensor ' , ' " Sensor15 {} " .format($) ' ) ) ) ,
2019-04-17 17:40:47 +01:00
} , 0x717 , ( None , None , ( ' * ' , None ) ) , ( None , None ) ) ,
2019-02-03 10:03:11 +00:00
} )
2019-02-15 17:35:29 +00:00
# ======================================================================
Setting_6_4_1_16 = copy . deepcopy ( Setting_6_4_1_13 )
2019-07-23 17:40:11 +01:00
Setting_6_4_1_16 . update ( {
' user_template_base ' : ( ' B ' , 0x71F , ( None , None , ( ' Management ' , ' " Template {} " .format($) ' ) ) , ( ' $ + 1 ' , ' $ - 1 ' ) ) ,
' user_template ' : ( {
' name ' : ( ' 15s ' , 0x720 , ( None , None , ( ' Management ' , ' " Template {{ \\ \" NAME \\ \" : \\ \" {} \\ \" }} " .format($) ' ) ) ) ,
' gpio00 ' : ( ' B ' , 0x72F , ( None , None , ( ' Management ' , ' " Template {{ \\ \" GPIO \\ \" :[ {} , {} , {} , {} , {} , {} , {} , {} , {} , {} , {} , {} , {} ]}} " .format(@[ " user_template " ][ " gpio00 " ],@[ " user_template " ][ " gpio01 " ],@[ " user_template " ][ " gpio02 " ],@[ " user_template " ][ " gpio03 " ],@[ " user_template " ][ " gpio04 " ],@[ " user_template " ][ " gpio05 " ],@[ " user_template " ][ " gpio09 " ],@[ " user_template " ][ " gpio10 " ],@[ " user_template " ][ " gpio12 " ],@[ " user_template " ][ " gpio13 " ],@[ " user_template " ][ " gpio14 " ],@[ " user_template " ][ " gpio15 " ],@[ " user_template " ][ " gpio16 " ]) ' ) ) ) ,
' gpio01 ' : ( ' B ' , 0x730 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio02 ' : ( ' B ' , 0x731 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio03 ' : ( ' B ' , 0x732 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio04 ' : ( ' B ' , 0x733 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio05 ' : ( ' B ' , 0x734 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio09 ' : ( ' B ' , 0x735 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio10 ' : ( ' B ' , 0x736 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio12 ' : ( ' B ' , 0x737 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio13 ' : ( ' B ' , 0x738 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio14 ' : ( ' B ' , 0x739 , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio15 ' : ( ' B ' , 0x73A , ( None , None , ( ' Management ' , None ) ) ) ,
' gpio16 ' : ( ' B ' , 0x73B , ( None , None , ( ' Management ' , None ) ) ) ,
' flag ' : ( {
' _ ' : ( ' B ' , 0x73C , ( None , None , ( ' Management ' , ' " Template {{ \\ \" FLAG \\ \" : {} }} " .format($) ' ) ) , ( None , False ) ) ,
' adc0 ' : ( ' B ' , ( 0x73C , 1 , 0 ) , ( None , None , ( ' Management ' , None ) ) ) ,
' pullup ' : ( ' B ' , ( 0x73C , 1 , 1 ) , ( None , None , ( ' Management ' , None ) ) ) ,
} , 0x73C , ( None , None , ( ' Management ' , None ) )
) ,
2019-02-21 14:37:46 +00:00
} , 0x720 , ( None , None , ( ' Management ' , None ) )
2019-07-23 17:40:11 +01:00
) ,
2019-02-15 17:35:29 +00:00
} )
2019-02-03 10:03:11 +00:00
# ======================================================================
2019-02-21 14:37:46 +00:00
Setting_6_4_1_17 = copy . deepcopy ( Setting_6_4_1_16 )
Setting_6_4_1_17 [ ' flag3 ' ] [ 0 ] . pop ( ' no_pullup ' , None )
# ======================================================================
2019-03-14 17:29:09 +00:00
Setting_6_4_1_18 = copy . deepcopy ( Setting_6_4_1_17 )
Setting_6_4_1_18 [ ' flag3 ' ] [ 0 ] . update ( {
2019-07-23 17:40:11 +01:00
' no_hold_retain ' : ( ' <L ' , ( 0x3A0 , 1 , 12 ) , ( None , None , ( ' SetOption ' , ' " SetOption62 {} " .format($) ' ) ) ) ,
2019-03-14 17:29:09 +00:00
} )
# ======================================================================
2019-03-31 11:23:09 +01:00
Setting_6_5_0_3 = copy . deepcopy ( Setting_6_4_1_18 )
2019-07-23 17:40:11 +01:00
Setting_6_5_0_3 . update ( {
2019-04-17 17:40:47 +01:00
' novasds_period ' : ( ' B ' , 0x73D , ( None , ' 1 <= $ <= 255 ' , ( ' Sensor ' , ' " Sensor20 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
Setting_6_5_0_6 = copy . deepcopy ( Setting_6_5_0_3 )
2019-07-23 17:40:11 +01:00
Setting_6_5_0_6 . update ( {
' web_color ' : ( ' 3B ' , 0x73E , ( [ 18 ] , None , ( ' Wifi ' , ' " WebColor {} {} {:06x} " .format(#,chr(35),int($,0)) ' ) ) , ' " 0x {:06x} " .format($) ' ) ,
2019-04-17 17:40:47 +01:00
} )
# ======================================================================
Setting_6_5_0_7 = copy . deepcopy ( Setting_6_5_0_6 )
2019-07-23 17:40:11 +01:00
Setting_6_5_0_7 . update ( {
' ledmask ' : ( ' <H ' , 0x7BC , ( None , None , ( ' Control ' , ' " LedMask {} " .format($) ' ) ) , ' " 0x {:04x} " .format($) ' ) ,
2019-05-11 12:46:58 +01:00
} )
# ======================================================================
Setting_6_5_0_9 = copy . deepcopy ( Setting_6_5_0_7 )
Setting_6_5_0_9 [ ' flag3 ' ] [ 0 ] . update ( {
2019-07-23 17:40:11 +01:00
' no_power_feedback ' : ( ' <L ' , ( 0x3A0 , 1 , 13 ) , ( None , None , ( ' SetOption ' , ' " SetOption63 {} " .format($) ' ) ) ) ,
2019-03-31 11:23:09 +01:00
} )
# ======================================================================
2019-05-21 10:13:35 +01:00
Setting_6_5_0_11 = copy . deepcopy ( Setting_6_5_0_9 )
Setting_6_5_0_11 [ ' flag3 ' ] [ 0 ] . update ( {
2019-07-23 17:40:11 +01:00
' use_underscore ' : ( ' <L ' , ( 0x3A0 , 1 , 14 ) , ( None , None , ( ' SetOption ' , ' " SetOption64 {} " .format($) ' ) ) ) ,
2019-05-21 10:13:35 +01:00
} )
# ======================================================================
2019-05-29 13:08:37 +01:00
Setting_6_5_0_12 = copy . deepcopy ( Setting_6_5_0_11 )
Setting_6_5_0_12 . pop ( ' drivers ' , None )
2019-07-23 17:40:11 +01:00
Setting_6_5_0_12 . update ( {
2019-05-29 13:08:37 +01:00
' adc_param_type ' : ( ' B ' , 0x1D5 , ( None , ' 2 <= $ <= 3 ' , ( ' Sensor ' , ' " AdcParam {type} , {param1} , {param2} , {param3} " .format(type=$,param1=@[ " adc_param1 " ],param2=@[ " adc_param2 " ],param3=@[ " adc_param3 " ]/10000.0) ' ) ) ) ,
' adc_param1 ' : ( ' <L ' , 0x794 , ( None , None , ( ' Sensor ' , None ) ) ) ,
' adc_param2 ' : ( ' <L ' , 0x798 , ( None , None , ( ' Sensor ' , None ) ) ) ,
' adc_param3 ' : ( ' <l ' , 0x79C , ( None , None , ( ' Sensor ' , None ) ) ) ,
' sps30_inuse_hours ' : ( ' B ' , 0x1E8 , ( None , None , ( ' System ' , None ) ) ) ,
} )
# ======================================================================
2019-06-30 16:24:19 +01:00
Setting_6_5_0_15 = copy . deepcopy ( Setting_6_5_0_12 )
Setting_6_5_0_15 [ ' flag3 ' ] [ 0 ] . update ( {
2019-07-23 17:40:11 +01:00
' tuya_show_dimmer ' : ( ' <L ' , ( 0x3A0 , 1 , 15 ) , ( None , None , ( ' SetOption ' , ' " SetOption65 {} " .format($) ' ) ) ) ,
2019-06-30 16:24:19 +01:00
} )
# ======================================================================
2019-07-12 11:20:44 +01:00
Setting_6_6_0_1 = copy . deepcopy ( Setting_6_5_0_15 )
Setting_6_6_0_1 [ ' flag3 ' ] [ 0 ] . update ( {
2019-07-23 17:40:11 +01:00
' tuya_dimmer_range_255 ' : ( ' <L ' , ( 0x3A0 , 1 , 16 ) , ( None , None , ( ' SetOption ' , ' " SetOption66 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
Setting_6_6_0_2 = copy . deepcopy ( Setting_6_6_0_1 )
Setting_6_6_0_2 [ ' flag3 ' ] [ 0 ] . update ( {
' buzzer_enable ' : ( ' <L ' , ( 0x3A0 , 1 , 17 ) , ( None , None , ( ' SetOption ' , ' " SetOption67 {} " .format($) ' ) ) ) ,
} )
Setting_6_6_0_2 . update ( {
' display_width ' : ( ' <H ' , 0x774 , ( None , None , ( ' Display ' , ' " DisplayWidth {} " .format($) ' ) ) ) ,
' display_height ' : ( ' <H ' , 0x776 , ( None , None , ( ' Display ' , ' " DisplayHeight {} " .format($) ' ) ) ) ,
2019-07-12 04:28:08 +01:00
} )
# ======================================================================
2019-08-08 16:24:20 +01:00
Setting_6_6_0_3 = copy . deepcopy ( Setting_6_6_0_2 )
Setting_6_6_0_3 [ ' flag3 ' ] [ 0 ] . update ( {
' pwm_multi_channels ' : ( ' <L ' , ( 0x3A0 , 1 , 18 ) , ( None , None , ( ' SetOption ' , ' " SetOption68 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2019-08-19 12:40:06 +01:00
Setting_6_6_0_5 = copy . deepcopy ( Setting_6_6_0_3 )
Setting_6_6_0_5 . update ( {
' sensors ' : ( ' <L ' , 0x7A4 , ( [ 3 ] , None , ( ' Wifi ' , WebSensor ) ) , ' " 0x {:08x} " .format($) ' ) ,
} )
Setting_6_6_0_5 [ ' flag3 ' ] [ 0 ] . update ( {
' tuya_dimmer_min_limit ' : ( ' <L ' , ( 0x3A0 , 1 , 19 ) , ( None , None , ( ' SetOption ' , ' " SetOption69 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
2019-08-28 15:13:23 +01:00
Setting_6_6_0_6 = copy . deepcopy ( Setting_6_6_0_5 )
Setting_6_6_0_6 [ ' flag3 ' ] [ 0 ] . pop ( ' tuya_show_dimmer ' , None )
Setting_6_6_0_6 [ ' flag3 ' ] [ 0 ] . update ( {
' tuya_disable_dimmer ' : ( ' <L ' , ( 0x3A0 , 1 , 15 ) , ( None , None , ( ' SetOption ' , ' " SetOption65 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
Setting_6_6_0_7 = copy . deepcopy ( Setting_6_6_0_6 )
Setting_6_6_0_7 . update ( {
' energy_usage ' : ( {
' usage1_kWhtotal ' : ( ' <L ' , 0x77C , ( None , None , ( ' Power ' , None ) ) ) ,
' usage1_kWhtoday ' : ( ' <L ' , 0x780 , ( None , None , ( ' Power ' , None ) ) ) ,
' return1_kWhtotal ' : ( ' <L ' , 0x784 , ( None , None , ( ' Power ' , None ) ) ) ,
' return2_kWhtotal ' : ( ' <L ' , 0x788 , ( None , None , ( ' Power ' , None ) ) ) ,
' last_usage_kWhtotal ' : ( ' <L ' , 0x78C , ( None , None , ( ' Power ' , None ) ) ) ,
' last_return_kWhtotal ' : ( ' <L ' , 0x790 , ( None , None , ( ' Power ' , None ) ) ) ,
} , 0x77C , ( None , None , ( ' Power ' , None ) ) ) ,
} )
# ======================================================================
Setting_6_6_0_8 = copy . deepcopy ( Setting_6_6_0_7 )
Setting_6_6_0_8 [ ' flag3 ' ] [ 0 ] . update ( {
' energy_weekend ' : ( ' <L ' , ( 0x3A0 , 1 , 20 ) , ( None , None , ( ' Power ' , ' " Tariff3 {} " .format($) ' ) ) ) ,
} )
# ======================================================================
Setting_6_6_0_9 = copy . deepcopy ( Setting_6_6_0_8 )
Setting_6_6_0_9 . update ( {
' baudrate ' : ( ' <H ' , 0x778 , ( None , None , ( ' Serial ' , ' " Baudrate {} " .format($) ' ) ) , ( ' $ * 1200 ' , ' $ / 1200 ' ) ) ,
' sbaudrate ' : ( ' <H ' , 0x77A , ( None , None , ( ' Serial ' , ' " SBaudrate {} " .format($) ' ) ) , ( ' $ * 1200 ' , ' $ / 1200 ' ) ) ,
} )
# ======================================================================
2019-09-06 09:42:39 +01:00
Setting_6_6_0_10 = copy . deepcopy ( Setting_6_6_0_9 )
Setting_6_6_0_10 . update ( {
' cfg_timestamp ' : ( ' <L ' , 0xFF8 , ( None , None , ( INTERNAL , None ) ) ) ,
' cfg_crc32 ' : ( ' <L ' , 0xFFC , ( None , None , ( INTERNAL , None ) ) , ' " 0x {:08x} " .format($) ' ) ,
' tuya_fnid_map ' : ( {
' fnid ' : ( ' B ' , 0xE00 , ( None , None , ( ' Management ' , ' " TuyaMCU {} , {} " .format($,@[ " tuya_fnid_map " ][#-1][ " dpid " ]) if ($!=0 or @[ " tuya_fnid_map " ][#-1][ " dpid " ]!=0) else None ' ) ) ) ,
' dpid ' : ( ' B ' , 0xE01 , ( None , None , ( ' Management ' , None ) ) ) ,
} , 0xE00 , ( [ 16 ] , None , ( ' Management ' , None ) ) , ( None , None ) ) ,
} )
Setting_6_6_0_10 [ ' flag2 ' ] [ 0 ] . update ( {
' time_format ' : ( ' <L ' , ( 0x5BC , 2 , 4 ) , ( None , None , ( ' Management ' , ' " Time {} " .format($+1) ' ) ) ) ,
} )
Setting_6_6_0_10 [ ' flag3 ' ] [ 0 ] . pop ( ' tuya_show_dimmer ' , None )
# ======================================================================
2018-10-14 12:18:16 +01:00
Settings = [
2019-09-06 09:42:39 +01:00
( 0x606000A , 0x1000 , Setting_6_6_0_10 ) ,
2019-08-28 15:13:23 +01:00
( 0x6060009 , 0x1000 , Setting_6_6_0_9 ) ,
( 0x6060008 , 0x1000 , Setting_6_6_0_8 ) ,
( 0x6060007 , 0x1000 , Setting_6_6_0_7 ) ,
( 0x6060006 , 0xe00 , Setting_6_6_0_6 ) ,
2019-08-19 12:40:06 +01:00
( 0x6060005 , 0xe00 , Setting_6_6_0_5 ) ,
2019-08-08 16:24:20 +01:00
( 0x6060003 , 0xe00 , Setting_6_6_0_3 ) ,
2019-07-23 17:40:11 +01:00
( 0x6060002 , 0xe00 , Setting_6_6_0_2 ) ,
( 0x6060001 , 0xe00 , Setting_6_6_0_1 ) ,
2019-06-30 16:24:19 +01:00
( 0x605000F , 0xe00 , Setting_6_5_0_15 ) ,
2019-05-29 13:08:37 +01:00
( 0x605000C , 0xe00 , Setting_6_5_0_12 ) ,
( 0x605000B , 0xe00 , Setting_6_5_0_11 ) ,
2019-05-21 10:13:35 +01:00
( 0x605000B , 0xe00 , Setting_6_5_0_11 ) ,
2019-05-11 12:46:58 +01:00
( 0x6050009 , 0xe00 , Setting_6_5_0_9 ) ,
2019-04-17 17:40:47 +01:00
( 0x6050007 , 0xe00 , Setting_6_5_0_7 ) ,
( 0x6050006 , 0xe00 , Setting_6_5_0_6 ) ,
2019-03-31 11:23:09 +01:00
( 0x6050003 , 0xe00 , Setting_6_5_0_3 ) ,
2019-03-14 17:29:09 +00:00
( 0x6040112 , 0xe00 , Setting_6_4_1_18 ) ,
2019-02-21 14:37:46 +00:00
( 0x6040111 , 0xe00 , Setting_6_4_1_17 ) ,
2019-02-15 17:35:29 +00:00
( 0x6040110 , 0xe00 , Setting_6_4_1_16 ) ,
2019-02-03 10:03:11 +00:00
( 0x604010D , 0xe00 , Setting_6_4_1_13 ) ,
2019-01-28 15:40:46 +00:00
( 0x604010B , 0xe00 , Setting_6_4_1_11 ) ,
2019-01-13 16:33:33 +00:00
( 0x6040108 , 0xe00 , Setting_6_4_1_8 ) ,
2019-01-07 17:15:11 +00:00
( 0x6040107 , 0xe00 , Setting_6_4_1_7 ) ,
2019-01-04 09:24:46 +00:00
( 0x6040104 , 0xe00 , Setting_6_4_1_4 ) ,
2018-12-23 12:38:38 +00:00
( 0x6040002 , 0xe00 , Setting_6_4_0_2 ) ,
2018-12-08 09:28:12 +00:00
( 0x6030010 , 0xe00 , Setting_6_3_0_16 ) ,
2018-12-03 07:33:21 +00:00
( 0x603000F , 0xe00 , Setting_6_3_0_15 ) ,
2018-11-27 10:24:19 +00:00
( 0x603000E , 0xe00 , Setting_6_3_0_14 ) ,
( 0x603000D , 0xe00 , Setting_6_3_0_13 ) ,
( 0x603000B , 0xe00 , Setting_6_3_0_11 ) ,
2018-11-20 16:06:54 +00:00
( 0x603000A , 0xe00 , Setting_6_3_0_10 ) ,
2018-11-16 17:09:02 +00:00
( 0x6030008 , 0xe00 , Setting_6_3_0_8 ) ,
2018-11-07 12:42:13 +00:00
( 0x6030004 , 0xe00 , Setting_6_3_0_4 ) ,
2018-11-01 13:44:13 +00:00
( 0x6030002 , 0xe00 , Setting_6_3_0_2 ) ,
2018-10-31 06:45:19 +00:00
( 0x6030000 , 0xe00 , Setting_6_3_0 ) ,
2018-10-29 15:26:45 +00:00
( 0x6020114 , 0xe00 , Setting_6_2_1_20 ) ,
2018-10-27 09:37:33 +01:00
( 0x6020113 , 0xe00 , Setting_6_2_1_19 ) ,
2018-10-14 12:18:16 +01:00
( 0x602010E , 0xe00 , Setting_6_2_1_14 ) ,
( 0x602010A , 0xe00 , Setting_6_2_1_10 ) ,
2018-10-02 12:42:21 +01:00
( 0x6020106 , 0xe00 , Setting_6_2_1_6 ) ,
( 0x6020103 , 0xe00 , Setting_6_2_1_3 ) ,
( 0x6020102 , 0xe00 , Setting_6_2_1_2 ) ,
( 0x6020100 , 0xe00 , Setting_6_2_1 ) ,
2018-09-25 13:08:36 +01:00
( 0x6010100 , 0xe00 , Setting_6_1_1 ) ,
( 0x6000000 , 0xe00 , Setting_6_0_0 ) ,
( 0x50e0000 , 0xa00 , Setting_5_14_0 ) ,
( 0x50d0100 , 0xa00 , Setting_5_13_1 ) ,
2018-09-26 14:18:01 +01:00
( 0x50c0000 , 0x670 , Setting_5_12_0 ) ,
( 0x50b0000 , 0x670 , Setting_5_11_0 ) ,
( 0x50a0000 , 0x670 , Setting_5_10_0 ) ,
2018-09-25 13:08:36 +01:00
]
2018-11-12 15:08:09 +00:00
# ======================================================================
# Common helper
# ======================================================================
2018-10-27 09:37:33 +01:00
class LogType :
2018-09-25 13:08:36 +01:00
INFO = ' INFO '
WARNING = ' WARNING '
ERROR = ' ERROR '
2019-05-29 13:08:37 +01:00
def message ( msg , type_ = None , status = None , line = None ) :
2018-10-27 09:37:33 +01:00
"""
Writes a message to stdout
@param msg :
message to output
2019-05-29 13:08:37 +01:00
@param type_ :
2018-10-27 09:37:33 +01:00
INFO , WARNING or ERROR
@param status :
status number
"""
print >> sys . stderr , ' {styp} {sdelimiter} {sstatus} {slineno} {scolon} {smgs} ' . format ( \
2019-05-29 13:08:37 +01:00
styp = type_ if type_ is not None else ' ' ,
sdelimiter = ' ' if status is not None and status > 0 and type_ is not None else ' ' ,
2018-11-12 15:08:09 +00:00
sstatus = status if status is not None and status > 0 else ' ' ,
2019-05-29 13:08:37 +01:00
scolon = ' : ' if type_ is not None or line is not None else ' ' ,
2018-10-27 09:37:33 +01:00
smgs = msg ,
slineno = ' (@ {:04d} ) ' . format ( line ) if line is not None else ' ' )
2018-09-25 13:08:36 +01:00
2019-05-29 13:08:37 +01:00
def exit ( status = 0 , msg = " end " , type_ = LogType . ERROR , src = None , doexit = True , line = None ) :
2018-09-25 13:08:36 +01:00
"""
Called when the program should be exit
@param status :
the exit status program returns to callert
2018-10-27 09:37:33 +01:00
@param msg :
the msg logged before exit
2019-05-29 13:08:37 +01:00
@param type_ :
2018-10-27 09:37:33 +01:00
msg type : ' INFO ' , ' WARNING ' or ' ERROR '
2018-09-29 12:37:42 +01:00
@param doexit :
True to exit program , otherwise return
2018-09-25 13:08:36 +01:00
"""
2018-10-27 09:37:33 +01:00
if src is not None :
msg = ' {} ( {} ) ' . format ( src , msg )
2019-05-29 13:08:37 +01:00
message ( msg , type_ = type_ if status != ExitCode . OK else LogType . INFO , status = status , line = line )
2018-09-29 12:37:42 +01:00
exitcode = status
if doexit :
sys . exit ( exitcode )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
def ShortHelp ( doexit = True ) :
"""
Show short help ( usage ) only - ued by own - h handling
@param doexit :
sys . exit with OK if True
"""
print parser . description
print
parser . print_usage ( )
print
print " For advanced help use ' {prog} -H ' or ' {prog} --full-help ' " . format ( prog = os . path . basename ( sys . argv [ 0 ] ) )
if doexit :
sys . exit ( ExitCode . OK )
class HTTPHeader :
"""
pycurl helper class retrieving the request header
"""
def __init__ ( self ) :
self . contents = ' '
def clear ( self ) :
self . contents = ' '
def store ( self , _buffer ) :
self . contents = " {} {} " . format ( self . contents , _buffer )
def response ( self ) :
header = str ( self . contents ) . split ( ' \n ' )
2018-11-12 15:08:09 +00:00
if len ( header ) > 0 :
2018-10-27 09:37:33 +01:00
return header [ 0 ] . rstrip ( )
return ' '
def contenttype ( self ) :
for item in str ( self . contents ) . split ( ' \n ' ) :
ditem = item . split ( " : " )
2018-11-12 15:08:09 +00:00
if ditem [ 0 ] . strip ( ) . lower ( ) == ' content-type ' and len ( ditem ) > 1 :
2018-10-27 09:37:33 +01:00
return ditem [ 1 ] . strip ( )
return ' '
def __str__ ( self ) :
return self . contents
class CustomHelpFormatter ( configargparse . HelpFormatter ) :
"""
Class for customizing the help output
"""
def _format_action_invocation ( self , action ) :
"""
Reformat multiple metavar output
- d < host > , - - device < host > , - - host < host >
to single output
- d , - - device , - - host < host >
"""
orgstr = configargparse . HelpFormatter . _format_action_invocation ( self , action )
if orgstr and orgstr [ 0 ] != ' - ' : # only optional arguments
return orgstr
res = getattr ( action , ' _formatted_action_invocation ' , None )
if res :
return res
options = orgstr . split ( ' , ' )
2018-11-12 15:08:09 +00:00
if len ( options ) < = 1 :
2018-10-27 09:37:33 +01:00
action . _formatted_action_invocation = orgstr
return orgstr
return_list = [ ]
for option in options :
meta = " "
arg = option . split ( ' ' )
2018-11-12 15:08:09 +00:00
if len ( arg ) > 1 :
2018-10-27 09:37:33 +01:00
meta = arg [ 1 ]
return_list . append ( arg [ 0 ] )
2018-11-12 15:08:09 +00:00
if len ( meta ) > 0 and len ( return_list ) > 0 :
2018-10-27 09:37:33 +01:00
return_list [ len ( return_list ) - 1 ] + = " " + meta
action . _formatted_action_invocation = ' , ' . join ( return_list )
return action . _formatted_action_invocation
2018-11-12 15:08:09 +00:00
# ======================================================================
2018-09-25 13:08:36 +01:00
# Tasmota config data handling
2018-11-12 15:08:09 +00:00
# ======================================================================
def GetTemplateSizes ( ) :
"""
Get all possible template sizes as list
@param version :
< int > version number from read binary data to search for
@return :
template sizes as list [ ]
"""
sizes = [ ]
for cfg in Settings :
sizes . append ( cfg [ 1 ] )
# return unique sizes only (remove duplicates)
return list ( set ( sizes ) )
def GetTemplateSetting ( decode_cfg ) :
"""
Search for version , size and settings to be used depending on given binary config data
@param decode_cfg :
binary config data ( decrypted )
@return :
version , size , settings to use ; None if version is invalid
"""
version = 0x0
size = setting = None
version = GetField ( decode_cfg , ' version ' , Setting_6_2_1 [ ' version ' ] , raw = True )
# search setting definition top-down
for cfg in sorted ( Settings , key = lambda s : s [ 0 ] , reverse = True ) :
if version > = cfg [ 0 ] :
size = cfg [ 1 ]
setting = cfg [ 2 ]
break
return version , size , setting
def GetGroupList ( setting ) :
"""
Get all avilable group definition from setting
@return :
configargparse . parse_args ( ) result
"""
groups = set ( )
for name in setting :
dev = setting [ name ]
2019-04-17 17:40:47 +01:00
format_ , group = GetFieldDef ( dev , fields = " format_, group " )
2018-11-12 15:08:09 +00:00
if group is not None and len ( group ) > 0 :
2019-05-21 10:13:35 +01:00
groups . add ( group . title ( ) )
2019-04-17 17:40:47 +01:00
if isinstance ( format_ , dict ) :
subgroups = GetGroupList ( format_ )
2018-11-12 15:08:09 +00:00
if subgroups is not None and len ( subgroups ) > 0 :
for group in subgroups :
2019-05-21 10:13:35 +01:00
groups . add ( group . title ( ) )
2018-11-12 15:08:09 +00:00
groups = list ( groups )
groups . sort ( )
return groups
2018-10-27 09:37:33 +01:00
class FileType :
FILE_NOT_FOUND = None
DMP = ' dmp '
JSON = ' json '
BIN = ' bin '
UNKNOWN = ' unknown '
INCOMPLETE_JSON = ' incomplete json '
INVALID_JSON = ' invalid json '
INVALID_BIN = ' invalid bin '
def GetFileType ( filename ) :
"""
Get the FileType class member of a given filename
@param filename :
filename of the file to analyse
@return :
FileType class member
"""
filetype = FileType . UNKNOWN
# try filename
try :
isfile = os . path . isfile ( filename )
try :
2019-01-04 09:24:46 +00:00
with open ( filename , " r " ) as f :
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
# try reading as json
inputjson = json . load ( f )
if ' header ' in inputjson :
filetype = FileType . JSON
else :
filetype = FileType . INCOMPLETE_JSON
except ValueError :
filetype = FileType . INVALID_JSON
# not a valid json, get filesize and compare it with all possible sizes
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
size = os . path . getsize ( filename )
except :
filetype = FileType . UNKNOWN
sizes = GetTemplateSizes ( )
# size is one of a dmp file size
if size in sizes :
filetype = FileType . DMP
elif ( size - ( ( len ( hex ( BINARYFILE_MAGIC ) ) - 2 ) / 2 ) ) in sizes :
# check if the binary file has the magic header
with open ( filename , " rb " ) as inputfile :
inputbin = inputfile . read ( )
2018-10-27 09:37:33 +01:00
if struct . unpack_from ( ' <L ' , inputbin , 0 ) [ 0 ] == BINARYFILE_MAGIC :
filetype = FileType . BIN
else :
filetype = FileType . INVALID_BIN
except :
filetype = FileType . FILE_NOT_FOUND
2019-01-04 09:24:46 +00:00
pass
2018-10-27 09:37:33 +01:00
except :
filetype = FileType . FILE_NOT_FOUND
2019-01-04 09:24:46 +00:00
pass
2018-10-27 09:37:33 +01:00
return filetype
def GetVersionStr ( version ) :
"""
Create human readable version string
@param version :
version integer
@return :
version string
"""
2018-11-07 12:42:13 +00:00
if isinstance ( version , ( unicode , str ) ) :
version = int ( version , 0 )
2018-10-27 09:37:33 +01:00
major = ( ( version >> 24 ) & 0xff )
minor = ( ( version >> 16 ) & 0xff )
release = ( ( version >> 8 ) & 0xff )
subrelease = ( version & 0xff )
2018-11-12 15:08:09 +00:00
if major > = 6 :
if subrelease > 0 :
2018-10-27 09:37:33 +01:00
subreleasestr = str ( subrelease )
else :
subreleasestr = ' '
else :
2018-11-12 15:08:09 +00:00
if subrelease > 0 :
2018-10-27 09:37:33 +01:00
subreleasestr = str ( chr ( subrelease + ord ( ' a ' ) - 1 ) )
else :
subreleasestr = ' '
2018-11-12 15:08:09 +00:00
return " {:d} . {:d} . {:d} {} {} " . format ( major , minor , release , ' . ' if ( major > = 6 and subreleasestr != ' ' ) else ' ' , subreleasestr )
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
def MakeFilename ( filename , filetype , configmapping ) :
2018-10-27 09:37:33 +01:00
"""
2018-11-12 15:08:09 +00:00
Replace variables within a filename
2018-10-02 12:42:21 +01:00
@param filename :
original filename possible containing replacements :
@v :
2018-11-14 07:03:55 +00:00
Tasmota version from config data
2018-10-02 12:42:21 +01:00
@f :
2018-11-14 07:03:55 +00:00
friendlyname from config data
2018-10-27 09:37:33 +01:00
@h :
2018-11-14 07:03:55 +00:00
hostname from config data
@H :
hostname from device ( - d arg only )
2018-10-27 09:37:33 +01:00
@param filetype :
FileType . x object - creates extension if not None
2018-11-12 15:08:09 +00:00
@param configmapping :
2018-10-27 09:37:33 +01:00
binary config data ( decrypted )
2018-10-02 12:42:21 +01:00
2018-10-27 09:37:33 +01:00
@return :
New filename with replacements
2018-10-02 12:42:21 +01:00
"""
2018-11-14 07:03:55 +00:00
config_version = config_friendlyname = config_hostname = device_hostname = ' '
2018-11-12 15:08:09 +00:00
if ' version ' in configmapping :
2018-11-14 07:03:55 +00:00
config_version = GetVersionStr ( int ( str ( configmapping [ ' version ' ] ) , 0 ) )
2018-11-12 15:08:09 +00:00
if ' friendlyname ' in configmapping :
2019-05-11 12:46:58 +01:00
config_friendlyname = re . sub ( ' [^0-9a-zA-Z] ' , ' _ ' , configmapping [ ' friendlyname ' ] [ 0 ] )
2018-11-12 15:08:09 +00:00
if ' hostname ' in configmapping :
2018-11-14 07:03:55 +00:00
if configmapping [ ' hostname ' ] . find ( ' % ' ) < 0 :
2019-05-11 12:46:58 +01:00
config_hostname = re . sub ( ' [^0-9a-zA-Z] ' , ' _ ' , configmapping [ ' hostname ' ] )
2018-11-14 07:03:55 +00:00
if filename . find ( ' @H ' ) > = 0 and args . device is not None :
device_hostname = GetTasmotaHostname ( args . device , args . port , username = args . username , password = args . password )
if device_hostname is None :
device_hostname = ' '
2018-11-07 12:42:13 +00:00
dirname = basename = ext = ' '
2018-11-12 15:08:09 +00:00
# split file parts
dirname = os . path . normpath ( os . path . dirname ( filename ) )
basename = os . path . basename ( filename )
name , ext = os . path . splitext ( basename )
# make a valid filename
2018-10-27 09:37:33 +01:00
try :
2018-11-12 15:08:09 +00:00
name = name . decode ( ' unicode-escape ' ) . translate ( dict ( ( ord ( char ) , None ) for char in ' \ /*?: " <>| ' ) )
2018-10-27 09:37:33 +01:00
except :
pass
2018-11-12 15:08:09 +00:00
name = str ( name . replace ( ' ' , ' _ ' ) )
2018-11-07 12:42:13 +00:00
2018-11-12 15:08:09 +00:00
# append extension based on filetype if not given
2018-10-27 09:37:33 +01:00
if len ( ext ) and ext [ 0 ] == ' . ' :
ext = ext [ 1 : ]
if filetype is not None and args . extension and ( len ( ext ) < 2 or all ( c . isdigit ( ) for c in ext ) ) :
2018-11-07 12:42:13 +00:00
ext = filetype . lower ( )
2018-11-12 15:08:09 +00:00
# join filename + extension
2018-11-07 12:42:13 +00:00
if len ( ext ) :
name_ext = name + ' . ' + ext
else :
name_ext = name
2018-11-12 15:08:09 +00:00
# join path and filename
2018-11-07 12:42:13 +00:00
try :
filename = os . path . join ( dirname , name_ext )
except :
pass
2018-10-02 12:42:21 +01:00
2018-12-13 05:57:44 +00:00
filename = filename . replace ( ' @v ' , config_version )
filename = filename . replace ( ' @f ' , config_friendlyname )
filename = filename . replace ( ' @h ' , config_hostname )
filename = filename . replace ( ' @H ' , device_hostname )
2018-10-02 12:42:21 +01:00
return filename
2018-10-27 09:37:33 +01:00
def MakeUrl ( host , port = 80 , location = ' ' ) :
"""
Create a Tasmota host url
@param host :
hostname or IP of Tasmota host
@param port :
port number to use for http connection
@param location :
http url location
@return :
Tasmota http url
"""
return " http:// {shost} {sdelimiter} {sport} / {slocation} " . format ( \
shost = host ,
sdelimiter = ' : ' if port != 80 else ' ' ,
sport = port if port != 80 else ' ' ,
slocation = location )
2018-11-07 12:42:13 +00:00
def LoadTasmotaConfig ( filename ) :
2018-10-27 09:37:33 +01:00
"""
2018-11-07 12:42:13 +00:00
Load config from Tasmota file
@param filename :
filename to load
2018-10-27 09:37:33 +01:00
@return :
binary config data ( encrypted ) or None on error
"""
2018-11-07 12:42:13 +00:00
encode_cfg = None
2018-10-27 09:37:33 +01:00
2018-11-07 12:42:13 +00:00
# read config from a file
if not os . path . isfile ( filename ) : # check file exists
exit ( ExitCode . FILE_NOT_FOUND , " File ' {} ' not found " . format ( filename ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
try :
2019-01-04 09:24:46 +00:00
with open ( filename , " rb " ) as tasmotafile :
encode_cfg = tasmotafile . read ( )
2018-11-07 12:42:13 +00:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( filename , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
return encode_cfg
2018-10-27 09:37:33 +01:00
2018-11-14 07:03:55 +00:00
def TasmotaGet ( cmnd , host , port , username = DEFAULTS [ ' source ' ] [ ' username ' ] , password = None , contenttype = None ) :
2018-11-07 12:42:13 +00:00
"""
2018-11-14 07:03:55 +00:00
Tasmota http request
2018-11-07 12:42:13 +00:00
@param host :
hostname or IP of Tasmota device
@param port :
http port of Tasmota device
@param username :
optional username for Tasmota web login
@param password
optional password for Tasmota web login
@return :
binary config data ( encrypted ) or None on error
"""
2018-11-14 07:03:55 +00:00
body = None
2018-11-07 12:42:13 +00:00
# read config direct from device via http
c = pycurl . Curl ( )
buffer = io . BytesIO ( )
c . setopt ( c . WRITEDATA , buffer )
header = HTTPHeader ( )
c . setopt ( c . HEADERFUNCTION , header . store )
c . setopt ( c . FOLLOWLOCATION , True )
2018-11-14 07:03:55 +00:00
c . setopt ( c . URL , MakeUrl ( host , port , cmnd ) )
2018-11-07 12:42:13 +00:00
if username is not None and password is not None :
c . setopt ( c . HTTPAUTH , c . HTTPAUTH_BASIC )
c . setopt ( c . USERPWD , username + ' : ' + password )
2018-11-14 07:03:55 +00:00
c . setopt ( c . HTTPGET , True )
2018-11-07 12:42:13 +00:00
c . setopt ( c . VERBOSE , False )
responsecode = 200
try :
c . perform ( )
responsecode = c . getinfo ( c . RESPONSE_CODE )
response = header . response ( )
except Exception , e :
exit ( e [ 0 ] , e [ 1 ] , line = inspect . getlineno ( inspect . currentframe ( ) ) )
finally :
c . close ( )
2018-11-14 07:03:55 +00:00
2018-11-07 12:42:13 +00:00
if responsecode > = 400 :
exit ( responsecode , ' HTTP result: {} ' . format ( header . response ( ) ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-11-14 07:03:55 +00:00
elif contenttype is not None and header . contenttype ( ) != contenttype :
2018-11-07 12:42:13 +00:00
exit ( ExitCode . DOWNLOAD_CONFIG_ERROR , " Device did not response properly, may be Tasmota webserver admin mode is disabled (WebServer 2) " , line = inspect . getlineno ( inspect . currentframe ( ) ) )
try :
2018-11-14 07:03:55 +00:00
body = buffer . getvalue ( )
2018-11-07 12:42:13 +00:00
except :
pass
2018-11-14 07:03:55 +00:00
return responsecode , body
def GetTasmotaHostname ( host , port , username = DEFAULTS [ ' source ' ] [ ' username ' ] , password = None ) :
"""
Get Tasmota hostname from device
@param host :
hostname or IP of Tasmota device
@param port :
http port of Tasmota device
@param username :
optional username for Tasmota web login
@param password
optional password for Tasmota web login
@return :
Tasmota real hostname or None on error
"""
hostname = None
loginstr = " "
if password is not None :
loginstr = " user= {} &password= {} & " . format ( urllib2 . quote ( username ) , urllib2 . quote ( password ) )
# get hostname
responsecode , body = TasmotaGet ( " cm? {} cmnd=status % 205 " . format ( loginstr ) , host , port , username = username , password = password )
if body is not None :
jsonbody = json . loads ( body )
if " StatusNET " in jsonbody and " Hostname " in jsonbody [ " StatusNET " ] :
hostname = jsonbody [ " StatusNET " ] [ " Hostname " ]
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Hostname for ' {} ' retrieved: ' {} ' " . format ( host , hostname ) , type_ = LogType . INFO )
2018-11-14 07:03:55 +00:00
return hostname
def PullTasmotaConfig ( host , port , username = DEFAULTS [ ' source ' ] [ ' username ' ] , password = None ) :
"""
Pull config from Tasmota device
@param host :
hostname or IP of Tasmota device
@param port :
http port of Tasmota device
@param username :
optional username for Tasmota web login
@param password
optional password for Tasmota web login
@return :
binary config data ( encrypted ) or None on error
"""
responsecode , body = TasmotaGet ( ' dl ' , host , port , username , password , contenttype = ' application/octet-stream ' )
return body
2018-10-27 09:37:33 +01:00
def PushTasmotaConfig ( encode_cfg , host , port , username = DEFAULTS [ ' source ' ] [ ' username ' ] , password = None ) :
"""
Upload binary data to a Tasmota host using http
@param encode_cfg :
encrypted binary data or filename containing Tasmota encrypted binary config
@param host :
hostname or IP of Tasmota device
2018-11-12 15:08:09 +00:00
@param port :
http port of Tasmota device
2018-10-27 09:37:33 +01:00
@param username :
optional username for Tasmota web login
@param password
optional password for Tasmota web login
@return
errorcode , errorstring
errorcode = 0 if success , otherwise http response or exception code
"""
if isinstance ( encode_cfg , bytearray ) :
encode_cfg = str ( encode_cfg )
# get restore config page first to set internal Tasmota vars
2018-11-14 07:03:55 +00:00
responsecode , body = TasmotaGet ( ' rs? ' , host , port , username , password , contenttype = ' text/html ' )
if body is None :
return responsecode , " ERROR "
2018-10-27 09:37:33 +01:00
# post data
2018-11-14 07:03:55 +00:00
c = pycurl . Curl ( )
header = HTTPHeader ( )
2019-04-17 17:40:47 +01:00
buffer_ = io . BytesIO ( )
2018-10-27 09:37:33 +01:00
c . setopt ( c . HEADERFUNCTION , header . store )
2018-11-14 07:03:55 +00:00
c . setopt ( c . WRITEFUNCTION , lambda x : None )
2019-04-17 17:40:47 +01:00
c . setopt ( c . WRITEDATA , buffer_ )
2018-10-27 09:37:33 +01:00
c . setopt ( c . POST , 1 )
c . setopt ( c . URL , MakeUrl ( host , port , ' u2 ' ) )
2018-11-14 07:03:55 +00:00
if username is not None and password is not None :
c . setopt ( c . HTTPAUTH , c . HTTPAUTH_BASIC )
c . setopt ( c . USERPWD , username + ' : ' + password )
2018-10-27 09:37:33 +01:00
try :
isfile = os . path . isfile ( encode_cfg )
except :
isfile = False
if isfile :
c . setopt ( c . HTTPPOST , [ ( " file " , ( c . FORM_FILE , encode_cfg ) ) ] )
else :
# use as binary data
c . setopt ( c . HTTPPOST , [
( ' fileupload ' , (
c . FORM_BUFFER , ' {sprog} _v {sver} .dmp ' . format ( sprog = os . path . basename ( sys . argv [ 0 ] ) , sver = VER ) ,
c . FORM_BUFFERPTR , encode_cfg
) ) ,
] )
responsecode = 200
try :
c . perform ( )
responsecode = c . getinfo ( c . RESPONSE_CODE )
except Exception , e :
return e [ 0 ] , e [ 1 ]
2019-04-17 17:40:47 +01:00
2018-10-27 09:37:33 +01:00
c . close ( )
2018-11-12 15:08:09 +00:00
if responsecode > = 400 :
2018-10-27 09:37:33 +01:00
return responsecode , header . response ( )
2018-11-12 15:08:09 +00:00
elif header . contenttype ( ) != ' text/html ' :
2018-10-27 09:37:33 +01:00
return ExitCode . UPLOAD_CONFIG_ERROR , " Device did not response properly, may be Tasmota webserver admin mode is disabled (WebServer 2) "
2019-04-17 17:40:47 +01:00
body = buffer_ . getvalue ( )
findUpload = body . find ( " Upload " )
if findUpload < 0 :
return ExitCode . UPLOAD_CONFIG_ERROR , " Device did not response properly with upload result page "
body = body [ findUpload : ]
findSuccessful = body . find ( " Successful " )
if findSuccessful < 0 :
2019-06-30 16:29:11 +01:00
errmatch = re . search ( " <font \ s*color= ' [#0-9a-fA-F]+ ' >( \ S*)</font></b><br><br>(.*)<br> " , body )
2019-04-17 17:40:47 +01:00
reason = " Unknown error "
if errmatch and len ( errmatch . groups ( ) ) > 1 :
reason = errmatch . group ( 2 )
return ExitCode . UPLOAD_CONFIG_ERROR , reason
2018-10-27 09:37:33 +01:00
return 0 , ' OK '
def DecryptEncrypt ( obj ) :
"""
Decrpt / Encrypt binary config data
@param obj :
binary config data
@return :
decrypted configuration ( if obj contains encrypted data )
"""
if isinstance ( obj , bytearray ) :
obj = str ( obj )
dobj = obj [ 0 : 2 ]
for i in range ( 2 , len ( obj ) ) :
dobj + = chr ( ( ord ( obj [ i ] ) ^ ( CONFIG_FILE_XOR + i ) ) & 0xff )
return dobj
2018-09-25 13:08:36 +01:00
def GetSettingsCrc ( dobj ) :
"""
Return binary config data calclulated crc
@param dobj :
2018-10-02 12:42:21 +01:00
decrypted binary config data
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
@return :
2 byte unsigned integer crc value
2018-09-25 13:08:36 +01:00
"""
2018-10-27 09:37:33 +01:00
if isinstance ( dobj , bytearray ) :
dobj = str ( dobj )
2018-09-25 13:08:36 +01:00
crc = 0
for i in range ( 0 , len ( dobj ) ) :
if not i in [ 14 , 15 ] : # Skip crc
2018-10-27 09:37:33 +01:00
byte = ord ( dobj [ i ] )
crc + = byte * ( i + 1 )
2018-09-25 13:08:36 +01:00
return crc & 0xffff
2019-04-17 17:40:47 +01:00
def GetFieldDef ( fielddef , fields = " format_, addrdef, baseaddr, bits, bitshift, datadef, arraydef, validate, cmd, group, tasmotacmnd, converter, readconverter, writeconverter " ) :
2018-10-27 09:37:33 +01:00
2018-09-25 13:08:36 +01:00
"""
2018-11-12 15:08:09 +00:00
Get field definition items
2018-09-25 13:08:36 +01:00
@param fielddef :
2018-09-29 12:37:42 +01:00
field format - see " Settings dictionary " above
2018-11-12 15:08:09 +00:00
@param fields :
comma separated string list of values to be returned
possible values see fields default
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
@return :
2018-11-12 15:08:09 +00:00
set of values defined in < fields >
2018-09-25 13:08:36 +01:00
"""
2019-04-17 17:40:47 +01:00
format_ = addrdef = baseaddr = datadef = arraydef = validate = cmd = group = tasmotacmnd = converter = readconverter = writeconverter = None
2018-10-27 09:37:33 +01:00
bits = bitshift = 0
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
# calling with nothing is wrong
if fielddef is None :
print >> sys . stderr , ' <fielddef> is None '
raise SyntaxError ( ' <fielddef> error ' )
# get top level items
if len ( fielddef ) == 3 :
# converter not present
2019-04-17 17:40:47 +01:00
format_ , addrdef , datadef = fielddef
2018-11-12 15:08:09 +00:00
elif len ( fielddef ) == 4 :
# converter present
2019-04-17 17:40:47 +01:00
format_ , addrdef , datadef , converter = fielddef
2018-11-12 15:08:09 +00:00
else :
print >> sys . stderr , ' wrong <fielddef> {} length ( {} ) in setting ' . format ( fielddef , len ( fielddef ) )
raise SyntaxError ( ' <fielddef> error ' )
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
# ignore calls with 'root' setting
2019-04-17 17:40:47 +01:00
if isinstance ( format_ , dict ) and baseaddr is None and datadef is None :
2018-11-12 15:08:09 +00:00
return eval ( fields )
2018-09-29 12:37:42 +01:00
2019-04-17 17:40:47 +01:00
if not isinstance ( format_ , ( unicode , str , dict ) ) :
print >> sys . stderr , ' wrong <format> {} type {} in <fielddef> {} ' . format ( format_ , type ( format_ ) , fielddef )
2018-11-12 15:08:09 +00:00
raise SyntaxError ( ' <fielddef> error ' )
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
# extract addrdef items
baseaddr = addrdef
if isinstance ( baseaddr , ( list , tuple ) ) :
if len ( baseaddr ) == 3 :
# baseaddr bit definition
baseaddr , bits , bitshift = baseaddr
if not isinstance ( bits , int ) :
2019-04-17 17:40:47 +01:00
print >> sys . stderr , ' <bits> must be defined as integer in <fielddef> {} ' . format ( bits , fielddef )
2018-11-12 15:08:09 +00:00
raise SyntaxError ( ' <fielddef> error ' )
if not isinstance ( bitshift , int ) :
2019-04-17 17:40:47 +01:00
print >> sys . stderr , ' <bitshift> must be defined as integer in <fielddef> {} ' . format ( bitshift , fielddef )
2018-11-12 15:08:09 +00:00
raise SyntaxError ( ' <fielddef> error ' )
else :
print >> sys . stderr , ' wrong <addrdef> {} length ( {} ) in <fielddef> {} ' . format ( addrdef , len ( addrdef ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
if not isinstance ( baseaddr , int ) :
2019-04-17 17:40:47 +01:00
print >> sys . stderr , ' <baseaddr> must be defined as integer in <fielddef> {} ' . format ( baseaddr , fielddef )
2018-11-12 15:08:09 +00:00
raise SyntaxError ( ' <fielddef> error ' )
# extract datadef items
arraydef = datadef
if isinstance ( datadef , ( tuple ) ) :
if len ( datadef ) == 2 :
# datadef has a validator
arraydef , validate = datadef
elif len ( datadef ) == 3 :
# datadef has a validator and cmd set
arraydef , validate , cmd = datadef
# cmd must be a tuple with 2 objects
if isinstance ( cmd , ( tuple ) ) and len ( cmd ) == 2 :
group , tasmotacmnd = cmd
if group is not None and not isinstance ( group , ( str , unicode ) ) :
print >> sys . stderr , ' wrong <group> {} in <fielddef> {} ' . format ( group , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
2019-05-11 12:46:58 +01:00
if tasmotacmnd is isinstance ( tasmotacmnd , tuple ) :
tasmotacmnds = tasmotacmnd
for tasmotacmnd in tasmotacmnds :
if tasmotacmnd is not None and not callable ( tasmotacmnd ) and not isinstance ( tasmotacmnd , ( str , unicode ) ) :
print >> sys . stderr , ' wrong <tasmotacmnd> {} in <fielddef> {} ' . format ( tasmotacmnd , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
else :
if tasmotacmnd is not None and not callable ( tasmotacmnd ) and not isinstance ( tasmotacmnd , ( str , unicode ) ) :
print >> sys . stderr , ' wrong <tasmotacmnd> {} in <fielddef> {} ' . format ( tasmotacmnd , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
2018-11-12 15:08:09 +00:00
else :
print >> sys . stderr , ' wrong <cmd> {} length ( {} ) in <fielddef> {} ' . format ( cmd , len ( cmd ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
else :
print >> sys . stderr , ' wrong <datadef> {} length ( {} ) in <fielddef> {} ' . format ( datadef , len ( datadef ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
if validate is not None and ( not isinstance ( validate , ( unicode , str ) ) and not callable ( validate ) ) :
print >> sys . stderr , ' wrong <validate> {} type {} in <fielddef> {} ' . format ( validate , type ( validate ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
# convert single int into one-dimensional list
if isinstance ( arraydef , int ) :
arraydef = [ arraydef ]
if arraydef is not None and not isinstance ( arraydef , ( list ) ) :
print >> sys . stderr , ' wrong <arraydef> {} type {} in <fielddef> {} ' . format ( arraydef , type ( arraydef ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
# get read/write converter items
readconverter = converter
if isinstance ( converter , ( tuple ) ) :
if len ( converter ) == 2 :
# converter has read/write converter
readconverter , writeconverter = converter
if readconverter is not None and not isinstance ( readconverter , ( str , unicode ) ) and not callable ( readconverter ) :
print >> sys . stderr , ' wrong <readconverter> {} type {} in <fielddef> {} ' . format ( readconverter , type ( readconverter ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
if writeconverter is not None and ( not isinstance ( writeconverter , ( bool , str , unicode ) ) and not callable ( writeconverter ) ) :
print >> sys . stderr , ' wrong <writeconverter> {} type {} in <fielddef> {} ' . format ( writeconverter , type ( writeconverter ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
else :
print >> sys . stderr , ' wrong <converter> {} length ( {} ) in <fielddef> {} ' . format ( converter , len ( converter ) , fielddef )
raise SyntaxError ( ' <fielddef> error ' )
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
return eval ( fields )
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
def ReadWriteConverter ( value , fielddef , read = True , raw = False ) :
2018-09-25 13:08:36 +01:00
"""
Convert field value based on field desc
@param value :
2018-10-27 09:37:33 +01:00
original value
2018-09-25 13:08:36 +01:00
@param fielddef
2018-09-29 12:37:42 +01:00
field definition - see " Settings dictionary " above
2018-10-27 09:37:33 +01:00
@param read
use read conversion if True , otherwise use write conversion
2018-09-26 14:18:01 +01:00
@param raw
return raw values ( True ) or converted values ( False )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
@return :
( un ) converted value
2018-09-25 13:08:36 +01:00
"""
2018-11-12 15:08:09 +00:00
converter , readconverter , writeconverter = GetFieldDef ( fielddef , fields = ' converter, readconverter, writeconverter ' )
2018-10-27 09:37:33 +01:00
# call password functions even if raw value should be processed
2018-11-12 15:08:09 +00:00
if read and callable ( readconverter ) and readconverter == passwordread :
2018-10-27 09:37:33 +01:00
raw = False
2018-11-12 15:08:09 +00:00
if not read and callable ( writeconverter ) and writeconverter == passwordwrite :
2018-10-27 09:37:33 +01:00
raw = False
2018-11-12 15:08:09 +00:00
if not raw and converter is not None :
conv = readconverter if read else writeconverter
2018-10-27 09:37:33 +01:00
try :
2018-11-12 15:08:09 +00:00
if isinstance ( conv , str ) : # evaluate strings
return eval ( conv . replace ( ' $ ' , ' value ' ) )
elif callable ( conv ) : # use as format function
return conv ( value )
except Exception , e :
2019-05-29 13:08:37 +01:00
exit ( e [ 0 ] , e [ 1 ] , type_ = LogType . WARNING , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-10-27 09:37:33 +01:00
2018-09-25 13:08:36 +01:00
return value
2018-11-12 15:08:09 +00:00
def CmndConverter ( valuemapping , value , idx , fielddef ) :
"""
Convert field value into Tasmota command if available
@param valuemapping :
data mapping
@param value :
original value
@param fielddef
field definition - see " Settings dictionary " above
@return :
2019-08-19 12:40:06 +01:00
converted value , list of values or None if unable to convert
2018-11-12 15:08:09 +00:00
"""
converter , readconverter , writeconverter , group , tasmotacmnd = GetFieldDef ( fielddef , fields = ' converter, readconverter, writeconverter, group, tasmotacmnd ' )
result = None
if ( callable ( readconverter ) and readconverter == passwordread ) or ( callable ( writeconverter ) and writeconverter == passwordwrite ) :
if value == HIDDEN_PASSWORD :
return None
else :
result = value
2018-11-16 17:09:02 +00:00
if tasmotacmnd is not None and ( callable ( tasmotacmnd ) or len ( tasmotacmnd ) > 0 ) :
2018-11-12 15:08:09 +00:00
if idx is not None :
idx + = 1
if isinstance ( tasmotacmnd , str ) : # evaluate strings
if idx is not None :
evalstr = tasmotacmnd . replace ( ' $ ' , ' value ' ) . replace ( ' # ' , ' idx ' ) . replace ( ' @ ' , ' valuemapping ' )
else :
evalstr = tasmotacmnd . replace ( ' $ ' , ' value ' ) . replace ( ' @ ' , ' valuemapping ' )
result = eval ( evalstr )
elif callable ( tasmotacmnd ) : # use as format function
if idx is not None :
result = tasmotacmnd ( value , idx )
else :
result = tasmotacmnd ( value )
return result
def ValidateValue ( value , fielddef ) :
"""
Validate a value if validator is defined in fielddef
@param value :
original value
@param fielddef
field definition - see " Settings dictionary " above
@return :
True if value is valid , False if invalid
"""
validate = GetFieldDef ( fielddef , fields = ' validate ' )
if value == 0 :
# can not complete all validate condition
# some Tasmota values are not allowed to be 0 on input
# even though these values are set to 0 on Tasmota initial.
# so we can't validate 0 values
return True ;
valid = True
try :
if isinstance ( validate , str ) : # evaluate strings
valid = eval ( validate . replace ( ' $ ' , ' value ' ) )
elif callable ( validate ) : # use as format function
valid = validate ( value )
except :
valid = False
return valid
2019-04-17 17:40:47 +01:00
def GetFormatCount ( format_ ) :
"""
Get format prefix count
@param format_ :
format specifier
@return :
prefix count or 1 if not specified
"""
if isinstance ( format_ , str ) :
match = re . search ( " \ s*( \ d+) " , format_ )
if match :
return int ( match . group ( 0 ) )
return 1
def GetFormatType ( format_ ) :
"""
Get format type and bitsize without prefix
@param format_ :
format specifier
@return :
( format_ , 0 ) or ( format without prefix , bitsize )
"""
formattype = format_
bitsize = 0
if isinstance ( format_ , str ) :
match = re . search ( " \ s*( \ D+) " , format_ )
if match :
formattype = match . group ( 0 )
bitsize = struct . calcsize ( formattype ) * 8
return formattype , bitsize
2018-10-27 09:37:33 +01:00
def GetFieldMinMax ( fielddef ) :
2018-09-29 12:37:42 +01:00
"""
2018-10-27 09:37:33 +01:00
Get minimum , maximum of field based on field format definition
2018-09-29 12:37:42 +01:00
@param fielddef :
field format - see " Settings dictionary " above
2018-10-27 09:37:33 +01:00
@return :
min , max
"""
2019-04-17 17:40:47 +01:00
minmax = { ' c ' : ( 0 , 0xff ) ,
' ? ' : ( 0 , 1 ) ,
' b ' : ( ~ 0x7f , 0x7f ) ,
' B ' : ( 0 , 0xff ) ,
' h ' : ( ~ 0x7fff , 0x7fff ) ,
' H ' : ( 0 , 0xffff ) ,
' i ' : ( ~ 0x7fffffff , 0x7fffffff ) ,
' I ' : ( 0 , 0xffffffff ) ,
' l ' : ( ~ 0x7fffffff , 0x7fffffff ) ,
' L ' : ( 0 , 0xffffffff ) ,
2018-10-27 09:37:33 +01:00
' q ' : ( ~ 0x7fffffffffffffff , 0x7fffffffffffffff ) ,
' Q ' : ( 0 , 0x7fffffffffffffff ) ,
2019-04-17 17:40:47 +01:00
' f ' : ( sys . float_info . min , sys . float_info . max ) ,
' d ' : ( sys . float_info . min , sys . float_info . max ) ,
2018-10-27 09:37:33 +01:00
}
2019-04-17 17:40:47 +01:00
format_ = GetFieldDef ( fielddef , fields = ' format_ ' )
min_ = 0
max_ = 0
if format_ [ - 1 : ] in minmax :
min_ , max_ = minmax [ format_ [ - 1 : ] ]
max_ * = GetFormatCount ( format_ )
elif format_ [ - 1 : ] in [ ' s ' , ' p ' ] :
2018-10-27 09:37:33 +01:00
# s and p may have a prefix as length
2019-04-17 17:40:47 +01:00
max_ = GetFormatCount ( format_ )
return min_ , max_
2018-10-27 09:37:33 +01:00
2018-09-29 12:37:42 +01:00
2018-10-27 09:37:33 +01:00
def GetFieldLength ( fielddef ) :
2018-09-29 12:37:42 +01:00
"""
2018-10-27 09:37:33 +01:00
Get length of a field in bytes based on field format definition
2018-09-29 12:37:42 +01:00
2018-10-27 09:37:33 +01:00
@param fielddef :
field format - see " Settings dictionary " above
2018-09-29 12:37:42 +01:00
2018-10-27 09:37:33 +01:00
@return :
length of field in bytes
"""
length = 0
2019-04-17 17:40:47 +01:00
format_ , addrdef , arraydef = GetFieldDef ( fielddef , fields = ' format_, addrdef, arraydef ' )
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
# <arraydef> contains a integer list
if isinstance ( arraydef , list ) and len ( arraydef ) > 0 :
# arraydef contains a list
2018-09-29 12:37:42 +01:00
# calc size recursive by sum of all elements
2018-11-12 15:08:09 +00:00
for i in range ( 0 , arraydef [ 0 ] ) :
subfielddef = GetSubfieldDef ( fielddef )
if len ( arraydef ) > 1 :
2019-04-17 17:40:47 +01:00
length + = GetFieldLength ( ( format_ , addrdef , subfielddef ) )
2018-11-12 15:08:09 +00:00
# single array
else :
2019-04-17 17:40:47 +01:00
length + = GetFieldLength ( ( format_ , addrdef , None ) )
2018-09-29 12:37:42 +01:00
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , dict ) :
2018-11-07 12:42:13 +00:00
# -> iterate through format
2018-10-27 09:37:33 +01:00
addr = None
2019-04-17 17:40:47 +01:00
setting = format_
2018-09-29 12:37:42 +01:00
for name in setting :
2018-11-12 15:08:09 +00:00
baseaddr , bits , bitshift = GetFieldDef ( setting [ name ] , fields = ' baseaddr, bits, bitshift ' )
2018-10-27 09:37:33 +01:00
_len = GetFieldLength ( setting [ name ] )
2018-09-29 12:37:42 +01:00
if addr != baseaddr :
addr = baseaddr
2018-10-27 09:37:33 +01:00
length + = _len
2018-10-02 12:42:21 +01:00
2018-11-12 15:08:09 +00:00
# a simple value
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , str ) :
length = struct . calcsize ( format_ )
2018-09-29 12:37:42 +01:00
return length
2018-10-27 09:37:33 +01:00
def GetSubfieldDef ( fielddef ) :
"""
Get subfield definition from a given field definition
@param fielddef :
see Settings desc above
@return :
subfield definition
"""
2019-04-17 17:40:47 +01:00
format_ , addrdef , datadef , arraydef , validate , cmd , converter = GetFieldDef ( fielddef , fields = ' format_, addrdef, datadef, arraydef, validate, cmd, converter ' )
2018-11-12 15:08:09 +00:00
# create new arraydef
if len ( arraydef ) > 1 :
arraydef = arraydef [ 1 : ]
2018-10-27 09:37:33 +01:00
else :
2018-11-12 15:08:09 +00:00
arraydef = None
# create new datadef
if isinstance ( datadef , tuple ) :
if cmd is not None :
datadef = ( arraydef , validate , cmd )
2018-10-27 09:37:33 +01:00
else :
2018-11-12 15:08:09 +00:00
datadef = ( arraydef , validate )
else :
datadef = arraydef
# set new field def
subfielddef = None
if converter is not None :
2019-04-17 17:40:47 +01:00
subfielddef = ( format_ , addrdef , datadef , converter )
2018-11-12 15:08:09 +00:00
else :
2019-04-17 17:40:47 +01:00
subfielddef = ( format_ , addrdef , datadef )
2018-11-12 15:08:09 +00:00
2018-10-27 09:37:33 +01:00
return subfielddef
2018-11-12 15:08:09 +00:00
def IsFilterGroup ( group ) :
"""
Check if group is valid on filter
@param grooup :
group name to check
@return :
True if group is in filter , otherwise False
"""
2019-05-11 12:46:58 +01:00
2018-11-12 15:08:09 +00:00
if args . filter is not None :
if group is None :
return False
2019-05-11 12:46:58 +01:00
if group == ' * ' :
return False
if group . title ( ) != INTERNAL . title ( ) and group . title ( ) not in ( groupname . title ( ) for groupname in args . filter ) :
2018-11-12 15:08:09 +00:00
return False
return True
2019-04-17 17:40:47 +01:00
def GetFieldValue ( fielddef , dobj , addr ) :
"""
Get single field value from definition
@param fielddef :
see Settings desc
@param dobj :
decrypted binary config data
@param addr
addr within dobj
@return :
value read from dobj
"""
format_ , bits , bitshift = GetFieldDef ( fielddef , fields = ' format_, bits, bitshift ' )
value_ = 0
unpackedvalue = struct . unpack_from ( format_ , dobj , addr )
singletype , bitsize = GetFormatType ( format_ )
if not format_ [ - 1 : ] . lower ( ) in [ ' s ' , ' p ' ] :
for val in unpackedvalue :
value_ << = bitsize
value_ = value_ + val
value_ = bitsRead ( value_ , bitshift , bits )
else :
value_ = unpackedvalue [ 0 ]
s = str ( value_ ) . split ( ' \0 ' ) [ 0 ] # use left string until \0
value_ = unicode ( s , errors = ' ignore ' ) # remove character > 127
return value_
def SetFieldValue ( fielddef , dobj , addr , value ) :
"""
Set single field value from definition
@param fielddef :
see Settings desc
@param dobj :
decrypted binary config data
@param addr
addr within dobj
@param value
new value
@return :
new decrypted binary config data
"""
format_ , bits , bitshift = GetFieldDef ( fielddef , fields = ' format_, bits, bitshift ' )
formatcnt = GetFormatCount ( format_ )
singletype , bitsize = GetFormatType ( format_ )
if args . debug > = 2 :
print >> sys . stderr , " SetFieldValue(): fielddef {} , addr 0x {:04x} value {} formatcnt {} singletype {} bitsize {} " . format ( fielddef , addr , value , formatcnt , singletype , bitsize )
if not format_ [ - 1 : ] . lower ( ) in [ ' s ' , ' p ' ] :
addr + = ( bitsize / 8 ) * formatcnt
for _ in range ( 0 , formatcnt ) :
addr - = ( bitsize / 8 )
2019-05-29 13:08:37 +01:00
maxunsigned = ( ( 2 * * bitsize ) - 1 )
maxsigned = ( ( 2 * * bitsize ) >> 1 ) - 1
val = value & maxunsigned
if isinstance ( value , int ) and value < 0 and val > maxsigned :
val = ( ( maxunsigned + 1 ) - val ) * ( - 1 )
2019-04-17 17:40:47 +01:00
if args . debug > = 3 :
print >> sys . stderr , " SetFieldValue(): Single type - fielddef {} , addr 0x {:04x} value {} singletype {} bitsize {} " . format ( fielddef , addr , val , singletype , bitsize )
2019-05-29 13:08:37 +01:00
try :
struct . pack_into ( singletype , dobj , addr , val )
except struct . error as e :
exit ( ExitCode . RESTORE_DATA_ERROR ,
" Single type {} [fielddef= {} , addr=0x {:04x} , value= {} ] - skipped! " . format ( e , fielddef , addr , val ) ,
type_ = LogType . WARNING ,
doexit = not args . ignorewarning ,
line = inspect . getlineno ( inspect . currentframe ( ) ) )
2019-04-17 17:40:47 +01:00
value >> = bitsize
else :
if args . debug > = 3 :
print >> sys . stderr , " SetFieldValue(): String type - fielddef {} , addr 0x {:04x} value {} format_ {} " . format ( fielddef , addr , value , format_ )
2019-05-29 13:08:37 +01:00
try :
struct . pack_into ( format_ , dobj , addr , value )
except struct . error as e :
exit ( ExitCode . RESTORE_DATA_ERROR ,
" String type {} [fielddef= {} , addr=0x {:04x} , value= {} } - skipped! " . format ( e , fielddef , addr , value ) ,
type_ = LogType . WARNING ,
doexit = not args . ignorewarning ,
line = inspect . getlineno ( inspect . currentframe ( ) ) )
2019-04-17 17:40:47 +01:00
return dobj
2018-09-29 12:37:42 +01:00
def GetField ( dobj , fieldname , fielddef , raw = False , addroffset = 0 ) :
2018-09-25 13:08:36 +01:00
"""
Get field value from definition
@param dobj :
2018-10-02 12:42:21 +01:00
decrypted binary config data
2018-09-25 13:08:36 +01:00
@param fieldname :
name of the field
@param fielddef :
see Settings desc above
2018-09-26 14:18:01 +01:00
@param raw
return raw values ( True ) or converted values ( False )
2018-10-02 12:42:21 +01:00
@param addroffset
use offset for baseaddr ( used for recursive calls )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
@return :
2018-11-12 15:08:09 +00:00
field mapping
2018-09-25 13:08:36 +01:00
"""
2018-10-27 09:37:33 +01:00
if isinstance ( dobj , bytearray ) :
dobj = str ( dobj )
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
valuemapping = None
2018-10-29 15:26:45 +00:00
2018-10-27 09:37:33 +01:00
# get field definition
2019-04-17 17:40:47 +01:00
format_ , baseaddr , bits , bitshift , arraydef , group , tasmotacmnd = GetFieldDef ( fielddef , fields = ' format_, baseaddr, bits, bitshift, arraydef, group, tasmotacmnd ' )
2018-11-12 15:08:09 +00:00
# filter groups
if not IsFilterGroup ( group ) :
return valuemapping
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
# <arraydef> contains a integer list
if isinstance ( arraydef , list ) and len ( arraydef ) > 0 :
valuemapping = [ ]
2018-10-27 09:37:33 +01:00
offset = 0
2018-11-12 15:08:09 +00:00
for i in range ( 0 , arraydef [ 0 ] ) :
2018-10-27 09:37:33 +01:00
subfielddef = GetSubfieldDef ( fielddef )
length = GetFieldLength ( subfielddef )
2018-10-29 15:26:45 +00:00
if length != 0 :
2018-11-12 15:08:09 +00:00
value = GetField ( dobj , fieldname , subfielddef , raw = raw , addroffset = addroffset + offset )
valuemapping . append ( value )
2018-10-27 09:37:33 +01:00
offset + = length
2018-11-12 15:08:09 +00:00
2018-10-27 09:37:33 +01:00
# <format> contains a dict
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , dict ) :
2018-11-12 15:08:09 +00:00
mapping_value = { }
# -> iterate through format
2019-04-17 17:40:47 +01:00
for name in format_ :
2018-11-12 15:08:09 +00:00
value = None
2019-04-17 17:40:47 +01:00
value = GetField ( dobj , name , format_ [ name ] , raw = raw , addroffset = addroffset )
2018-11-12 15:08:09 +00:00
if value is not None :
mapping_value [ name ] = value
# copy complete returned mapping
valuemapping = copy . deepcopy ( mapping_value )
2018-10-27 09:37:33 +01:00
# a simple value
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , ( str , bool , int , float , long ) ) :
2018-10-27 09:37:33 +01:00
if GetFieldLength ( fielddef ) != 0 :
2019-04-17 17:40:47 +01:00
valuemapping = ReadWriteConverter ( GetFieldValue ( fielddef , dobj , baseaddr + addroffset ) , fielddef , read = True , raw = raw )
2018-09-29 12:37:42 +01:00
2018-10-27 09:37:33 +01:00
else :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . INTERNAL_ERROR , " Wrong mapping format definition: ' {} ' " . format ( format_ ) , type_ = LogType . WARNING , doexit = not args . ignorewarning , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
return valuemapping
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
def SetField ( dobj , fieldname , fielddef , restore , addroffset = 0 , filename = " " ) :
2018-09-25 13:08:36 +01:00
"""
2018-10-27 09:37:33 +01:00
Get field value from definition
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
@param dobj :
decrypted binary config data
@param fieldname :
name of the field
@param fielddef :
see Settings desc above
@param restore
restore mapping with the new value ( s )
2018-11-12 15:08:09 +00:00
@param addroffset
use offset for baseaddr ( used for recursive calls )
@param filename
related filename ( for messages only )
@return :
new decrypted binary config data
2018-10-02 12:42:21 +01:00
"""
2019-04-17 17:40:47 +01:00
format_ , baseaddr , bits , bitshift , arraydef , group , writeconverter = GetFieldDef ( fielddef , fields = ' format_, baseaddr, bits, bitshift, arraydef, group, writeconverter ' )
2018-11-12 15:08:09 +00:00
# cast unicode
2018-10-27 09:37:33 +01:00
fieldname = str ( fieldname )
2018-11-12 15:08:09 +00:00
# filter groups
if not IsFilterGroup ( group ) :
2018-10-29 15:26:45 +00:00
return dobj
2018-10-27 09:37:33 +01:00
# do not write readonly values
2018-11-12 15:08:09 +00:00
if writeconverter is False :
2019-04-17 17:40:47 +01:00
if args . debug > = 2 :
print >> sys . stderr , " SetField(): Readonly ' {} ' using ' {} ' / {} {} @ {} skipped " . format ( fieldname , format_ , arraydef , bits , hex ( baseaddr + addroffset ) )
2018-10-27 09:37:33 +01:00
return dobj
2018-11-12 15:08:09 +00:00
# <arraydef> contains a list
if isinstance ( arraydef , list ) and len ( arraydef ) > 0 :
2018-10-27 09:37:33 +01:00
offset = 0
2018-11-12 15:08:09 +00:00
if len ( restore ) > arraydef [ 0 ] :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . RESTORE_DATA_ERROR , " file ' {sfile} ' , array ' {sname} [ {selem} ] ' exceeds max number of elements [ {smax} ] " . format ( sfile = filename , sname = fieldname , selem = len ( restore ) , smax = arraydef [ 0 ] ) , type_ = LogType . WARNING , doexit = not args . ignorewarning , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-11-12 15:08:09 +00:00
for i in range ( 0 , arraydef [ 0 ] ) :
2018-10-27 09:37:33 +01:00
subfielddef = GetSubfieldDef ( fielddef )
length = GetFieldLength ( subfielddef )
if length != 0 :
2018-11-12 15:08:09 +00:00
if i > = len ( restore ) : # restore data list may be shorter than definition
2018-10-27 09:37:33 +01:00
break
2018-11-12 15:08:09 +00:00
subrestore = restore [ i ]
dobj = SetField ( dobj , fieldname , subfielddef , subrestore , addroffset = addroffset + offset , filename = filename )
2018-10-27 09:37:33 +01:00
offset + = length
# <format> contains a dict
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , dict ) :
for name in format_ : # -> iterate through format
2018-10-27 09:37:33 +01:00
if name in restore :
2019-04-17 17:40:47 +01:00
dobj = SetField ( dobj , name , format_ [ name ] , restore [ name ] , addroffset = addroffset , filename = filename )
2018-10-27 09:37:33 +01:00
# a simple value
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , ( str , bool , int , float , long ) ) :
2018-10-27 09:37:33 +01:00
valid = True
2018-11-07 12:42:13 +00:00
err = " "
errformat = " "
2018-10-27 09:37:33 +01:00
2019-04-17 17:40:47 +01:00
min_ , max_ = GetFieldMinMax ( fielddef )
2018-11-07 12:42:13 +00:00
value = _value = None
skip = False
2018-11-12 15:08:09 +00:00
# simple char value
2019-04-17 17:40:47 +01:00
if format_ [ - 1 : ] in [ ' c ' ] :
2018-10-27 09:37:33 +01:00
try :
2018-11-12 15:08:09 +00:00
value = ReadWriteConverter ( restore . encode ( STR_ENCODING ) [ 0 ] , fielddef , read = False )
except Exception , e :
2019-05-29 13:08:37 +01:00
exit ( e [ 0 ] , e [ 1 ] , type_ = LogType . WARNING , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-10-27 09:37:33 +01:00
valid = False
2018-11-12 15:08:09 +00:00
2018-10-27 09:37:33 +01:00
# bool
2019-04-17 17:40:47 +01:00
elif format_ [ - 1 : ] in [ ' ? ' ] :
2018-10-27 09:37:33 +01:00
try :
2018-11-12 15:08:09 +00:00
value = ReadWriteConverter ( bool ( restore ) , fielddef , read = False )
except Exception , e :
2019-05-29 13:08:37 +01:00
exit ( e [ 0 ] , e [ 1 ] , type_ = LogType . WARNING , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-10-27 09:37:33 +01:00
valid = False
2018-11-12 15:08:09 +00:00
2018-10-27 09:37:33 +01:00
# integer
2019-04-17 17:40:47 +01:00
elif format_ [ - 1 : ] in [ ' b ' , ' B ' , ' h ' , ' H ' , ' i ' , ' I ' , ' l ' , ' L ' , ' q ' , ' Q ' , ' P ' ] :
2018-11-12 15:08:09 +00:00
value = ReadWriteConverter ( restore , fielddef , read = False )
if isinstance ( value , ( str , unicode ) ) :
value = int ( value , 0 )
else :
value = int ( value )
# bits
if bits != 0 :
bitvalue = value
2019-04-17 17:40:47 +01:00
value = struct . unpack_from ( format_ , dobj , baseaddr + addroffset ) [ 0 ]
2018-11-12 15:08:09 +00:00
# validate restore value
valid = ValidateValue ( bitvalue , fielddef )
if not valid :
err = " valid bit range exceeding "
2019-04-17 17:40:47 +01:00
value = bitvalue
2018-10-27 09:37:33 +01:00
else :
mask = ( 1 << bits ) - 1
2018-11-12 15:08:09 +00:00
if bitvalue > mask :
2019-04-17 17:40:47 +01:00
min_ = 0
max_ = mask
2018-10-27 09:37:33 +01:00
_value = bitvalue
valid = False
else :
2018-11-12 15:08:09 +00:00
if bitshift > = 0 :
2018-10-27 09:37:33 +01:00
bitvalue << = bitshift
mask << = bitshift
else :
bitvalue >> = abs ( bitshift )
mask >> = abs ( bitshift )
2018-11-12 15:08:09 +00:00
v = value
2018-10-27 09:37:33 +01:00
value & = ( 0xffffffff ^ mask )
value | = bitvalue
2018-11-12 15:08:09 +00:00
# full size values
else :
# validate restore function
valid = ValidateValue ( value , fielddef )
if not valid :
err = " valid range exceeding "
_value = value
2018-10-27 09:37:33 +01:00
# float
2019-04-17 17:40:47 +01:00
elif format_ [ - 1 : ] in [ ' f ' , ' d ' ] :
2018-10-27 09:37:33 +01:00
try :
2018-11-12 15:08:09 +00:00
value = ReadWriteConverter ( float ( restore ) , fielddef , read = False )
2018-10-27 09:37:33 +01:00
except :
valid = False
2018-11-12 15:08:09 +00:00
2018-10-27 09:37:33 +01:00
# string
2019-04-17 17:40:47 +01:00
elif format_ [ - 1 : ] in [ ' s ' , ' p ' ] :
2018-11-12 15:08:09 +00:00
value = ReadWriteConverter ( restore . encode ( STR_ENCODING ) , fielddef , read = False )
err = " string length exceeding "
if value is not None :
2019-04-17 17:40:47 +01:00
max_ - = 1
valid = min_ < = len ( value ) < = max_
2018-11-12 15:08:09 +00:00
else :
skip = True
valid = True
2018-10-27 09:37:33 +01:00
2018-11-07 12:42:13 +00:00
if value is None and not skip :
# None is an invalid value
2018-10-27 09:37:33 +01:00
valid = False
2018-11-07 12:42:13 +00:00
if valid is None and not skip :
# validate against object type size
2019-04-17 17:40:47 +01:00
valid = min_ < = value < = max_
2018-11-07 12:42:13 +00:00
if not valid :
err = " type range exceeding "
errformat = " [ {smin} , {smax} ] "
2018-10-27 09:37:33 +01:00
if _value is None :
2018-11-07 12:42:13 +00:00
# copy value before possible change below
2018-10-27 09:37:33 +01:00
_value = value
2018-11-07 12:42:13 +00:00
2018-11-12 15:08:09 +00:00
if isinstance ( _value , ( str , unicode ) ) :
2018-10-27 09:37:33 +01:00
_value = " ' {} ' " . format ( _value )
if valid :
2018-11-07 12:42:13 +00:00
if not skip :
2019-04-17 17:40:47 +01:00
if args . debug > = 2 :
sbits = " {} bits shift {} " . format ( bits , bitshift ) if bits else " "
strvalue = " {} [ {} ] " . format ( _value , hex ( value ) ) if isinstance ( _value , int ) else _value
print >> sys . stderr , " SetField(): Set ' {} ' using ' {} ' / {} {} @ {} to {} " . format ( fieldname , format_ , arraydef , sbits , hex ( baseaddr + addroffset ) , strvalue )
if fieldname != ' cfg_crc ' and fieldname != ' _ ' :
prevvalue = GetFieldValue ( fielddef , dobj , baseaddr + addroffset )
dobj = SetFieldValue ( fielddef , dobj , baseaddr + addroffset , value )
curvalue = GetFieldValue ( fielddef , dobj , baseaddr + addroffset )
2018-11-07 12:42:13 +00:00
if prevvalue != curvalue and args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Value for ' {} ' changed from {} to {} " . format ( fieldname , prevvalue , curvalue ) , type_ = LogType . INFO )
2019-04-17 17:40:47 +01:00
else :
if args . debug > = 2 :
print >> sys . stderr , " SetField(): Special field ' {} ' using ' {} ' / {} {} @ {} skipped " . format ( fieldname , format_ , arraydef , bits , hex ( baseaddr + addroffset ) )
2018-10-27 09:37:33 +01:00
else :
2018-11-07 12:42:13 +00:00
sformat = " file ' {sfile} ' - {{ ' {sname} ' : {svalue} }} ( {serror} ) " + errformat
2019-05-29 13:08:37 +01:00
exit ( ExitCode . RESTORE_DATA_ERROR , sformat . format ( sfile = filename , sname = fieldname , serror = err , svalue = _value , smin = min_ , smax = max_ ) , type_ = LogType . WARNING , doexit = not args . ignorewarning )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
return dobj
2018-10-02 12:42:21 +01:00
2018-11-12 15:08:09 +00:00
def SetCmnd ( cmnds , fieldname , fielddef , valuemapping , mappedvalue , addroffset = 0 , idx = None ) :
"""
Get field value from definition
@param cmnds :
Tasmota command mapping : { ' group ' : [ ' cmnd ' < , ' cmnd ' . . . > ] . . . }
@param fieldname :
name of the field
@param fielddef :
see Settings desc above
@param valuemapping :
data mapping
@param mappedvalue
mappedvalue mapping with the new value ( s )
@param addroffset
use offset for baseaddr ( used for recursive calls )
@param idx
optional array index
@return :
new Tasmota command mapping
"""
2019-04-17 17:40:47 +01:00
format_ , baseaddr , bits , bitshift , arraydef , group , tasmotacmnd , writeconverter = GetFieldDef ( fielddef , fields = ' format_, baseaddr, bits, bitshift, arraydef, group, tasmotacmnd, writeconverter ' )
2018-11-12 15:08:09 +00:00
# cast unicode
fieldname = str ( fieldname )
# filter groups
if not IsFilterGroup ( group ) :
return cmnds
# <arraydef> contains a list
if isinstance ( arraydef , list ) and len ( arraydef ) > 0 :
offset = 0
if len ( mappedvalue ) > arraydef [ 0 ] :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . RESTORE_DATA_ERROR , " array ' {sname} [ {selem} ] ' exceeds max number of elements [ {smax} ] " . format ( sname = fieldname , selem = len ( mappedvalue ) , smax = arraydef [ 0 ] ) , type_ = LogType . WARNING , doexit = not args . ignorewarning , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-11-12 15:08:09 +00:00
for i in range ( 0 , arraydef [ 0 ] ) :
subfielddef = GetSubfieldDef ( fielddef )
length = GetFieldLength ( subfielddef )
if length != 0 :
if i > = len ( mappedvalue ) : # mappedvalue data list may be shorter than definition
break
subrestore = mappedvalue [ i ]
cmnds = SetCmnd ( cmnds , fieldname , subfielddef , valuemapping , subrestore , addroffset = addroffset + offset , idx = i )
offset + = length
# <format> contains a dict
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , dict ) :
for name in format_ : # -> iterate through format
2018-11-12 15:08:09 +00:00
if name in mappedvalue :
2019-04-17 17:40:47 +01:00
cmnds = SetCmnd ( cmnds , name , format_ [ name ] , valuemapping , mappedvalue [ name ] , addroffset = addroffset , idx = idx )
2018-11-12 15:08:09 +00:00
# a simple value
2019-04-17 17:40:47 +01:00
elif isinstance ( format_ , ( str , bool , int , float , long ) ) :
2019-08-28 15:13:23 +01:00
if group is not None :
group = group . title ( ) ;
2019-05-11 12:46:58 +01:00
if isinstance ( tasmotacmnd , tuple ) :
tasmotacmnds = tasmotacmnd
for tasmotacmnd in tasmotacmnds :
cmnd = CmndConverter ( valuemapping , mappedvalue , idx , fielddef )
if group is not None and cmnd is not None :
if group not in cmnds :
cmnds [ group ] = [ ]
2019-08-19 12:40:06 +01:00
if isinstance ( cmnd , list ) :
for c in cmnd :
cmnds [ group ] . append ( c )
else :
cmnds [ group ] . append ( cmnd )
2019-05-11 12:46:58 +01:00
else :
cmnd = CmndConverter ( valuemapping , mappedvalue , idx , fielddef )
if group is not None and cmnd is not None :
if group not in cmnds :
cmnds [ group ] = [ ]
2019-08-19 12:40:06 +01:00
if isinstance ( cmnd , list ) :
for c in cmnd :
cmnds [ group ] . append ( c )
else :
cmnds [ group ] . append ( cmnd )
2018-11-12 15:08:09 +00:00
return cmnds
def Bin2Mapping ( decode_cfg ) :
2018-10-02 12:42:21 +01:00
"""
2018-10-27 09:37:33 +01:00
Decodes binary data stream into pyhton mappings dict
2018-10-02 12:42:21 +01:00
2018-10-27 09:37:33 +01:00
@param decode_cfg :
2018-10-02 12:42:21 +01:00
binary config data ( decrypted )
2018-10-27 09:37:33 +01:00
@return :
2018-11-12 15:08:09 +00:00
valuemapping data as mapping dictionary
2018-10-02 12:42:21 +01:00
"""
2018-10-27 09:37:33 +01:00
if isinstance ( decode_cfg , bytearray ) :
decode_cfg = str ( decode_cfg )
2018-11-12 15:08:09 +00:00
# get binary header and template to use
2018-11-07 12:42:13 +00:00
version , size , setting = GetTemplateSetting ( decode_cfg )
2018-10-02 12:42:21 +01:00
2018-09-25 13:08:36 +01:00
# if we did not found a mathching setting
2018-11-07 12:42:13 +00:00
if setting is None :
2019-05-11 12:46:58 +01:00
exit ( ExitCode . UNSUPPORTED_VERSION , " Tasmota configuration version {} not supported " . format ( version ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-09-26 14:18:01 +01:00
2018-11-07 12:42:13 +00:00
if ' version ' in setting :
cfg_version = GetField ( decode_cfg , ' version ' , setting [ ' version ' ] , raw = True )
2018-09-26 14:18:01 +01:00
# check size if exists
if ' cfg_size ' in setting :
2018-10-27 09:37:33 +01:00
cfg_size = GetField ( decode_cfg , ' cfg_size ' , setting [ ' cfg_size ' ] , raw = True )
2018-11-12 15:08:09 +00:00
# read size should be same as definied in setting
2018-10-02 12:42:21 +01:00
if cfg_size > size :
2018-09-29 12:37:42 +01:00
# may be processed
2019-05-29 13:08:37 +01:00
exit ( ExitCode . DATA_SIZE_MISMATCH , " Number of bytes read does ot match - read {} , expected {} byte " . format ( cfg_size , size ) , type_ = LogType . ERROR , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-10-02 12:42:21 +01:00
elif cfg_size < size :
2018-09-29 12:37:42 +01:00
# less number of bytes can not be processed
2019-05-29 13:08:37 +01:00
exit ( ExitCode . DATA_SIZE_MISMATCH , " Number of bytes read to small to process - read {} , expected {} byte " . format ( cfg_size , size ) , type_ = LogType . ERROR , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-09-26 14:18:01 +01:00
# check crc if exists
if ' cfg_crc ' in setting :
2018-10-27 09:37:33 +01:00
cfg_crc = GetField ( decode_cfg , ' cfg_crc ' , setting [ ' cfg_crc ' ] , raw = True )
2018-09-26 14:18:01 +01:00
else :
2018-10-27 09:37:33 +01:00
cfg_crc = GetSettingsCrc ( decode_cfg )
if cfg_crc != GetSettingsCrc ( decode_cfg ) :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . DATA_CRC_ERROR , ' Data CRC error, read 0x {:x} should be 0x {:x} ' . format ( cfg_crc , GetSettingsCrc ( decode_cfg ) ) , type_ = LogType . WARNING , doexit = not args . ignorewarning , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
# get valuemapping
valuemapping = GetField ( decode_cfg , None , ( setting , 0 , ( None , None , ( INTERNAL , None ) ) ) )
2018-09-29 12:37:42 +01:00
# add header info
timestamp = datetime . now ( )
2018-11-12 15:08:09 +00:00
valuemapping [ ' header ' ] = { ' timestamp ' : timestamp . strftime ( " % Y- % m- %d % H: % M: % S " ) ,
' format ' : {
' jsonindent ' : args . jsonindent ,
' jsoncompact ' : args . jsoncompact ,
' jsonsort ' : args . jsonsort ,
' jsonhidepw ' : args . jsonhidepw ,
} ,
' template ' : {
' version ' : hex ( version ) ,
' crc ' : hex ( cfg_crc ) ,
} ,
' data ' : {
' crc ' : hex ( GetSettingsCrc ( decode_cfg ) ) ,
' size ' : len ( decode_cfg ) ,
} ,
' script ' : {
' name ' : os . path . basename ( __file__ ) ,
' version ' : VER ,
} ,
' os ' : ( platform . machine ( ) , platform . system ( ) , platform . release ( ) , platform . version ( ) , platform . platform ( ) ) ,
' python ' : platform . python_version ( ) ,
}
2018-11-07 12:42:13 +00:00
if ' cfg_crc ' in setting :
2018-11-12 15:08:09 +00:00
valuemapping [ ' header ' ] [ ' template ' ] . update ( { ' size ' : cfg_size } )
2018-11-07 12:42:13 +00:00
if ' version ' in setting :
2018-11-12 15:08:09 +00:00
valuemapping [ ' header ' ] [ ' data ' ] . update ( { ' version ' : hex ( cfg_version ) } )
2018-09-29 12:37:42 +01:00
2018-11-12 15:08:09 +00:00
return valuemapping
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
def Mapping2Bin ( decode_cfg , jsonconfig , filename = " " ) :
"""
Encodes into binary data stream
@param decode_cfg :
binary config data ( decrypted )
@param jsonconfig :
restore data mapping
@param filename :
name of the restore file ( for error output only )
@return :
2018-11-12 15:08:09 +00:00
changed binary config data ( decrypted ) or None on error
2018-10-27 09:37:33 +01:00
"""
if isinstance ( decode_cfg , str ) :
decode_cfg = bytearray ( decode_cfg )
# get binary header data to use the correct version template from device
2018-11-07 12:42:13 +00:00
version , size , setting = GetTemplateSetting ( decode_cfg )
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
# make empty binarray array
2018-10-27 09:37:33 +01:00
_buffer = bytearray ( )
2018-11-12 15:08:09 +00:00
# add data
2018-10-27 09:37:33 +01:00
_buffer . extend ( decode_cfg )
2018-11-07 12:42:13 +00:00
if setting is not None :
2018-10-27 09:37:33 +01:00
# iterate through restore data mapping
for name in jsonconfig :
# key must exist in both dict
if name in setting :
2018-11-12 15:08:09 +00:00
SetField ( _buffer , name , setting [ name ] , jsonconfig [ name ] , addroffset = 0 , filename = filename )
2018-10-27 09:37:33 +01:00
else :
if name != ' header ' :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . RESTORE_DATA_ERROR , " Restore file ' {} ' contains obsolete name ' {} ' , skipped " . format ( filename , name ) , type_ = LogType . WARNING , doexit = not args . ignorewarning )
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
if ' cfg_crc ' in setting :
crc = GetSettingsCrc ( _buffer )
struct . pack_into ( setting [ ' cfg_crc ' ] [ 0 ] , _buffer , setting [ ' cfg_crc ' ] [ 1 ] , crc )
2018-10-27 09:37:33 +01:00
return _buffer
else :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . UNSUPPORTED_VERSION , " File ' {} ' , Tasmota configuration version 0x {:x} not supported " . format ( filename , version ) , type_ = LogType . WARNING , doexit = not args . ignorewarning )
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
return None
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
def Mapping2Cmnd ( decode_cfg , valuemapping , filename = " " ) :
"""
Encodes mapping data into Tasmota command mapping
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
@param decode_cfg :
binary config data ( decrypted )
@param valuemapping :
data mapping
@param filename :
name of the restore file ( for error output only )
@return :
Tasmota command mapping { group : [ cmnd < , cmnd < , . . . >> ] }
"""
if isinstance ( decode_cfg , str ) :
decode_cfg = bytearray ( decode_cfg )
# get binary header data to use the correct version template from device
version , size , setting = GetTemplateSetting ( decode_cfg )
cmnds = { }
if setting is not None :
# iterate through restore data mapping
for name in valuemapping :
# key must exist in both dict
if name in setting :
cmnds = SetCmnd ( cmnds , name , setting [ name ] , valuemapping , valuemapping [ name ] , addroffset = 0 )
else :
if name != ' header ' :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . RESTORE_DATA_ERROR , " Restore file ' {} ' contains obsolete name ' {} ' , skipped " . format ( filename , name ) , type_ = LogType . WARNING , doexit = not args . ignorewarning )
2018-11-12 15:08:09 +00:00
return cmnds
else :
2019-05-29 13:08:37 +01:00
exit ( ExitCode . UNSUPPORTED_VERSION , " File ' {} ' , Tasmota configuration version 0x {:x} not supported " . format ( filename , version ) , type_ = LogType . WARNING , doexit = not args . ignorewarning )
2018-11-12 15:08:09 +00:00
return None
def Backup ( backupfile , backupfileformat , encode_cfg , decode_cfg , configmapping ) :
2018-10-27 09:37:33 +01:00
"""
Create backup file
@param backupfile :
Raw backup filename from program args
@param backupfileformat :
Backup file format
@param encode_cfg :
binary config data ( encrypted )
@param decode_cfg :
binary config data ( decrypted )
2018-11-12 15:08:09 +00:00
@param configmapping :
2018-10-27 09:37:33 +01:00
config data mapppings
"""
2018-11-12 15:08:09 +00:00
name , ext = os . path . splitext ( backupfile )
if ext . lower ( ) == ' . ' + FileType . BIN . lower ( ) :
backupfileformat = FileType . BIN
elif ext . lower ( ) == ' . ' + FileType . DMP . lower ( ) :
backupfileformat = FileType . DMP
elif ext . lower ( ) == ' . ' + FileType . JSON . lower ( ) :
backupfileformat = FileType . JSON
2018-10-27 09:37:33 +01:00
fileformat = " "
2018-11-12 15:08:09 +00:00
# Tasmota format
if backupfileformat . lower ( ) == FileType . DMP . lower ( ) :
fileformat = " Tasmota "
backup_filename = MakeFilename ( backupfile , FileType . DMP , configmapping )
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Writing backup file ' {} ' ( {} format) " . format ( backup_filename , fileformat ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( backup_filename , " wb " ) as backupfp :
backupfp . write ( encode_cfg )
2018-10-27 09:37:33 +01:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( backup_filename , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-11-12 15:08:09 +00:00
# binary format
elif backupfileformat . lower ( ) == FileType . BIN . lower ( ) :
fileformat = " binary "
backup_filename = MakeFilename ( backupfile , FileType . BIN , configmapping )
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Writing backup file ' {} ' ( {} format) " . format ( backup_filename , fileformat ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( backup_filename , " wb " ) as backupfp :
backupfp . write ( struct . pack ( ' <L ' , BINARYFILE_MAGIC ) )
backupfp . write ( decode_cfg )
2018-10-27 09:37:33 +01:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( backup_filename , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
# JSON format
elif backupfileformat . lower ( ) == FileType . JSON . lower ( ) :
fileformat = " JSON "
2018-11-12 15:08:09 +00:00
backup_filename = MakeFilename ( backupfile , FileType . JSON , configmapping )
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Writing backup file ' {} ' ( {} format) " . format ( backup_filename , fileformat ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( backup_filename , " w " ) as backupfp :
json . dump ( configmapping , backupfp , sort_keys = args . jsonsort , indent = None if args . jsonindent < 0 else args . jsonindent , separators = ( ' , ' , ' : ' ) if args . jsoncompact else ( ' , ' , ' : ' ) )
2018-10-27 09:37:33 +01:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( backup_filename , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-11-12 15:08:09 +00:00
2018-10-27 09:37:33 +01:00
if args . verbose :
srctype = ' device '
src = args . device
if args . tasmotafile is not None :
srctype = ' file '
src = args . tasmotafile
2019-05-29 13:08:37 +01:00
message ( " Backup successful from {} ' {} ' to file ' {} ' ( {} format) " . format ( srctype , src , backup_filename , fileformat ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
2018-12-13 05:57:44 +00:00
def Restore ( restorefile , backupfileformat , encode_cfg , decode_cfg , configmapping ) :
2018-10-27 09:37:33 +01:00
"""
Restore from file
@param encode_cfg :
binary config data ( encrypted )
2018-12-13 05:57:44 +00:00
@param backupfileformat :
Backup file format
2018-10-27 09:37:33 +01:00
@param decode_cfg :
binary config data ( decrypted )
2018-11-12 15:08:09 +00:00
@param configmapping :
2018-10-27 09:37:33 +01:00
config data mapppings
"""
new_encode_cfg = None
2018-12-13 05:57:44 +00:00
restorefileformat = None
if backupfileformat . lower ( ) == ' bin ' :
restorefileformat = FileType . BIN
elif backupfileformat . lower ( ) == ' dmp ' :
restorefileformat = FileType . DMP
elif backupfileformat . lower ( ) == ' json ' :
restorefileformat = FileType . JSON
restorefilename = MakeFilename ( restorefile , restorefileformat , configmapping )
2018-10-27 09:37:33 +01:00
filetype = GetFileType ( restorefilename )
if filetype == FileType . DMP :
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Reading restore file ' {} ' (Tasmota format) " . format ( restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( restorefilename , " rb " ) as restorefp :
new_encode_cfg = restorefp . read ( )
2018-10-27 09:37:33 +01:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( restorefilename , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
elif filetype == FileType . BIN :
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Reading restore file ' {} ' (Binary format) " . format ( restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( restorefilename , " rb " ) as restorefp :
restorebin = restorefp . read ( )
2018-10-27 09:37:33 +01:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( restorefilename , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
header = struct . unpack_from ( ' <L ' , restorebin , 0 ) [ 0 ]
if header == BINARYFILE_MAGIC :
decode_cfg = restorebin [ 4 : ] # remove header from encrypted config file
new_encode_cfg = DecryptEncrypt ( decode_cfg ) # process binary to binary config
elif filetype == FileType . JSON or filetype == FileType . INVALID_JSON :
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Reading restore file ' {} ' (JSON format) " . format ( restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( restorefilename , " r " ) as restorefp :
jsonconfig = json . load ( restorefp )
2018-10-27 09:37:33 +01:00
except ValueError as e :
exit ( ExitCode . JSON_READ_ERROR , " File ' {} ' invalid JSON: {} " . format ( restorefilename , e ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
# process json config to binary config
new_decode_cfg = Mapping2Bin ( decode_cfg , jsonconfig , restorefilename )
new_encode_cfg = DecryptEncrypt ( new_decode_cfg )
elif filetype == FileType . FILE_NOT_FOUND :
exit ( ExitCode . FILE_NOT_FOUND , " File ' {} ' not found " . format ( restorefilename ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
elif filetype == FileType . INCOMPLETE_JSON :
exit ( ExitCode . JSON_READ_ERROR , " File ' {} ' incomplete JSON, missing name ' header ' " . format ( restorefilename ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
elif filetype == FileType . INVALID_BIN :
exit ( ExitCode . FILE_READ_ERROR , " File ' {} ' invalid BIN format " . format ( restorefilename ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
else :
exit ( ExitCode . FILE_READ_ERROR , " File ' {} ' unknown error " . format ( restorefilename ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
if new_encode_cfg is not None :
2019-05-11 12:46:58 +01:00
if args . verbose :
new_decode_cfg = DecryptEncrypt ( new_encode_cfg )
# get binary header and template to use
version , size , setting = GetTemplateSetting ( new_decode_cfg )
# get config file version
cfg_version = GetField ( new_decode_cfg , ' version ' , setting [ ' version ' ] , raw = True )
2019-05-29 13:08:37 +01:00
message ( " Config file contains data of Sonoff-Tasmota {} " . format ( GetVersionStr ( cfg_version ) ) , type_ = LogType . INFO )
2018-11-12 15:08:09 +00:00
if args . forcerestore or new_encode_cfg != encode_cfg :
2018-10-27 09:37:33 +01:00
# write config direct to device via http
if args . device is not None :
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Push new data to ' {} ' using restore file ' {} ' " . format ( args . device , restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
error_code , error_str = PushTasmotaConfig ( new_encode_cfg , args . device , args . port , args . username , args . password )
if error_code :
exit ( ExitCode . UPLOAD_CONFIG_ERROR , " Config data upload failed - {} " . format ( error_str ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
else :
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Restore successful to device ' {} ' using restore file ' {} ' " . format ( args . device , restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
# write config from a file
elif args . tasmotafile is not None :
2018-11-07 12:42:13 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Write new data to file ' {} ' using restore file ' {} ' " . format ( args . tasmotafile , restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
try :
2019-01-04 09:24:46 +00:00
with open ( args . tasmotafile , " wb " ) as outputfile :
outputfile . write ( new_encode_cfg )
2018-10-27 09:37:33 +01:00
except Exception , e :
exit ( e [ 0 ] , " ' {} ' {} " . format ( args . tasmotafile , e [ 1 ] ) , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2019-01-04 09:24:46 +00:00
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Restore successful to file ' {} ' using restore file ' {} ' " . format ( args . tasmotafile , restorefilename ) , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
else :
global exitcode
exitcode = ExitCode . RESTORE_SKIPPED
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Configuration data leaving unchanged " , type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
def OutputTasmotaCmnds ( tasmotacmnds ) :
"""
Print Tasmota command mapping
@param tasmotacmnds :
Tasmota command mapping { group : [ cmnd < , cmnd < , . . . >> ] }
"""
def OutputTasmotaSubCmnds ( cmnds ) :
if args . cmndsort :
for cmnd in sorted ( cmnds , key = lambda cmnd : [ int ( c ) if c . isdigit ( ) else c for c in re . split ( ' ( \ d+) ' , cmnd ) ] ) :
print " {} {} " . format ( " " * args . cmndindent , cmnd )
else :
for cmnd in cmnds :
print " {} {} " . format ( " " * args . cmndindent , cmnd )
2019-05-11 12:46:58 +01:00
groups = GetGroupList ( Settings [ 0 ] [ 2 ] )
2018-11-12 15:08:09 +00:00
if args . cmndgroup :
2019-05-11 12:46:58 +01:00
for group in groups :
if group . title ( ) in ( groupname . title ( ) for groupname in tasmotacmnds ) :
2018-11-12 15:08:09 +00:00
cmnds = tasmotacmnds [ group ]
print
print " # {} : " . format ( group )
OutputTasmotaSubCmnds ( cmnds )
else :
cmnds = [ ]
2019-05-11 12:46:58 +01:00
for group in groups :
if group . title ( ) in ( groupname . title ( ) for groupname in tasmotacmnds ) :
2018-11-12 15:08:09 +00:00
cmnds . extend ( tasmotacmnds [ group ] )
OutputTasmotaSubCmnds ( cmnds )
2018-10-27 09:37:33 +01:00
def ParseArgs ( ) :
"""
Program argument parser
@return :
configargparse . parse_args ( ) result
"""
global parser
parser = configargparse . ArgumentParser ( description = ' Backup/Restore Sonoff-Tasmota configuration data. ' ,
epilog = ' Either argument -d <host> or -f <filename> must be given. ' ,
add_help = False ,
formatter_class = lambda prog : CustomHelpFormatter ( prog ) )
source = parser . add_argument_group ( ' Source ' , ' Read/Write Tasmota configuration from/to ' )
source . add_argument ( ' -f ' , ' --file ' , ' --tasmota-file ' ,
2018-09-25 13:08:36 +01:00
metavar = ' <filename> ' ,
dest = ' tasmotafile ' ,
default = DEFAULTS [ ' source ' ] [ ' tasmotafile ' ] ,
2018-10-27 09:37:33 +01:00
help = " file to retrieve/write Tasmota configuration from/to (default: {} ) ' " . format ( DEFAULTS [ ' source ' ] [ ' tasmotafile ' ] ) )
source . add_argument ( ' -d ' , ' --device ' , ' --host ' ,
2018-09-26 14:18:01 +01:00
metavar = ' <host> ' ,
2018-09-25 13:08:36 +01:00
dest = ' device ' ,
default = DEFAULTS [ ' source ' ] [ ' device ' ] ,
2018-10-27 09:37:33 +01:00
help = " hostname or IP address to retrieve/send Tasmota configuration from/to (default: {} ) " . format ( DEFAULTS [ ' source ' ] [ ' device ' ] ) )
source . add_argument ( ' -P ' , ' --port ' ,
metavar = ' <port> ' ,
dest = ' port ' ,
default = DEFAULTS [ ' source ' ] [ ' port ' ] ,
help = " TCP/IP port number to use for the host connection (default: {} ) " . format ( DEFAULTS [ ' source ' ] [ ' port ' ] ) )
2018-09-25 13:08:36 +01:00
source . add_argument ( ' -u ' , ' --username ' ,
2018-10-27 09:37:33 +01:00
metavar = ' <username> ' ,
2018-09-25 13:08:36 +01:00
dest = ' username ' ,
default = DEFAULTS [ ' source ' ] [ ' username ' ] ,
2018-09-29 12:37:42 +01:00
help = " host HTTP access username (default: {} ) " . format ( DEFAULTS [ ' source ' ] [ ' username ' ] ) )
2018-09-25 13:08:36 +01:00
source . add_argument ( ' -p ' , ' --password ' ,
metavar = ' <password> ' ,
dest = ' password ' ,
default = DEFAULTS [ ' source ' ] [ ' password ' ] ,
2018-09-29 12:37:42 +01:00
help = " host HTTP access password (default: {} ) " . format ( DEFAULTS [ ' source ' ] [ ' password ' ] ) )
2018-09-25 13:08:36 +01:00
2018-11-12 15:08:09 +00:00
backup = parser . add_argument_group ( ' Backup/Restore ' , ' Backup & restore specification ' )
2018-10-27 09:37:33 +01:00
backup . add_argument ( ' -i ' , ' --restore-file ' ,
metavar = ' <filename> ' ,
dest = ' restorefile ' ,
default = DEFAULTS [ ' backup ' ] [ ' backupfile ' ] ,
2018-11-14 07:03:55 +00:00
help = " file to restore configuration from (default: {} ). Replacements: @v=firmware version from config, @f=device friendly name from config, @h=device hostname from config, @H=device hostname from device (-d arg only) " . format ( DEFAULTS [ ' backup ' ] [ ' restorefile ' ] ) )
2018-10-27 09:37:33 +01:00
backup . add_argument ( ' -o ' , ' --backup-file ' ,
metavar = ' <filename> ' ,
dest = ' backupfile ' ,
default = DEFAULTS [ ' backup ' ] [ ' backupfile ' ] ,
2018-11-14 07:03:55 +00:00
help = " file to backup configuration to (default: {} ). Replacements: @v=firmware version from config, @f=device friendly name from config, @h=device hostname from config, @H=device hostname from device (-d arg only) " . format ( DEFAULTS [ ' backup ' ] [ ' backupfile ' ] ) )
2018-11-12 15:08:09 +00:00
backup_file_formats = [ ' json ' , ' bin ' , ' dmp ' ]
backup . add_argument ( ' -t ' , ' --backup-type ' ,
metavar = ' | ' . join ( backup_file_formats ) ,
2018-10-27 09:37:33 +01:00
dest = ' backupfileformat ' ,
2018-11-12 15:08:09 +00:00
choices = backup_file_formats ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' backup ' ] [ ' backupfileformat ' ] ,
help = " backup filetype (default: ' {} ' ) " . format ( DEFAULTS [ ' backup ' ] [ ' backupfileformat ' ] ) )
backup . add_argument ( ' -E ' , ' --extension ' ,
dest = ' extension ' ,
action = ' store_true ' ,
default = DEFAULTS [ ' backup ' ] [ ' extension ' ] ,
help = " append filetype extension for -i and -o filename {} " . format ( ' (default) ' if DEFAULTS [ ' backup ' ] [ ' extension ' ] else ' ' ) )
backup . add_argument ( ' -e ' , ' --no-extension ' ,
dest = ' extension ' ,
action = ' store_false ' ,
default = DEFAULTS [ ' backup ' ] [ ' extension ' ] ,
help = " do not append filetype extension, use -i and -o filename as passed {} " . format ( ' (default) ' if not DEFAULTS [ ' backup ' ] [ ' extension ' ] else ' ' ) )
2018-11-12 15:08:09 +00:00
backup . add_argument ( ' -F ' , ' --force-restore ' ,
dest = ' forcerestore ' ,
action = ' store_true ' ,
default = DEFAULTS [ ' backup ' ] [ ' forcerestore ' ] ,
help = " force restore even configuration is identical {} " . format ( ' (default) ' if DEFAULTS [ ' backup ' ] [ ' forcerestore ' ] else ' ' ) )
2018-10-27 09:37:33 +01:00
2018-11-12 15:08:09 +00:00
jsonformat = parser . add_argument_group ( ' JSON output ' , ' JSON format specification ' )
2018-10-27 09:37:33 +01:00
jsonformat . add_argument ( ' --json-indent ' ,
metavar = ' <indent> ' ,
2018-09-26 14:18:01 +01:00
dest = ' jsonindent ' ,
type = int ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' jsonformat ' ] [ ' jsonindent ' ] ,
help = " pretty-printed JSON output using indent level (default: ' {} ' ). -1 disables indent. " . format ( DEFAULTS [ ' jsonformat ' ] [ ' jsonindent ' ] ) )
jsonformat . add_argument ( ' --json-compact ' ,
2018-09-26 14:18:01 +01:00
dest = ' jsoncompact ' ,
action = ' store_true ' ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' jsonformat ' ] [ ' jsoncompact ' ] ,
help = " compact JSON output by eliminate whitespace {} " . format ( ' (default) ' if DEFAULTS [ ' jsonformat ' ] [ ' jsoncompact ' ] else ' ' ) )
2018-10-02 12:42:21 +01:00
2018-10-27 09:37:33 +01:00
jsonformat . add_argument ( ' --json-sort ' ,
dest = ' jsonsort ' ,
2018-10-02 12:42:21 +01:00
action = ' store_true ' ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' jsonformat ' ] [ ' jsonsort ' ] ,
help = configargparse . SUPPRESS ) #"sort json keywords{}".format(' (default)' if DEFAULTS['jsonformat']['jsonsort'] else '') )
jsonformat . add_argument ( ' --json-unsort ' ,
dest = ' jsonsort ' ,
2018-10-02 12:42:21 +01:00
action = ' store_false ' ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' jsonformat ' ] [ ' jsonsort ' ] ,
help = configargparse . SUPPRESS ) #"do not sort json keywords{}".format(' (default)' if not DEFAULTS['jsonformat']['jsonsort'] else '') )
2018-10-02 12:42:21 +01:00
2018-10-27 09:37:33 +01:00
jsonformat . add_argument ( ' --json-hide-pw ' ,
dest = ' jsonhidepw ' ,
2018-09-25 13:08:36 +01:00
action = ' store_true ' ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' jsonformat ' ] [ ' jsonhidepw ' ] ,
help = " hide passwords {} " . format ( ' (default) ' if DEFAULTS [ ' jsonformat ' ] [ ' jsonhidepw ' ] else ' ' ) )
2018-11-12 15:08:09 +00:00
jsonformat . add_argument ( ' --json-show-pw ' , ' --json-unhide-pw ' ,
2018-10-27 09:37:33 +01:00
dest = ' jsonhidepw ' ,
2018-10-02 12:42:21 +01:00
action = ' store_false ' ,
2018-10-27 09:37:33 +01:00
default = DEFAULTS [ ' jsonformat ' ] [ ' jsonhidepw ' ] ,
help = " unhide passwords {} " . format ( ' (default) ' if not DEFAULTS [ ' jsonformat ' ] [ ' jsonhidepw ' ] else ' ' ) )
2018-10-02 12:42:21 +01:00
2018-11-12 15:08:09 +00:00
cmndformat = parser . add_argument_group ( ' Tasmota command output ' , ' Tasmota command output format specification ' )
cmndformat . add_argument ( ' --cmnd-indent ' ,
metavar = ' <indent> ' ,
dest = ' cmndindent ' ,
type = int ,
default = DEFAULTS [ ' cmndformat ' ] [ ' cmndindent ' ] ,
help = " Tasmota command grouping indent level (default: ' {} ' ). 0 disables indent " . format ( DEFAULTS [ ' cmndformat ' ] [ ' cmndindent ' ] ) )
cmndformat . add_argument ( ' --cmnd-groups ' ,
dest = ' cmndgroup ' ,
action = ' store_true ' ,
default = DEFAULTS [ ' cmndformat ' ] [ ' cmndgroup ' ] ,
help = " group Tasmota commands {} " . format ( ' (default) ' if DEFAULTS [ ' cmndformat ' ] [ ' cmndgroup ' ] else ' ' ) )
cmndformat . add_argument ( ' --cmnd-nogroups ' ,
dest = ' cmndgroup ' ,
action = ' store_false ' ,
default = DEFAULTS [ ' cmndformat ' ] [ ' cmndgroup ' ] ,
help = " leave Tasmota commands ungrouped {} " . format ( ' (default) ' if not DEFAULTS [ ' cmndformat ' ] [ ' cmndgroup ' ] else ' ' ) )
cmndformat . add_argument ( ' --cmnd-sort ' ,
dest = ' cmndsort ' ,
action = ' store_true ' ,
default = DEFAULTS [ ' cmndformat ' ] [ ' cmndsort ' ] ,
help = " sort Tasmota commands {} " . format ( ' (default) ' if DEFAULTS [ ' cmndformat ' ] [ ' cmndsort ' ] else ' ' ) )
cmndformat . add_argument ( ' --cmnd-unsort ' ,
dest = ' cmndsort ' ,
action = ' store_false ' ,
default = DEFAULTS [ ' cmndformat ' ] [ ' cmndsort ' ] ,
help = " leave Tasmota commands unsorted {} " . format ( ' (default) ' if not DEFAULTS [ ' cmndformat ' ] [ ' cmndsort ' ] else ' ' ) )
common = parser . add_argument_group ( ' Common ' , ' Optional arguments ' )
common . add_argument ( ' -c ' , ' --config ' ,
metavar = ' <filename> ' ,
dest = ' configfile ' ,
default = DEFAULTS [ ' common ' ] [ ' configfile ' ] ,
is_config_file = True ,
help = " program config file - can be used to set default command args (default: {} ) " . format ( DEFAULTS [ ' common ' ] [ ' configfile ' ] ) )
common . add_argument ( ' -S ' , ' --output ' ,
dest = ' output ' ,
action = ' store_true ' ,
default = DEFAULTS [ ' common ' ] [ ' output ' ] ,
help = " display output regardsless of backup/restore usage {} " . format ( " (default) " if DEFAULTS [ ' common ' ] [ ' output ' ] else " (default do not output on backup or restore usage) " ) )
output_formats = [ ' json ' , ' cmnd ' , ' command ' ]
common . add_argument ( ' -T ' , ' --output-format ' ,
metavar = ' | ' . join ( output_formats ) ,
dest = ' outputformat ' ,
choices = output_formats ,
default = DEFAULTS [ ' common ' ] [ ' outputformat ' ] ,
help = " display output format (default: ' {} ' ) " . format ( DEFAULTS [ ' common ' ] [ ' outputformat ' ] ) )
groups = GetGroupList ( Settings [ 0 ] [ 2 ] )
if ' * ' in groups :
groups . remove ( ' * ' )
common . add_argument ( ' -g ' , ' --group ' ,
dest = ' filter ' ,
choices = groups ,
nargs = ' + ' ,
2019-05-11 12:46:58 +01:00
type = lambda s : s . title ( ) ,
2018-11-12 15:08:09 +00:00
default = DEFAULTS [ ' common ' ] [ ' filter ' ] ,
help = " limit data processing to command groups (default {} ) " . format ( " no filter " if DEFAULTS [ ' common ' ] [ ' filter ' ] == None else DEFAULTS [ ' common ' ] [ ' filter ' ] ) )
common . add_argument ( ' --ignore-warnings ' ,
dest = ' ignorewarning ' ,
action = ' store_true ' ,
default = DEFAULTS [ ' common ' ] [ ' ignorewarning ' ] ,
help = " do not exit on warnings {} . Not recommended, used by your own responsibility! " . format ( ' (default) ' if DEFAULTS [ ' common ' ] [ ' ignorewarning ' ] else ' ' ) )
info = parser . add_argument_group ( ' Info ' , ' Extra information ' )
2018-10-27 09:37:33 +01:00
info . add_argument ( ' -D ' , ' --debug ' ,
dest = ' debug ' ,
2019-04-17 17:40:47 +01:00
action = ' count ' ,
2018-10-27 09:37:33 +01:00
help = configargparse . SUPPRESS )
info . add_argument ( ' -h ' , ' --help ' ,
dest = ' shorthelp ' ,
action = ' store_true ' ,
help = ' show usage help message and exit ' )
info . add_argument ( " -H " , " --full-help " ,
action = " help " ,
help = " show full help message and exit " )
info . add_argument ( ' -v ' , ' --verbose ' ,
dest = ' verbose ' ,
action = ' store_true ' ,
help = ' produce more output about what the program does ' )
info . add_argument ( ' -V ' , ' --version ' ,
action = ' version ' ,
version = PROG )
2018-09-25 13:08:36 +01:00
args = parser . parse_args ( )
2018-10-02 12:42:21 +01:00
2019-04-17 17:40:47 +01:00
if args . debug > = 1 :
2018-10-27 09:37:33 +01:00
print >> sys . stderr , parser . format_values ( )
print >> sys . stderr , " Settings: "
for k in args . __dict__ :
print >> sys . stderr , " " + str ( k ) , " = " , eval ( ' args. {} ' . format ( k ) )
return args
2018-10-02 12:42:21 +01:00
2018-10-27 09:37:33 +01:00
if __name__ == " __main__ " :
args = ParseArgs ( )
if args . shorthelp :
ShortHelp ( )
2018-09-25 13:08:36 +01:00
2018-10-27 09:37:33 +01:00
# check source args
if args . device is not None and args . tasmotafile is not None :
exit ( ExitCode . ARGUMENT_ERROR , " Unable to select source, do not use -d and -f together " , line = inspect . getlineno ( inspect . currentframe ( ) ) )
2018-11-07 12:42:13 +00:00
# default no configuration available
encode_cfg = None
# pull config from Tasmota device
if args . tasmotafile is not None :
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Load data from file ' {} ' " . format ( args . tasmotafile ) , type_ = LogType . INFO )
2018-11-07 12:42:13 +00:00
encode_cfg = LoadTasmotaConfig ( args . tasmotafile )
# load config from Tasmota file
if args . device is not None :
if args . verbose :
2019-05-29 13:08:37 +01:00
message ( " Load data from device ' {} ' " . format ( args . device ) , type_ = LogType . INFO )
2018-11-07 12:42:13 +00:00
encode_cfg = PullTasmotaConfig ( args . device , args . port , username = args . username , password = args . password )
2018-10-27 09:37:33 +01:00
if encode_cfg is None :
# no config source given
ShortHelp ( False )
print
print parser . epilog
sys . exit ( ExitCode . OK )
if len ( encode_cfg ) == 0 :
exit ( ExitCode . FILE_READ_ERROR , " Unable to read configuration data from {} ' {} ' " . format ( ' device ' if args . device is not None else ' file ' , \
args . device if args . device is not None else args . tasmotafile ) \
, line = inspect . getlineno ( inspect . currentframe ( ) ) )
# decrypt Tasmota config
decode_cfg = DecryptEncrypt ( encode_cfg )
# decode into mappings dictionary
2018-11-12 15:08:09 +00:00
configmapping = Bin2Mapping ( decode_cfg )
if args . verbose and ' version ' in configmapping :
2019-05-11 12:46:58 +01:00
message ( " {} ' {} ' is using Sonoff-Tasmota {} " . format ( ' File ' if args . tasmotafile is not None else ' Device ' ,
2018-11-12 15:08:09 +00:00
args . tasmotafile if args . tasmotafile is not None else args . device ,
GetVersionStr ( configmapping [ ' version ' ] ) ) ,
2019-05-29 13:08:37 +01:00
type_ = LogType . INFO )
2018-10-27 09:37:33 +01:00
# backup to file
if args . backupfile is not None :
2018-11-12 15:08:09 +00:00
Backup ( args . backupfile , args . backupfileformat , encode_cfg , decode_cfg , configmapping )
2018-10-27 09:37:33 +01:00
# restore from file
if args . restorefile is not None :
2018-12-13 05:57:44 +00:00
Restore ( args . restorefile , args . backupfileformat , encode_cfg , decode_cfg , configmapping )
2018-10-27 09:37:33 +01:00
# json screen output
2018-11-12 15:08:09 +00:00
if ( args . backupfile is None and args . restorefile is None ) or args . output :
if args . outputformat == ' json ' :
print json . dumps ( configmapping , sort_keys = args . jsonsort , indent = None if args . jsonindent < 0 else args . jsonindent , separators = ( ' , ' , ' : ' ) if args . jsoncompact else ( ' , ' , ' : ' ) )
if args . outputformat == ' cmnd ' or args . outputformat == ' command ' :
tasmotacmnds = Mapping2Cmnd ( decode_cfg , configmapping )
OutputTasmotaCmnds ( tasmotacmnds )
2019-02-15 17:35:29 +00:00
sys . exit ( exitcode )
