Skip to content

Commit e61d6b4

Browse files
committed
layout edits. fix <x> not displaying in commands
1 parent 477792a commit e61d6b4

File tree

11 files changed

+259
-217
lines changed

11 files changed

+259
-217
lines changed

Blinds-and-Shutters.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,52 @@ To use it you must [compile your build](compile-your-build). Add the following t
66
#endif
77
```
88
----
9-
This driver adds support to wirelessly control blinds and roller shades connected to regular ON/OFF motors or stepper motors.
9+
?> Control blinds and roller shades connected to regular ON/OFF motors or stepper motors.
1010

1111
The device must have at least two relays (e.g., a [Sonoff Dual R2](#sonoff-dual-r2-required-configuration)). Otherwise the shutter feature will not work.
1212

13+
## Commands
14+
First enable shutter support with `SetOption80 1`
15+
16+
Complete list of commands is available at [Blinds, Shutters and Roller Shades Commands](Commands#blinds-shutters-and-roller-shades).
17+
1318
## Shutter Modes
14-
There are three shutter modes which are defined according to the PulseTime and Interlock settings. The examples below are for a `ShutterRelay1 1` configuration (i.e., `Relay1` and `Relay2`).
15-
1. Normal Operation (ShutterMode: 0) - First relay: OFF/DOWN, Second relay: OFF/UP
19+
There are three shutter modes which are defined according to the [PulseTime](Commands#pulsetime) and [Interlock](Commands#interlock) settings. The examples below are for a `ShutterRelay1 1` configuration (using Relay1 and Relay2).
20+
1. **ShutterMode 0** - Normal Operation
21+
First relay: OFF/DOWN, Second relay: OFF/UP
1622
- `Backlog PulseTime1 0; PulseTime2 0`
1723
- `Backlog Interlock 1,2; Interlock ON` (Interlocked relay pair)
18-
2. Short Circuit Safe (ShutterMode: 1) - First relay: ON/OFF, Second relay: UP/DOWN
24+
25+
1. **ShutterMode 1** - Circuit Safe
26+
First relay: ON/OFF, Second relay: UP/DOWN
1927
- `Backlog PulseTime1 0; PulseTime2 0`
2028
- `Interlock OFF`
21-
3. Stepper motors (ShutterMode: 2) - First relay: OFF/DOWN PULSE, Second relay: OFF/UP PULSE
29+
30+
1. **ShutterMode 2** - Stepper Motors
31+
First relay: OFF/DOWN PULSE, Second relay: OFF/UP PULSE
2232
- `Backlog PulseTime1 2; PulseTime2 2`
2333
- `Backlog Interlock 1,2; Interlock ON` (Interlocked relay pair)
2434

25-
[Diagrams](#wiring-diagrams) for Normal, Stepper motor, and Short Circuit-Safe configurations are available at the end of this page. Even if the shutter does not have two motors, three wires have to be connected.
35+
[Wiring diagrams](#wiring-diagrams) for Normal, Stepper motor, and Short Circuit-Safe configurations are available at the end of this page. Even if the shutter does not have two motors, three wires have to be connected.
2636

27-
**After setting the options for shutter mode, the device must be rebooted.** Otherwise, the sliders won't be available in the web UI, and the `ShutterOpenDuration<x>`and `ShutterCloseDuration<x>` commands will report "Shutter unknown". Send `ShutterRelay<x> 1` and check what `ShutterMode` is displayed:
28-
```
37+
> [!NOTE] **After setting the options for shutter mode, the device must be rebooted.** Otherwise, the sliders won't be available in the web UI, and the `ShutterOpenDuration<x>`and `ShutterCloseDuration<x>` commands will report "Shutter unknown".
38+
39+
Issue `ShutterRelay<x> 1` command and check in console which **ShutterMode** is displayed:
40+
41+
<pre style="white-space:pre-line">
2942
Shutter accuracy digits: 1
30-
Shutter 0 (Relay:1): Init. Pos: 20000 [100 %], Open Vel.: 100 Close Vel.: 100 , Max Way: 20000, Opentime 10.0 [s], Closetime 10.0 [s], CoedffCalc: c0: 0, c1 200, c2: 200, c3: 0, c4: 0, binmask 3, is inverted 1, ShutterMode 0, motordelay 0
31-
```
43+
Shutter 0 (Relay:1): Init. Pos: 20000 [100 %], Open Vel.: 100 Close Vel.: 100 , Max Way: 20000, Opentime 10.0 [s], Closetime 10.0 [s], CoedffCalc: c0: 0, c1 200, c2: 200, c3: 0, c4: 0, binmask 3, is inverted 1, <span style="font-weight:bold;color:lime">ShutterMode 0</span>, motordelay 0
44+
</pre>
3245

3346
## Operation
34-
Refer to the [Blinds, Shutters and Roller Shades Commands](Commands#blinds-shutters-and-roller-shades)
35-
3647
Turning a device relay on or off directly (i.e., using `Power`) will function to affect a shutter's movement. In momentary mode (i.e., stepper motor), the relays start or stop the motor. The driver takes care of the direction and proper update of the shutter position.
3748

3849
By default, only `Shutter1` is enabled when `SetOption80 1` is invoked.
39-
<img src="https://user-images.githubusercontent.com/34340210/65997878-3517e180-e468-11e9-950e-bfe299771233.png">
50+
![](https://user-images.githubusercontent.com/34340210/65997878-3517e180-e468-11e9-950e-bfe299771233.png ":size=200")
4051

4152

4253
A maximum of four shutters per device are supported.
43-
<img src="https://user-images.githubusercontent.com/34340210/65997879-3517e180-e468-11e9-9c44-9ad4a4a970cc.png">
54+
![](https://user-images.githubusercontent.com/34340210/65997879-3517e180-e468-11e9-9c44-9ad4a4a970cc.png ":size=200")
4455

4556
To enable additional shutters, `ShutterRelay<x> <value>` must be executed for each additional shutter. Additional shutter declarations must be sequentially numbered, and without gaps (i.e., first shutter 2, then shutter 3, and finally shutter 4).
4657

0 commit comments

Comments
 (0)