mirror of https://github.com/arendst/Tasmota.git
Created Script Cookbook (markdown)
Michael Ingraham
parent
e25353bca0
commit
3b656ac506
|
|
@ -0,0 +1,496 @@
|
|||
***example script*** (actually this code is too large)
|
||||
meant to show some of the possibilities
|
||||
|
||||
**\>D**
|
||||
; define all vars here
|
||||
p:mintmp=10 (p:means permanent)
|
||||
p:maxtmp=30
|
||||
t:timer1=30 (t:means countdown timer)
|
||||
t:mt=0
|
||||
i:count=0 (i:means auto counter)
|
||||
hello="hello world"
|
||||
string="xxx"
|
||||
url="[192.168.178.86]"
|
||||
hum=0
|
||||
temp=0
|
||||
timer=0
|
||||
dimmer=0
|
||||
sw=0
|
||||
rssi=0
|
||||
param=0
|
||||
|
||||
col=""
|
||||
ocol=""
|
||||
chan1=0
|
||||
chan2=0
|
||||
chan3=0
|
||||
|
||||
ahum=0
|
||||
atemp=0
|
||||
tcnt=0
|
||||
hour=0
|
||||
state=1
|
||||
m:med5=0
|
||||
M:movav=0
|
||||
; define array with 10 entries
|
||||
m:array=0 10
|
||||
|
||||
**\>B**
|
||||
|
||||
string=hello+"how are you?"
|
||||
=\>print BOOT executed
|
||||
=\>print %hello%
|
||||
=\>mp3track 1
|
||||
|
||||
; list gpio pin definitions
|
||||
for cnt 0 16 1
|
||||
tmp=pd[cnt]
|
||||
=>print %cnt% = %tmp%
|
||||
next
|
||||
|
||||
; get gpio pin for relais 1
|
||||
tmp=pn[21]
|
||||
=>print relais 1 is on pin %tmp%
|
||||
|
||||
; pulse relais over raw gpio
|
||||
spin(tmp 1)
|
||||
delay(100)
|
||||
spin(tmp 0)
|
||||
|
||||
; raw pin level
|
||||
=>print level of gpio1 %pin[1]%
|
||||
|
||||
; pulse over tasmota cmd
|
||||
=>power 1
|
||||
delay(100)
|
||||
=>power 0
|
||||
|
||||
**\>T**
|
||||
hum=BME280#Humidity
|
||||
temp=BME280#Temperature
|
||||
rssi=Wifi#RSSI
|
||||
string=SleepMode
|
||||
|
||||
; add to median filter
|
||||
median=temp
|
||||
; add to moving average filter
|
||||
movav=hum
|
||||
|
||||
; show filtered results
|
||||
=>print %median% %movav%
|
||||
|
||||
if chg[rssi]>0
|
||||
then =>print rssi changed to %rssi%
|
||||
endif
|
||||
|
||||
if temp\>30
|
||||
and hum\>70
|
||||
then =\>print damn hot!
|
||||
endif
|
||||
|
||||
**\>S**
|
||||
|
||||
; every second but not completely reliable time here
|
||||
; use upsecs and uptime or best t: for reliable timers
|
||||
|
||||
; arrays
|
||||
array[1]=4
|
||||
array[2]=5
|
||||
tmp=array[1]+array[2]
|
||||
|
||||
; call subrountines with parameters
|
||||
=#sub1("hallo")
|
||||
=#sub2(999)
|
||||
|
||||
; stop timer after expired
|
||||
if timer1==0
|
||||
then timer1=-1
|
||||
=>print timer1 expired
|
||||
endif
|
||||
|
||||
; auto counter with restart
|
||||
if count>=10
|
||||
then =>print 10 seconds over
|
||||
count=0
|
||||
endif
|
||||
|
||||
if upsecs%5==0
|
||||
then =\>print %upsecs% (every 5 seconds)
|
||||
endif
|
||||
|
||||
; not recommended for reliable timers
|
||||
timer+=1
|
||||
if timer\>=5
|
||||
then =\>print 5 seconds over (may be)
|
||||
timer=0
|
||||
endif
|
||||
|
||||
dimmer+=1
|
||||
if dimmer\>100
|
||||
then dimmer=0
|
||||
endif
|
||||
|
||||
=\>dimmer %dimmer%
|
||||
=\>WebSend %url% dimmer %dimmer%
|
||||
|
||||
; show on display
|
||||
dp0
|
||||
=\>displaytext [c1l1f1s2p20] dimmer=%dimmer%
|
||||
|
||||
=\>print %upsecs% %uptime% %time% %sunrise% %sunset% %tstamp%
|
||||
|
||||
if time\>sunset
|
||||
and time< sunrise
|
||||
then
|
||||
; night time
|
||||
if pwr[1]==0
|
||||
then =\>power1 1
|
||||
endif
|
||||
else
|
||||
; day time
|
||||
if pwr[1]\>0
|
||||
then =\>power1 0
|
||||
endif
|
||||
endif
|
||||
|
||||
; clr display on boot
|
||||
if boot\>0
|
||||
then =\>displaytext [z]
|
||||
endif
|
||||
|
||||
; frost warning
|
||||
if temp<0
|
||||
and mt<=0
|
||||
then =#sendmail("frost alert")
|
||||
; alarm only every 5 minutes
|
||||
mt=300
|
||||
=>mp3track 2
|
||||
endif
|
||||
|
||||
; var has been updated
|
||||
if upd[hello]>0
|
||||
then =>print %hello%
|
||||
endif
|
||||
|
||||
; send to Thingspeak every 60 seconds
|
||||
; average data in between
|
||||
if upsecs%60==0
|
||||
then
|
||||
ahum/=tcnt
|
||||
atemp/=tcnt
|
||||
=>Websend [184.106.153.149:80]/update?key=PYUZMVWCICBW492&field1=%atemp%&field2=%ahum%
|
||||
tcnt=0
|
||||
atemp=0
|
||||
ahum=0
|
||||
else
|
||||
ahum+=hum
|
||||
atemp+=temp
|
||||
tcnt+=1
|
||||
endif
|
||||
|
||||
hour=int(time/60)
|
||||
if chg[hour]>0
|
||||
then
|
||||
; exactly every hour
|
||||
=>print full hour reached
|
||||
endif
|
||||
|
||||
if time>5 {
|
||||
=>print more then 5 minutes after midnight
|
||||
} else {
|
||||
=>print less then 5 minutes after midnight
|
||||
}
|
||||
|
||||
|
||||
; publish abs hum every teleperiod time
|
||||
if mqtts>0
|
||||
and upsecs%tper==0
|
||||
then
|
||||
; calc abs humidity
|
||||
tmp=pow(2.718281828 (17.67\*temp)/(temp+243.5))
|
||||
tmp=(6.112\*tmp\*hum\*18.01534)/((273.15+temp)\*8.31447215)
|
||||
; publish median filtered value
|
||||
=>Publish tele/%topic%/SENSOR {"Script":{"abshum":%med(0 tmp)%}}
|
||||
endif
|
||||
|
||||
;switch case state machine
|
||||
switch state
|
||||
case 1
|
||||
=>print state=%state% , start
|
||||
state+=1
|
||||
case 2
|
||||
=>print state=%state%
|
||||
state+=1
|
||||
case 3
|
||||
=>print state=%state% , reset
|
||||
state=1
|
||||
ends
|
||||
|
||||
|
||||
; subroutines
|
||||
\#sub1(string)
|
||||
=>print sub1: %string%
|
||||
\#sub2(param)
|
||||
=>print sub2: %param%
|
||||
|
||||
\#sendmail(string)
|
||||
=>sendmail [smtp.gmail.com:465:user:passwd:<sender@gmail.de>:<rec@gmail.de>:alarm] %string%
|
||||
|
||||
**\>E**
|
||||
=\>print event executed!
|
||||
|
||||
; get HSBColor 1. component
|
||||
tmp=st(HSBColor , 1)
|
||||
|
||||
; check if switch changed state
|
||||
sw=sw[1]
|
||||
if chg[sw]>0
|
||||
then =\>power1 %sw%
|
||||
endif
|
||||
|
||||
hello="event occured"
|
||||
|
||||
; check for Color change (Color is a string)
|
||||
col=Color
|
||||
; color change needs 2 string vars
|
||||
if col!=ocol
|
||||
then ocol=col
|
||||
=>print color changed %col%
|
||||
endif
|
||||
|
||||
; or check change of color channels
|
||||
chan1=Channel[1]
|
||||
chan2=Channel[2]
|
||||
chan3=Channel[3]
|
||||
|
||||
if chg[chan1]>0
|
||||
or chg[chan2]>0
|
||||
or chg[chan3]>0
|
||||
then => color has changed
|
||||
endif
|
||||
|
||||
; compose color string for red
|
||||
col=hn(255)+hn(0)+hn(0)
|
||||
=>color %col%
|
||||
|
||||
**\>R**
|
||||
=\>print restarting now
|
||||
|
||||
**a log sensor example**
|
||||
; define all vars here
|
||||
; reserve large strings
|
||||
**\>D** 48
|
||||
hum=0
|
||||
temp=0
|
||||
fr=0
|
||||
res=0
|
||||
; moving average for 60 seconds
|
||||
M:mhum=0 60
|
||||
M:mtemp=0 60
|
||||
str=""
|
||||
|
||||
**\>B**
|
||||
; set sensor file download link
|
||||
fl1("slog.txt")
|
||||
; delete file in case we want to start fresh
|
||||
;fd("slog.txt")
|
||||
|
||||
|
||||
; list all files in root directory
|
||||
fr=fo("/" 0)
|
||||
for cnt 1 20 1
|
||||
res=fr(str fr)
|
||||
if res>0
|
||||
then
|
||||
=>print %cnt% : %str%
|
||||
else
|
||||
break
|
||||
endif
|
||||
next
|
||||
fc(fr)
|
||||
|
||||
|
||||
**\>T**
|
||||
; get sensor values
|
||||
temp=BME280#Temperature
|
||||
hum=BME280#Humidity
|
||||
|
||||
**\>S**
|
||||
; average sensor values every second
|
||||
mhum=hum
|
||||
mtemp=temp
|
||||
|
||||
; write average to sensor log every minute
|
||||
if upsecs%60==0
|
||||
then
|
||||
; open file for write
|
||||
fr=fo("slog.txt" 1)
|
||||
; compose string for tab delimited file entry
|
||||
str=s(upsecs)+"\t"+s(mhum)+"\t"+s(mtemp)+"\n"
|
||||
; write string to log file
|
||||
res=fw(str fr)
|
||||
; close file
|
||||
fc(fr)
|
||||
endif
|
||||
|
||||
**\>R**
|
||||
|
||||
|
||||
|
||||
**a real example**
|
||||
epaper 29 with sgp30 and bme280
|
||||
some vars are set from iobroker
|
||||
DisplayText substituted to save script space
|
||||
**\>D**
|
||||
hum=0
|
||||
temp=0
|
||||
press=0
|
||||
ahum=0
|
||||
tvoc=0
|
||||
eco2=0
|
||||
zwz=0
|
||||
wr1=0
|
||||
wr2=0
|
||||
wr3=0
|
||||
otmp=0
|
||||
pwl=0
|
||||
tmp=0
|
||||
DT="DisplayText"
|
||||
; preset units in case they are not available
|
||||
punit="hPa"
|
||||
tunit="C"
|
||||
|
||||
**\>B**
|
||||
;reset auto draw
|
||||
=>%DT% [zD0]
|
||||
;clr display and draw a frame
|
||||
=>%DT% [x0y20h296x0y40h296]
|
||||
|
||||
**\>T**
|
||||
; get tele vars
|
||||
temp=BME280#Temperature
|
||||
hum=BME280#Humidity
|
||||
press=BME280#Pressure
|
||||
tvoc=SGP30#TVOC
|
||||
eco2=SGP30#eCO2
|
||||
ahum=SGP30#aHumidity
|
||||
tunit=TempUnit
|
||||
punit=PressureUnit
|
||||
|
||||
**\>S**
|
||||
// update display every teleperiod time
|
||||
if upsecs%tper==0
|
||||
then
|
||||
dp2
|
||||
=>%DT% [f1p7x0y5]%temp% %tunit%
|
||||
=>%DT% [p5x70y5]%hum% %%[x250y5t]
|
||||
=>%DT% [p11x140y5]%press% %punit%
|
||||
=>%DT% [p10x30y25]TVOC: %tvoc% ppb
|
||||
=>%DT% [p10x160y25]eCO2: %eco2% ppm
|
||||
=>%DT% [p10c26l5]ahum: %ahum% g^m3
|
||||
|
||||
dp0
|
||||
=>%DT% [p25c1l5]WR 1 (Dach) : %wr1% W
|
||||
=>%DT% [p25c1l6]WR 2 (Garage): %-wr3% W
|
||||
=>%DT% [p25c1l7]WR 3 (Garten): %-wr2% W
|
||||
=>%DT% [p25c1l8]Aussentemperatur: %otmp% C
|
||||
=>%DT% [x170y95r120:30f2p6x185y100] %pwl% %%
|
||||
; now update screen
|
||||
=>%DT% [d]
|
||||
endif
|
||||
|
||||
|
||||
**\>E**
|
||||
|
||||
**\>R**
|
||||
|
||||
**another real example**
|
||||
ILI 9488 color LCD Display shows various energy graphs
|
||||
display switches on and off with proximity sensor
|
||||
BMP280 and vl5310x
|
||||
some vars are set from iobroker
|
||||
|
||||
**>D**
|
||||
temp=0
|
||||
press=0
|
||||
zwz=0
|
||||
wr1=0
|
||||
wr2=0
|
||||
wr3=0
|
||||
otmp=0
|
||||
pwl=0
|
||||
tmp=0
|
||||
dist=0
|
||||
DT="DisplayText"
|
||||
punit="hPa"
|
||||
tunit="C"
|
||||
hour=0
|
||||
|
||||
**>B**
|
||||
=>%DT% [z]
|
||||
|
||||
// define 2 graphs, 2. has 3 tracks
|
||||
=>%DT% [zCi1G2656:5:20:400:80:1440:-5000:5000:3Ci7f3x410y20]+5000 W[x410y95]-5000 W [Ci7f1x70y3] Zweirichtungsz~80hler - 24 Stunden
|
||||
=>%DT% [Ci1G2657:5:120:400:80:1440:0:5000:3Ci7f3x410y120]+5000 W[x410y195]0 W [Ci7f1x70y103] Wechselrichter 1-3 - 24 Stunden
|
||||
=>%DT% [Ci1G2658:5:120:400:80:1440:0:5000:16][Ci1G2659:5:120:400:80:1440:0:5000:5]
|
||||
=>%DT% [f1s1b0:260:260:100:50:2:11:4:2:Rel 1:b1:370:260:100:50:2:11:4:2:Dsp off:]
|
||||
=>mp3volume 100
|
||||
=>mp3track 4
|
||||
|
||||
**>T**
|
||||
; get some tele vars
|
||||
temp=BMP280#Temperature
|
||||
press=BMP280#Pressure
|
||||
tunit=TempUnit
|
||||
punit=PressureUnit
|
||||
dist=VL53L0X#Distance
|
||||
|
||||
; check proximity sensor to switch display on/off
|
||||
; to prevent burn in
|
||||
if dist>300
|
||||
then
|
||||
if pwr[2]>0
|
||||
then
|
||||
=>power2 0
|
||||
endif
|
||||
else
|
||||
if pwr[2]==0
|
||||
then
|
||||
=>power2 1
|
||||
endif
|
||||
endif
|
||||
|
||||
|
||||
**>S**
|
||||
; update graph every teleperiod
|
||||
if upsecs%tper==0
|
||||
then
|
||||
dp2
|
||||
=>%DT% [f1Ci3x40y260w30Ci1]
|
||||
=>%DT% [Ci7x120y220t]
|
||||
=>%DT% [Ci7x180y220T]
|
||||
=>%DT% [Ci7p8x120y240]%temp% %tunit%
|
||||
=>%DT% [Ci7x120y260]%press% %punit%
|
||||
=>%DT% [Ci7x120y280]%dist% mm
|
||||
dp0
|
||||
=>%DT% [g0:%zwz%g1:%wr1%g2:%-wr2%g3:%-wr3%]
|
||||
if zwz>0
|
||||
then
|
||||
=>%DT% [p-8x410y55Ci2Bi0]%zwz% W
|
||||
else
|
||||
=>%DT% [p-8x410y55Ci3Bi0]%zwz% W
|
||||
endif
|
||||
=>%DT% [p-8x410y140Ci3Bi0]%wr1% W
|
||||
=>%DT% [p-8x410y155Ci16Bi0]%-wr2% W
|
||||
=>%DT% [p-8x410y170Ci5Bi0]%-wr3% W
|
||||
endif
|
||||
|
||||
; chime every full hour
|
||||
hour=int(time/60)
|
||||
if chg[hour]>0
|
||||
then =>mp3track 4
|
||||
endif
|
||||
|
||||
**>E**
|
||||
|
||||
**>R**
|
||||
Loading…
Reference in New Issue