Skip to content

Commit

Permalink
Updating shutter commands
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanbode authored Dec 14, 2022
1 parent 358723e commit c85390f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,7 @@ DisplayClock<br>*(TM1637, TM1638 and MAX7219)* <a class="cmnd" id="displayclock"

Command<BR> (x = `0..4`) (0=set value to all defined shutters)|Parameters
:---|:---
ShutterMode<a class="cmnd" id="shuttermode"></a>|`1..5` *(default = `1`)*<BR>Defines the mode the shutter will operates the relays, steppers and/or servos. 6=autodetect based on INTERLOCK and GPIO defined. STATUS 13 show the mode. 1=normal two relay up/off down/off. 2=two relay on/off up/down. 3=one relay garage mode. 4=one relay plus stepper motor. 5=one relay and position servo.
ShutterMode<a class="cmnd" id="shuttermode"></a>|`1..7` *(default = `1`)*<BR>Defines the mode the shutter will operates the relays, steppers and/or servos. 6=autodetect based on INTERLOCK and GPIO defined. STATUS 13 show the mode.<BR>`1` = normal two relay up/off down/off<BR>`2` = two relay on/off up/down. Must be set manually<BR>`3` = one relay garage mode<BR>`4` = one relay plus stepper motor<BR>`5` = one relay and position servo<BR>`6` = one relay and PWM servo speed controlled by PWM. Position time based<BR>`7` = autodetect (once) based on existance of GPIO definition.
ShutterButton&#60;x><a class="cmnd" id="shutterbutton"></a>|`<button> <func> <mqtt>`<BR><BR>Assign a button to control the shutter. For more details please refer to [Blinds and Shutters](Blinds-and-Shutters) support<BR><BR>`<button>`<BR>&emsp;`0`: disable buttons for this shutter<BR>&emsp;`1..4`: Button number<BR>`<func>` `up`/`down`/`updown`/`toggle`: function to assign to the button<BR>`<mqtt>` `1`/`0`: enable/disable MQTT publish for button hold action<BR><BR>For example:<li>To control shutter #1 by two buttons: `Backlog ShutterButton1 1 up 1; ShutterButton1 2 down 1` assigns button #1 to act as an "up" button (1x press open, 2x press 50% position, 3x press 74% position) and button #2 to act as a "down" button (1x press close, 2x press 50% position, 3x press 24% position) for shutter #1 including MQTT publish.</li><li>To control shutter #1 by a single button: `ShutterButton1 1 updown 0` assigns button #1 to act as an "up and down" button (1x press up, 2x press down).</li><li>To control shutter #1 by a single button: `ShutterButton1 1 toggle 0` assigns button #1 to act as a "toggle" button (1x press toggle, 2x press 50% position).</li>
ShutterCalibration&#60;x><a class="cmnd" id="shuttercalibration"></a>|Granular shutter position calibration. The measured opening position of the shutter at the 30, 50, 70, 90, and 100 percent opened locations. For example: `ShutterCalibration<x> 23 38 56 74 82`
ShutterChange&#60;x><a class="cmnd" id="shutterchange"></a>|`-100..100` Moves the shutter from the current position relatively in %. If the resulting position is below 0 or above 100 it will be capped. Command can also be executed during movement and will change the target position.
Expand All @@ -715,7 +715,7 @@ ShutterMotorDelay&#60;x><a class="cmnd" id="shuttermotordelay"></a>|`-12.75 .. 1
ShutterMotorStop<a class="cmnd" id="shuttermotorstop"></a>|`0 .. 64000` *(default = `500`)*<BR>time in milliseconds, one relay must be off before the other one can start. This control the OFF time on TOGGLE and POSITION change commands that require a TOGGLE. Also in GarageMode this sets the wait time between two commands. Equal for all shutters.
ShutterOpenDuration&#60;x><a class="cmnd" id="shutteropenduration"></a>|`1.0 ..240.0` *(default = `10.0`)*<BR>time, in seconds, it takes to fully open the shutter. A fraction of a second can be specified (e.g. `45.7`).
ShutterOpen&#60;x><a class="cmnd" id="shutteropen"></a>|Engage the relay to open the shutter. This action can be requested at any time. Number of shutter can be index or the argument
ShutterPosition&#60;x><a class="cmnd" id="shutterposition"></a>|`0..100`, `UP`, `OPEN`, `DOWN`, `CLOSE`, `STOP`, `TOGGLE`, `TOGGLEDIR`,,<BR>A shutter position change can be requested at any time. The shutter will stop and revert or update to the requested position. The shutter's actual position will be saved _**after**_ the movement is completed. In this case, the position will be restored during reboot. An interruption during shutter movement (e.g., a device restart) will lose the current position.
ShutterPosition&#60;x><a class="cmnd" id="shutterposition"></a>|`0..100`, `UP`, `OPEN`, `DOWN`, `CLOSE`, `STOP`, `TOGGLE`, `TOGGLEDIR`, `STOPOPEN`, `STOPCLOSE`,<BR>A shutter position change can be requested at any time. The shutter will stop and revert or update to the requested position. The shutter's actual position will be saved _**after**_ the movement is completed. In this case, the position will be restored during reboot. An interruption during shutter movement (e.g., a device restart) will lose the current position.
ShutterPWMRange&#60;x><a class="cmnd" id="shutterpwmrange"></a>|`0..1023,0..1023`<BR>For servo motors the min and max position is defined by the length of the duty cycle signal. Because every servo is different the min and max PWM value must be set for each servo type. The value is also dependant on the `PWMfrequency`. Servos normally use `50..200` as `PWMfrequency`.
ShutterRelay&#60;x><a class="cmnd" id="shutterrelay"></a>|`<value>`<BR>`0` = disable this and all higher numbered shutters<BR>`Relay<value>` component used to open the shutter. This relay's mate, the next higher numbered relay, closes the shutter. Depending on the shutter mode, the relays may need to be interlocked using the [`Interlock`](Commands.md#interlock) command.<BR>**The `ShutterRelay` command must be executed first before any other shutter commands for `Shutter<x>` can be executed.**
ShutterSetClose&#60;x><a class="cmnd" id="shuttersetclose"></a>|shutter closed position. `ShutterPosition` will be reset to fully closed value (e.g., `0` when `ShutterInvert = 0`, `100` otherwise). This does not work with Servos. min and max of servos are always defined through `ShutterPWMRange`.
Expand Down

0 comments on commit c85390f

Please sign in to comment.