mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Buzzer

Michael Ingraham 2019-08-12 12:43:48 -04:00
parent 6a49d1223a
commit 8712619a41
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Commands.md

@ -104,8 +104,9 @@ Simply put, other messages may precede messages published as a result of your co
Backlog | <a id="Backlog"></a>List of commands to be executed in sequence separated by `;`<BR> See [Using Backlog](#using-backlog) for examples.<a id="BlinkCount"></a> Backlog | <a id="Backlog"></a>List of commands to be executed in sequence separated by `;`<BR> See [Using Backlog](#using-backlog) for examples.<a id="BlinkCount"></a>
BlinkCount | Number of relay toggles ([blinks](#power)) **(does not control the status LED)**<BR> `0` = blink many times before restoring power state <BR> `1..32000` = set number of blinks<a id="BlinkTime"></a> BlinkCount | Number of relay toggles ([blinks](#power)) **(does not control the status LED)**<BR> `0` = blink many times before restoring power state <BR> `1..32000` = set number of blinks<a id="BlinkTime"></a>
BlinkTime | `2..3600` set duration, in 0.1 second increments, to [blink](#power) (i.e., toggle Power) for a relay **(does not control the status LED)**<a id="ButtonDebounce"></a> BlinkTime | `2..3600` set duration, in 0.1 second increments, to [blink](#power) (i.e., toggle Power) for a relay **(does not control the status LED)**<a id="ButtonDebounce"></a>
ButtonDebounce | User control over button debounce timing <BR>`40..1000` = set button debounce time in ms. Default is `40`<a id="FanSpeed"></a> ButtonDebounce | User control over button debounce timing <BR>`40..1000` = set button debounce time in ms. Default is `40`<a id="Buzzer"></a>
FanSpeed | Fan speed control *([iFan02](Sonoff-iFan02) module only)* <BR>`0` = turn fan OFF <BR> `1..3` = set fan speed <BR> `+` = increase fan speed <BR>`-` = decrease fan speed <BR><a id="Interlock"></a> Buzzer | `<beeps>,<beep>,<silence>` All parameters are optional. Default value for each is `1` (one 100ms beep)<BR><BR>`2` - Beep twice with duration 100ms and pause 100ms<BR>`2,3` - Beep twice with duration 300ms and pause 100ms<BR>`2,3,4` - Beep twice with duration 300ms and pause 400ms<a id="FanSpeed"></a>
FanSpeed | Fan speed control *(iFan02/iFan03 only)*<BR>`0` = turn fan OFF<BR>`1..3` = set fan speed<BR>`+` = increase fan speed <BR>`-` = decrease fan speed <BR><a id="Interlock"></a>
Interlock | Relay interlock mode and group selection.<BR>`0` = set self-locking mode for all relays *(default)*<BR> `1` = set interlock mode for selected relays Interlock | Relay interlock mode and group selection.<BR>`0` = set self-locking mode for all relays *(default)*<BR> `1` = set interlock mode for selected relays
| | Add up to 8 relays in 1 to 4 interlock groups, each separated by a space. For example<BR> `1,2 3,4` = Group Relay1 and Relay2 in group 1 and Relay3 and Relay4 in group 2 (_note the space between the two group declarations_) <BR> `1,2,3` = group Relay1, Relay2 and Relay3 in a single interlock group <BR>`1 3 2,4` = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3<a id="LedMask"></a> | | Add up to 8 relays in 1 to 4 interlock groups, each separated by a space. For example<BR> `1,2 3,4` = Group Relay1 and Relay2 in group 1 and Relay3 and Relay4 in group 2 (_note the space between the two group declarations_) <BR> `1,2,3` = group Relay1, Relay2 and Relay3 in a single interlock group <BR>`1 3 2,4` = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3<a id="LedMask"></a>
LedMask | Allows setting a [`<bitmask>`](https://en.wikipedia.org/wiki/Mask_(computing)#Masking_bits_to_1) which specifies which relays control the LED indicator used to display whether a relay is latched/powered. The order of the `<bitmask>` is from most significant bit (MSB) to least significant bit (LSB). Bit 15 (MSB) masks Relay16 through bit 0 (LSB) which masks Relay1, respectively. For each relay to be included in controlling the power LED, set its corresponding bit in the `<bitmask>` to `1`. `<bitmask>` bits without corresponding configured module relays have no effect and can be ignored.<BR><BR>`<bitmask>` = [bitwise](https://whatis.techtarget.com/definition/bitwise) value representing each relay. Values may be entered as either hexadecimal or decimal values (e.g., 0xFFFF = 65535). `0xFFFF` (= 1111 1111 1111 1111) All relays control the power LED _(default)_<BR><BR>[LedState](#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.<BR><BR>**Examples:**<li>`LedMask 0xFFFD` Every relay, except Relay2, controls the power LED (0xFFFD = 1111 1111 1111 1101)</li><li>`LedMask 0x0002` Only Relay 2 controls the power LED (0x0002 = 0000 0000 0000 0010)</li><a id="LedPower"></a> LedMask | Allows setting a [`<bitmask>`](https://en.wikipedia.org/wiki/Mask_(computing)#Masking_bits_to_1) which specifies which relays control the LED indicator used to display whether a relay is latched/powered. The order of the `<bitmask>` is from most significant bit (MSB) to least significant bit (LSB). Bit 15 (MSB) masks Relay16 through bit 0 (LSB) which masks Relay1, respectively. For each relay to be included in controlling the power LED, set its corresponding bit in the `<bitmask>` to `1`. `<bitmask>` bits without corresponding configured module relays have no effect and can be ignored.<BR><BR>`<bitmask>` = [bitwise](https://whatis.techtarget.com/definition/bitwise) value representing each relay. Values may be entered as either hexadecimal or decimal values (e.g., 0xFFFF = 65535). `0xFFFF` (= 1111 1111 1111 1111) All relays control the power LED _(default)_<BR><BR>[LedState](#ledstate) must be enabled (i.e., `!= 0`) in order for `LedMask` to take effect.<BR><BR>**Examples:**<li>`LedMask 0xFFFD` Every relay, except Relay2, controls the power LED (0xFFFD = 1111 1111 1111 1101)</li><li>`LedMask 0x0002` Only Relay 2 controls the power LED (0x0002 = 0000 0000 0000 0010)</li><a id="LedPower"></a>
@ -117,7 +118,7 @@ PowerOnState | Control relay state after _**powering up**_ the device. [More inf
PulseTime\<x\> | Display the amount of `PulseTime` remaining on the corresponding Relay (enumerated)<BR>`<value>` Set the duration to keep the corresponding Relay `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<BR>`0` / `OFF` = disable use of PulseTime for the corresponding Relay<BR>`1..111` = set PulseTime for the corresponding Relay in 0.1 second increments<BR>`112..64900` = set PulseTime for the corresponding Relay, offset by 100, in 1 second increments. Add 100 to desired interval in seconds, e.g., `PulseTime 113` = 13 seconds and `PulseTime 460` = 6 minutes (i.e., 360 seconds)<BR><a id="SwitchDebounce"></a> PulseTime\<x\> | Display the amount of `PulseTime` remaining on the corresponding Relay (enumerated)<BR>`<value>` Set the duration to keep the corresponding Relay `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<BR>`0` / `OFF` = disable use of PulseTime for the corresponding Relay<BR>`1..111` = set PulseTime for the corresponding Relay in 0.1 second increments<BR>`112..64900` = set PulseTime for the corresponding Relay, offset by 100, in 1 second increments. Add 100 to desired interval in seconds, e.g., `PulseTime 113` = 13 seconds and `PulseTime 460` = 6 minutes (i.e., 360 seconds)<BR><a id="SwitchDebounce"></a>
SwitchDebounce | User control over switch debounce timing <BR> `40..1000` = set switch debounce time in ms. Default is `40`<a id="SwitchMode"></a> SwitchDebounce | User control over switch debounce timing <BR> `40..1000` = set switch debounce time in ms. Default is `40`<a id="SwitchMode"></a>
SwitchMode\<x\> | [Switch mode](Buttons-and-Switches#switchmode) <BR> `0` = toggle *(default)* <BR> `1` = follow (0 = off, 1 = on) <BR> `2` = inverted follow (0 = on, 1 = off) <BR> `3` = pushbutton (default 1, 0 = toggle) <BR> `4` = inverted pushbutton (default 0, 1 = toggle) <BR> `5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold) <BR> `6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold) <BR> `7` = pushbutton toggle (0 = toggle, 1 = toggle) SwitchMode\<x\> | [Switch mode](Buttons-and-Switches#switchmode) <BR> `0` = toggle *(default)* <BR> `1` = follow (0 = off, 1 = on) <BR> `2` = inverted follow (0 = on, 1 = off) <BR> `3` = pushbutton (default 1, 0 = toggle) <BR> `4` = inverted pushbutton (default 0, 1 = toggle) <BR> `5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold) <BR> `6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold) <BR> `7` = pushbutton toggle (0 = toggle, 1 = toggle)
See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality<BR>[`SetOption13`](#SetOption13) - Allow immediate action on single button press<BR>[`SetOption26`](#SetOption26) - Use indexes even when only one relay is present<BR>[`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking<BR>[`SetOption32`](#SetOption32) - Set hold interval before sending `HOLD` action See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality<BR>[`SetOption13`](#SetOption13) - Allow immediate action on single button press<BR>[`SetOption26`](#SetOption26) - Use indexes even when only one relay is present<BR>[`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking<BR>[`SetOption32`](#SetOption32) - Set hold interval before sending `HOLD` action<BR>[`SetOption67`](#SetOption67) - Enable/Disable Buzzer
### Management ### Management