From 60c63d698d37d8b41d3e86844a3d1493cd7d1a49 Mon Sep 17 00:00:00 2001
From: Marko Oldenburg
Date: Thu, 6 Jun 2019 08:03:29 +0200
Subject: [PATCH] add text to english commandref
---
73_AutoShuttersControl.pm | 360 +++++++++++++++++++++-----------------
README.md | 6 +-
2 files changed, 203 insertions(+), 163 deletions(-)
diff --git a/73_AutoShuttersControl.pm b/73_AutoShuttersControl.pm
index 263ebd8..108393a 100644
--- a/73_AutoShuttersControl.pm
+++ b/73_AutoShuttersControl.pm
@@ -5179,29 +5179,35 @@ sub getblockAscDrivesAfterManual {
Define
+
+ This creates an new AutoShuttersControl device, called myASControl.
+ Now was the new global attribute ASC added to the FHEM installation.
+ Each shutter that is to be controlled by AutoShuttersControl must now have the attribute ASC set to 1 or 2.
+ The value 1 is to be used with devices whose state is given as position (i.e. ROLLO or Siro, shutters
+ openend is 0, shutters closed is 100), 2 with devices whose state is given as percent closed (i.e. HomeMatic,
+ shutters opened is 100, closed is 0).
+
+
+ After setting the attributes to all devices who should be controlled, the automatic scan at the main device
+ can be started for example with
+ set myASControl scanForShutters
+
Readings
- Within the ASC device:
+ Within the ASC device:
- ..._nextAstroTimeEvent - Next astro event: sunrise, sunset or fixed time
- ..._PosValue - current position
@@ -5209,25 +5215,25 @@ sub getblockAscDrivesAfterManual {
- ..._lastDelayPosValue - last specified order, will be executed with the next matching
event
- - partyMode - on/off - is working mode set to part?y
- - ascEnable - on/off - are the associated shutters control by ASC completely?
- - controlShading - on/off - are the associated shutters controlled for shading by ASC?
+
- partyMode on|off - is working mode set to part?y
+ - ascEnable on|off - are the associated shutters control by ASC completely?
+ - controlShading on|off - are the associated shutters controlled for shading by ASC?
- - hardLockOut - on/off - switch for preventing a global hard lock out
+ - hardLockOut on|off - switch for preventing a global hard lock out
- room_... - list of every found shutter for every room: room_Sleeping: Patio
- selfDefense - state of the self defense mode
- state - state of the ASC device: active, enabled, disabled or other state information
- - sunriseTimeWeHoliday - on/off - state of the weekend and holiday support
+ - sunriseTimeWeHoliday on|off - state of the weekend and holiday support
- userAttrList - ASC sets some user defined attributes (userattr)
for the shutter devices. This readings shows the current state of the given user attributes to the
shutter devices.
-
- Within the shutter devices:
+
+ Within the shutter devices:
- - ASC_Enable - on/off - shutter is controlled by ASC or not
+ - ASC_Enable on|off - shutter is controlled by ASC or not
- ASC_Time_DriveUp - if the astro mode is used, the next sunrise is shown.
If the brightness or time mode is used, the value from ASC_Time_Up_Late is shown.
@@ -5242,17 +5248,17 @@ sub getblockAscDrivesAfterManual {
Set
- - ascEnable - on/off - enable or disable the global control by ASC
- - controlShading - on/off - enable or disable the global shading control by ASC
+ - ascEnable on|off - enable or disable the global control by ASC
+ - controlShading on|off - enable or disable the global shading control by ASC
- createNewNotifyDev - re-creates the internal structure for NOTIFYDEV. Is only present if
the
ASC_Expert attribute is set to 1.
- - hardLockOut - on/off - controls the global hard lock out protection for shutters, whose
+
- hardLockOut on|off - controls the global hard lock out protection for shutters, whose
ASC_LockOut
attribute is set accordingly. See the attributes section below.
- - partyMode - on/off - controls the global party mode for shutters. Every shutters whose
+
- partyMode on|off - controls the global party mode for shutters. Every shutters whose
ASC_Partymode attribute is set to on, is not longer controlled by ASC. The last saved
working command send to the device, i.e. by a event, created by a window or presence event, will be executed
once the party mode is disabled.
@@ -5263,14 +5269,14 @@ sub getblockAscDrivesAfterManual {
- scanForShutters - scans the whole FHEM installation for (new) devices whose ASC
attribute is set (to 1 or 2, see above).
- - selfDefense - on/off - controls the self defense function. This function listens for
+
- selfDefense on|off - controls the self defense function. This function listens for
example on a residents device. If this device is set to absent and a window is still open, ASC will close
the shutter for a rudimentary burglary protection.
- - shutterASCenableToggle - on/off - controls if the ASC controls are shown at a associated
+
- shutterASCenableToggle on|off - controls if the ASC controls are shown at a associated
shutter device.
- - sunriseTimeWeHoliday - on/off - controls the weekend and holiday support. If enabled, the
+
- sunriseTimeWeHoliday on|off - controls the weekend and holiday support. If enabled, the
ASC_Time_Up_WE_Holiday attribute is considered.
- wiggle - wiggles a device for a given value (default 5%, controlled by
@@ -5293,7 +5299,8 @@ sub getblockAscDrivesAfterManual {
Attributes
- - ASC_rainSensor - DEVICENAME[:READINGNAME] MAXTRIGGER[:HYSTERESE] [CLOSEDPOS] - Contains
+
- ASC_rainSensor DEVICENAME[:READINGNAME] MAXTRIGGER[:HYSTERESE] [CLOSEDPOS] - Contains
settings for the rain protection. DEVICNAME specifies a rain sensor, the optional
READINGNAME the name of the reading at the DEVICENAME. The READINGNAME
should contain the values rain and dry or a numeral rain amount. MAXTRIGGER
@@ -5354,7 +5361,7 @@ sub getblockAscDrivesAfterManual {
the threshold is reached. HYSTERESE sets a hysteresis for MAXTRIGGER.
- - ASC_residentsDev - DEVICENAME[:READINGNAME] - DEVICENAME points to a device
+
- ASC_residentsDev DEVICENAME[:READINGNAME] - DEVICENAME points to a device
for presence, e.g. of type RESIDENTS. READINGNAME points to a reading at
DEVICENAME which contains a presence state, e.g. rgr_Residents:presence. The target
should contain values alike the RESIDENTS family.
@@ -5364,7 +5371,7 @@ sub getblockAscDrivesAfterManual {
the operating time. 0 equals to no delay.
- - ASC_tempSensor - DEVICENAME[:READINGNAME] - DEVICENAME points to a device
+
- ASC_tempSensor DEVICENAME[:READINGNAME] - DEVICENAME points to a device
with a temperature, READINGNAME to a reading located at the DEVICENAME, for example
OUTDOOR_TEMP:measured-temp. READINGNAME defaults to temperature.
@@ -5373,7 +5380,7 @@ sub getblockAscDrivesAfterManual {
the sun position. Supports currently devices of type Twilight or Astro.
- - ASC_windSensor - DEVICENAME[:READINGNAME] - DEVICENAME points to a device
+
- ASC_windSensor DEVICENAME[:READINGNAME] - DEVICENAME points to a device
containing a wind speed. Reads from the wind reading, if not otherwise specified by
READINGNAME.
@@ -5401,8 +5408,8 @@ sub getblockAscDrivesAfterManual {
ASC_brightnessMaxVal - Warning! Deprecated! Don't use anymore!
-
- At shutter devices, controlled by ASC
+
+ At shutter devices, controlled by ASC:
- ASC - 0/1/2
@@ -5450,13 +5457,13 @@ sub getblockAscDrivesAfterManual {
EVENING-VALUE. Gets the brightness from DEVICE, reads by default from the
brightness reading, unless READING is specified. Defaults to none.
- - ASC_Closed_Pos - A value from 0 to 100 in increments of 10. Depends on the ASC
- attribute.
+
- ASC_Closed_Pos - The closed position value from 0 to 100 percent in increments of 10.
+ Depends on the ASC attribute.
- - ASC_ComfortOpen_Pos - A value from 0 to 100 in increments of 10. Default: depends on the
- ASC attribute.
+
- ASC_ComfortOpen_Pos - The comfort opening position, ranging
+ from 0 to 100 percent in increments of 10. Default: depends on the ASC attribute.
- - ASC_Down - [astro|time|brightness] - Drive the shutter depending on this setting:
+
- ASC_Down - astro|time|brightness - Drive the shutter depending on this setting:
AutoShuttersControl API description
- It's possible to access internal data of the ASC module by calling the API function.
+ It's possible to access internal data of the ASC module by calling the API function.
Data points of a shutter device, controlled by ASC
@@ -5723,11 +5767,7 @@ sub getblockAscDrivesAfterManual {
ASCenable |
Does ASC control the shutter? |
-
- IsDay |
- Contains the current mode of the shutter: day (after sunrise till sunset) or night (sunset till sunrise) |
-
-
+
Data points of the ASC device
@@ -5762,7 +5802,7 @@ sub getblockAscDrivesAfterManual {
ASCenable |
Is ASC globally activated? |
-
+
=end html
diff --git a/README.md b/README.md
index c97d081..4a97e7a 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,15 @@
## Used branching model
* Master branch: Production version (copy of [fhem/fhem-mirror/blob/master/fhem/FHEM/73_AutoShuttersControl.pm](https://github.com/fhem/fhem-mirror/blob/master/fhem/FHEM/73_AutoShuttersControl.pm))
-* Dev branch: Latest development version
+* Devel branch: Latest development version
## Community support
The FHEM Forum is available [here](https://forum.fhem.de/) for general support.
In case you have a specific question about this module, it is recommended to find the right sub-forum.
-It can either be found from the module info card using the FHEM Installer (e.g. using command `search `) or it can be determine from the [MAINTAINER.txt](https://github.com/fhem/fhem-mirror/blob/master/fhem/MAINTAINER.txt) file.
+It can either be found from the module info card using the FHEM Installer (e.g. using command `search `) or it can be determined from the [MAINTAINER.txt](https://github.com/fhem/fhem-mirror/blob/master/fhem/MAINTAINER.txt) file.
## Bug reports and feature requests
Identified bugs and feature requests are tracked using [Github Issues](https://github.com/fhem/AutoShuttersControl/issues).
## Pull requests / How to participate into development
-You are invited to send pull requests to the devel branch whenever you think you can contribute with some useful improvements to the module. The module maintainer will review you code and decide wether it is going to be part of the module in a future release.
+You are invited to send pull requests to the devel branch whenever you think you can contribute with some useful improvements to the module. The module maintainer will review you code and decide whether it is going to be part of the module in a future release.