Skip to content

Shuttercontrol Wiki English

github-actions[bot] edited this page Aug 25, 2024 · 9 revisions

Logo

Documentation and instructions for Shuttercontrol

Number of Installations Number of Installations NPM version Downloads Known Vulnerabilities

Test and Release License Donate


Support adapter development

If you like the adapter, please consider making a donation:

paypal


Basics

❕ The manual is valid from version stable 1.6.2 ❕

Shuttercontrol is an adapter for a very comprehensive control of roller shutters, blinds or awnings and includes both the automatic shading and the nightly the night-time darkening.

πŸ‘‰ For the sake of simplicity, only roller shutters are mentioned here.

A large number of adjustable parameters are available for the control, for example:

  • three different global timers for e.g. living room, bedroom and children's area,
  • various sun position-dependent parameters that can be set individually for each roller shutter. can be set individually for each roller shutter,
  • Triggers for door/window sensors that serve as lock-out protection or automatic opening at an individual level. opening at an individual level when the door or window is opened,
  • Various adjustable parameters for shading depending on e.g. inside temperature, outside temperature, brightness, heat sensor or similar,
  • Inclusion of the position of the sun in order to only darken rooms that are actually shaded. are illuminated.

All configuration data points are already preset with examples so that the adapter is quickly ready for use after installing and entering the IDs of the shutter ready for operation.

The further configuration is then used to adapt to personal wishes.

Shuttercontrol can only control actuators via the position, e.g. LEVEL, with values of from 0 to 100 or 0-255 respectively. The respective shutter or blind timing must be taken over by the actuator. be taken over by the actuator. Blind actuators that offer one object each for "height" and "slat angle" can be controlled using two blinds. can be used with two shutter objects with the same parameterisation. be used.


Installation

The adapter is located in the "stable" repository of ioBroker. In the "Adapter" tab "shuttercontrol" is selected and an instance of the shuttercontrol adapter is created via (+).

Configuration

After the creation of the instance, the configuration window opens automatically with the tabs MAIN SETTINGS, TIME SETTINGS and EXTRA SETTINGS.

πŸ‘‰ The Time Settings and Extra Settings tabs should be edited first, i.e. before shutters are added via the pencil in the MAIN SETTINGS.


MAIN SETTINGS

main

πŸ‘‰ The documentation on github can be accessed via the question mark at the top right (7).

Save or upload adapter configuration

Click on the arrow pointing downwards (9) in the top right-hand corner to save the adapter configuration as a .json file.
Click on the up arrow (8) to upload an existing adapter configuration in .json format.

Back to top


TIME SETTINGS

Basic time or Astro settings are made here, which are later used in the Shutter settings for each shutter. the Shutter settings for each shutter.

❗ Shuttercontrol always closes shutters Friday at the set time of the weekend.
and Sundays always at the set time of the working week ❗

timeSettings

Settings for the living area, sleeping area and children's area

The individual settings are opened via dropdown. The description is given as an example for the living area and applies analogously to all areas. for all areas.

πŸ‘‰ Of course, this categorisation does not necessarily have to be used for a living, sleeping or children's area. children's area, but makes it possible to define three areas in the building with different movement times of the roller shutters.

Type of automatic control for the living area

Pulldown is used to select between:

  • Living area time only:
    *The roller shutters are only operated time-controlled.

  • Time living area with sunrise & sunset.
    *The roller shutters are controlled according to sunrise and sunset, but do not go up
    up before the earliest time and not down after the latest time.

  • Time living area with Golden Hour:
    *Analogous to the sunrise and sunset, but with the beginning and end of the "Golden Hour" as a reference.

Closing the shutters during the working week: Customary time for darkening during the week.

Earliest time for raising during the week: *This is the earliest time for raising the shutters during the week.

Latest time for raising during the week: This is the latest time at which the roller shutters will be raised during the week.

Time delay for the staggered raising of the roller shutters (seconds): *Distance between the individual raising of the roller shutters
of this range, e.g. to avoid radio interference or to give the impression that they are being moved manually.

Closing of roller shutters at weekends: *Customary time for darkening at weekends and on public holidays.

Earliest time for raising at weekends: *This is the earliest time at which the shutters are raised at weekends and on public holidays.

Latest time for raising at the weekend: At this time the roller shutters are raised at the weekend and at the latest on public holidays.

πŸ‘‰ If roller shutters are never to be raised if the sun has not yet exceeded a certain has not yet passed a certain position, this time must be set to the latest time of this sun position (on 21.12.).

Back to top


EXTRA SETTINGS

ConfigExtra

Astro settings

extraSettingsAstro

Latitude and longitude: *Shuttercontrol takes the latitude and longitude from the ioBroker system settings.
Shuttercontrol uses these values to calculate the position of the sun.

Exiting the sun protection function with sun height (elevation): *As soon as the sun falls below the height set here, the shading ends.
the shading by Shuttercontrol ends.

πŸ‘‰ Possibly existing premature shading due to buildings or high trees, can be taken into account here and end the automatic shading earlier.

Time delay for raising or lowering (minutes): *A +/- offset can be entered here,
by which the shutter movements should be delayed from the type of automatic control selected in Time settings.

Time delay for staggered shutter movement (seconds): *To prevent all shutters from moving at the same time,
a global time delay in seconds can be set here.

Back to top


Summer settings

extraSettingsSummer

Start of summer and End of summer: *Here the start or end of summer can be set according to your own wishes.

Under Shutter settings of the respective shutter, setting the checkbox at Do not close shutter in summer prevents this shutter from closing in summer.

Back to top


Christmas settings

extraSettingsChristmas

Start of the Christmas period and End of the Christmas period: *Here, the start or end of the Christmas period can be set according to your own wishes.

Under Extra settings for roller shutters Christmas settings the function desired at this time is switched on and the desired roller shutter position.

Back to top


Holiday and public holiday settings

extraSettingsHolidays

Using public holidays: *By activating this checkbox and selecting the corresponding instance of the holiday adapter, the shutters will move on public holidays at the set times from the weekend.

πŸ‘‰ If necessary, two instances of the public holiday adapter can be created:
one to display all possible public holidays and one with public holidays relevant to working time, which is then accessed by shuttercontrol.

**Object ID for setting the holiday: *This object ID sets the internal state "Holiday".
Here, for example, a data point from the iCal adapter can be used that returns the value true in the case of a holiday and thus allows the shutters to move at the weekend times.

Back to top


Brightness Sensor Settings

extraSettingsBrightnesssensor

If the shutters are to be moved automatically using a brightness sensor, this is configured here.

Activation is then carried out individually for each shutter under Main shutter settings. under Type of control for closing (or opening) the roller shutter by selecting the entry "Brightness sensor".

Brightness value for closing with brightness sensor *Brightness value from which the shutters are to be closed.

Brightness value for opening with brightness sensor Brightness value from which the shutters are to be opened.

Object ID of brightness sensor *The reference to the brightness sensor, e.g. from a weather station or from an outdoor motion sensor or separate brightness sensor.

Back to top


School Holidays Settings

extraSettingsSchoolholidays

Here, the holiday period can be activated either via a separate data point with Object ID for activating/deactivating school holidays or by setting the tick the instance of the installed Schoolfree Adapter.
The shutters then open during the holiday period at the set times for weekend driving.
Holiday mode can be activated individually for each area.

Back to top


Special times

extraSettingsSonder

Close certain shutters later *This option allows all shutters to be lowered again late in the evening.
This covers the scenario when at the normal time for shutting down the window or door was still open. window or door was still open at the normal time for closing, or if, for example, the patio door is is opened again after shutting down.
When the check mark is set, the setting Time at which the configured roller shutters should close late appears.

This function must be activated for each shutter in the Shutter settings with the check mark at Close roller shutter late for each roller shutter separately or deactivated if not desired.

Close all shutters completely in the intermediate position Time when all shutters are completely closed in the evening (e.g. 10:00 p.m.).

Open roller shutter only if last movement x minutes ago: *The roller shutter is only opened by the adapter if the time set here has elapsed. set here has elapsed.

Back to top


Extra settings

extraSettingsExtra

Checking the current shutter status:
Some users (among others shelly users) have the problem that the level changes a little bit. For this reason there is a checkbox here. If the checkbox is activated, shuttercontrol will check the current level after the waiting time for the check of the shutter status, shuttercontrol checks the current level and saves it temporarily.

Blocking the manu mode for known shutter heights Rounding up or down the current shutter heights.
Here the position of the roller shutters can be rounded in steps of 5 or 10.

Object ID of the trigger for the sleeping area (Auto): *This trigger activates the auto mode of the sleeping area.

Object ID of the living area trigger (Auto): *This trigger activates the living area's Auto mode.

Object ID of the trigger for the children's area (Auto): *This trigger activates the children's area's Auto mode.


Alarm settings

extraSettingsAlarm

πŸ‘‰ For each alarm, a logical data point (true/false) is required for activation, which activates the alarm = status true or deactivates the alarm = status false.
πŸ‘‰ Furthermore, the height (0-100%) to which the roller shutter moves in the event of an alarm must be defined for each alarm.
point_right: In the Alarm setting of the respective shutter, it is then defined to which alarms the shutter should react. shutter should react.

Priorities of the individual alarms:

Prio 1 (highest priority) --> Fire:

If this alarm is triggered, the roller shutters configured for it will move to the set height in any case.

❗ The shutters are then blocked and will NOT close automatically, even if the fire alarm is reset (false).

πŸ‘‰After the fire alarm has been reset, the blinds must be reinitialised using the "openAll" / "closeAll" buttons.
This prevents the roller shutters from being closed again automatically for any reason in the event of a fire.
It also ensures that escape routes remain open and access for the fire brigade is guaranteed.

Prio 2 - 5 (same priority) --> Rain, Wind2, Wind1, Frost:

When these alarms are activated, Shuttercontrol moves the configured roller shutter to the last active alarm level.

When deactivating the individual alarms, however, the following priority is observed:
Prio 1 = Fire
Prio 2 = Rain
Prio 3 = Wind 2
Prio 4 = Wind 1
Prio 5 = Frost

The frost alarm only has a direct effect if the activated roller blinds are already closed (danger of the roller blind freezing). If the frost alarm is triggered when the roller shutter is still open, the roller shutter automatically only moves to the height set for frost alarm when it is closed.

Back to top


Shutter settings

main1

πŸ‘‰ The example actuator shutter example is automatically created, please delete it via the waste bin (5).

Now add your own shutter actuators by clicking on the (+) (1). The ID selection opens and select the data point LEVEL that represents the position of the desired roller shutter.

ID_Selector_DP_Levelg

Structure of the table:

tab

  • No: consecutive number of the listed shutters.

  • Active: Checkbox for activating/deactivating the control of the corresponding roller shutter.

  • Name: *Name of the actuator is automatically read in from the objects when the ID is selected and can then be changed according to your own wishes.

  • Object ID shutter: Unique ID of the data point to be controlled in the objects.

  • (+) Change a selected roller shutter actuator * Pencil * *Modify a selected roller shutter actuator

  • Pencil Open individual configuration of the respective roller shutter.

  • Double sheet: Copy roller shutter

  • Arrows: *Determine the order in which the roller shutters move with the same settings.

  • Trashcan:* *Deletes the shutter actuator with all configured data.

After the roller shutters have been created, pressing the pencil (3) on the corresponding roller shutter with the tabs MAIN SETTINGS for roller shutters, SUN PROTECTION SETTINGS and EXTRA SETTINGS
each shutter is further configured individually.


Main shutter settings

mainShutter.png

In the upper area, the times for opening or closing the shutter are selected are selected separately via a pull-down menu.

πŸ‘‰ These times have already been configured in Time settings.

Selection options:

  • Off: *Do not use timers.

  • Living area: *The shutter moves at the times as configured in Living area settings.

  • Living area (automatic):** * *The roller shutter moves at the times configured in Settings for the living area. and in addition, the shutter is activated in response to the trigger defined under Extra settings. Object ID for activating/deactivating the auto living area''. If If this is set to false, the roller shutter will not be moved automatically.

  • The roller shutter is moved at the times configured in Sleeping area settings.

  • The roller shutter is moved at the times configured in Settings for the sleeping area. and in addition, the shutter is activated in response to the trigger specified under Extra settings. Object ID for activating/deactivating the auto-sleep area''. If this is set to false, the roller shutter will not be moved automatically.

  • Children's area: * *The roller shutter is moved at the times configured in Children's area settings.

  • Children's area (automatic):* *The roller shutter moves at the times configured in Settings for the children's area. and in addition, the shutter is activated in response to the trigger defined under Extra settings. Object ID for activating/deactivating the auto children's area''. If this is set to false, the shutter will not be moved automatically.

  • Sunset/Sunrise:** * *The shutter moves at sunset or sunrise.

  • Sun elevation:If the elevation falls below the value set here, the roller shutter is closed.

  • Golden Hour:** * *The roller shutter closes at Golden Hour, which, depending on latitude and time of year, is approx. 1 hour before sunset or after sunrise. before sunset or after sunrise, depending on latitude and time of year.

  • Brightness sensor:** * *The roller shutter only moves according to the brightness sensor, which is set under Brightness sensor settings.

  • Manual operation only:** * *The roller shutter can only be moved manually in the selected direction. :point_right: No movement is possible via the buttons under shuttercontrol.0.control.
    point_right: This can be useful for awnings, for example, which should not be opened together with other roller shutters. which should not be opened together with other shutters.

Value of the window/door sensor in the closed state: *Here, the value is defined that the trigger under Object ID of the window/door contact (e.g. window or door contact) can have. (e.g. window or turn handle contact) at which the automatic roller shutter system is allowed to move indefinitely. :point_right: Values such as true, false, 0, 1 or 2 can be selected.

point_right: If the roller shutter is not in the uppermost position and the sensor status specified here changes, the roller shutter moves to the uppermost position. sensor status changes, the roller shutter moves to the roller shutter height when the window or door is opened.

Value of the window/door sensor in the tilted state: *This sets the value that the trigger under Object ID of the window/door contact (e.g. window or door contact) is set to. (e.g. window or turn handle contact) at which the automatic roller shutter system is allowed to move indefinitely.
πŸ‘‰ Values such as true, false, 0, 1 or 2 can be selected.

point_right: If the roller shutter is not in the uppermost position and the sensor status specified here changes, the roller shutter moves to the uppermost position. sensor status changes, the roller shutter moves to the roller shutter height when the window or door is opened.

❗ If no window contact with tilt function is present, this value should be set to "not present".

Move roller shutter when window/door status changes: Pulldown to select the function that is to be carried out when the window/door sensor moves should be carried out:

Off: no movement

  • Open: When opening the window/door, the shutter moves up and remains there, when closing the shutter does not move.
  • Close: After closing the window/door, the roller shutter moves to the blackout position, when opening, the roller shutter does not move. Opening and closing: The roller shutter moves up when the window/door is opened and moves down again when it is closed.

Roller shutter height when opening the window or door: *Wanted roller shutter position from 0-100, e.g. for windows 25% for ventilation, or 100% for doors to be able to pass through. for doors to be able to pass through.

Roller shutter height when window or door is tilted: *Wanted roller shutter position from 0-100, e.g. for windows 25% for ventilation.

Use automatic roller shutter even when window/door is open (lock-out protection) * If, at the time of automatic closing, the window/door sensor does not correspond to the value entered there (window/door closed), the following will be carried out according to the selected setting: *.

  • Off: Lock-out protection is active in both directions, the shutters do not move when the window is open.
  • Open: Only raising is allowed. At the end of darkening / shading, the roller shutter moves up even though the window is open. The roller shutter is not closed automatically when the window is open.
  • Close: Only closing is permitted. At the start of darkening / shading, the roller shutter moves down despite the window being open. The roller shutter is not opened when the window is open.
  • Opening and closing: The roller shutter may move in both directions when the window is open.

Roller shutter height when moving down: *Position value when the roller shutter is closed.

Roller shutter height when raised: Position value when roller shutter is open.

πŸ‘‰ The roller shutter height must be entered according to the actuators used (0-100 or 0-255): 0 = closed and 100 = open or 0 = open and 100 = closed.

Object ID of the window/door contact: Use the (+) to select the sensor (state) that is to prevent a roller shutter movement (e.g. door contact).

Back to top


Sun protection settings

sunProtect

Type of sun protection control: The sun protection can be controlled using various triggers for the shading and its end, The following combinations can be selected via pulldown:

  • Out of
  • Indoor & outdoor temperature/light sensor
  • Compass direction (sun position)
  • Indoor/outdoor temperature/light sensor & cardinal direction
  • Outside temperature/light sensor & direction
  • Outdoor temperature/light sensor
  • Indoor temperature

πŸ‘‰ The sun protection only triggers when ALL triggers of the selected combination are selected are active (logical AND connection) and ends when ONE of the triggers becomes inactive.

πŸ‘‰ An object ID must also be stored for ALL selected triggers.

πŸ‘‰ The light sensor is always optional and may remain empty. If the light sensor is configured, it is linked with the other parameters AND.

Roller shutter height when moving down: The value of how far the roller shutter should be closed when shading.

Direction (sun position): Alignment of the window on the compass rose (0Β° = north; 180Β° = south)

+/- Sun position range for active sun protection: Area in which the sun (around the center point) would interfere with the window. There is no shading outside this area.

Setpoint outside temperature: The shading starts at this value (or higher).

Hysteresis outside temperature (percent): Here you can set a hysteresis in percent so that the roller shutter at Fluctuations do not constantly go up and down. The hysteresis is the difference between the upper temperature value at which shading should begin and the lower temperature value at which shading ends again.

Outdoor temperature object ID: The sensor selected here via the (+) does not necessarily have to measure the outside temperature. He can provide any value that can be used to trigger the shading. This can also be a heat sensor (temperature difference sensor). If no outdoor sensor is selected as a trigger, leave this field blank.

Setpoint of the sun protection light sensor: Threshold value for starting the shading. This value depends on the sensor selected in the Object ID for the sun protection light sensor field.

Hysteresis light sensor (percent): Here you can set a downward hysteresis in percent so that the Roller shutters do not constantly move up and down when there are fluctuations caused by changing clouds. The hysteresis is the difference between the set setpoint at which the Shading should begin, and the lower brightness value at which shading should begin ends again.

πŸ‘‰ Example: Setpoint of the sun protection light sensor is set to 30,000, hysteresis to 40%: The sun protection is active from 30,000 and remains active until the value falls below 18,000.

Object ID of the sun protection light sensor: Analogue to the outside temperature sensor If not selected as trigger, leave blank

Setpoint indoor temperature: Here you can enter a temperature of an internal temperature sensor assigned to the roller shutter must be entered under which no shading should take place, for example in order to reduce the heat to use radiation in winter to support heating.

Hysteresis internal temperature (percent): Here you can set a hysteresis in percent so that the roller shutter at Internal temperature fluctuations do not constantly go up and down. The hysteresis is the difference between the upper temperature value at which shading should begin and the lower temperature value at which shading ends again.

Indoor temperature sensor object ID: Use the (+) to select the temperature sensor. If no indoor sensor is selected as a trigger, leave this field blank.

Back to top


Extra settings roller shutter

mainExtra

Roller shutter settings

mainExtraShutterSettings

Close roller shutters late With this option the roller shutter is activated at a defined time (adjustable in the Special times) is also shut down.

❗ The lock-out protection is not taken into account here and the roller shutter is lowered despite the window being open! (Danger of being locked out!!) ❗

Do not close roller shutters in summer Some roller shutters should not be closed in summer. The period will be summer in the Summer Settings.

Driving after closing window The roller shutter will be set to the last requested setting after the window/door is closed Position driven.

πŸ‘‰ This only works if the lockout protection is not set to "Off"!

Christmas Settings

mainExtraChristmas

If the roller shutter should only be partially closed at Christmas time, because If a candle arch or similar should remain visible, this option can be used. The The roller shutter will then not be completely closed at the normal closing time, but will only be closed driven to a level that can be set.

πŸ‘‰ The roller shutter level at Christmas time is only visible and adjustable if if the check mark for The roller shutter level at Christmas time is used is set.

The period when this function should be activated is set under Christmas Settings set.

πŸ‘‰ If the roller shutters are to be completely closed later in the evening, this option can be used Close roller shutter late or Move to intermediate position and close completely later can be used. :point_right: These two options can also be used independently of the Christmas settings.

Sun protection settings

mainExtraSun

Keep roller shutters in sun protection If this option is switched on, the roller shutter remains in the sun protection, even if There is no longer any sun protection requirement and remains in the sun protection as long as until the β€œclose” signal comes in the evening. This prevents the roller shutter from going up and down several times a day. Very practical in blind operation when the height is kept down (option checked), and just open and close the slats.

Delay for falling below the brightness until shading is ended (minutes) The time is set here at which a delay should take place if the shade is darkened and the brightness falls below the set level. The default value is 0 and can be adjusted if required. This option only works in conjunction with a brightness sensor

Heat protection This option allows the roller shutter to be completely closed in hot weather. After activating this option, the field for entering the temperature in Β°C appears.

πŸ‘‰ If a roller shutter is adjusted manually and the position does not correspond to that automatically, the automatic system stops!

πŸ‘‰ If the roller shutter is manually moved to the configured height for opening, closing or sun protection, the automatic function remains.

Extra settings

mainExtraExtra

Roller shutter delay when opening window (s) Parameter to delay opening of the roller shutter after the window/door has been opened (in seconds)

Roller shutter delay when closing window (s) Parameter to delay the closing of the roller shutter after the window/door has been closed (in seconds)

Move to intermediate position and later close completely When activated, roller shutter height in the intermediate position becomes visible. The roller shutter then moves to the set intermediate position when closing and later closes completely

Alarm setting

mainExtraAlarm

Here the alarms predefined for the current roller shutter via Alarm Settings are activated or deactivated.

Back to top


Data points

Shuttercontrol creates various data points under the following folders:

  • shuttercontrol.x.control
  • shuttercontrol.x.info
  • shuttercontrol.x.shutters

πŸ‘‰ x stands for the respective installed instance


shuttercontrol0control

datapointscontrol

Data points to control various functions such as: *Holiday If true, the roller shutters move at the set times on weekends and at false during weekday hours.

πŸ‘‰ Can use your own scripts that calculate or display vacation, days off, etc. set to true to enable weekend settings.

  • autoAll Button to set all shutters to auto mode

  • autoChildren If the roller shutters are controlled with children's area (automatic), the automatic function is activated here switched on with true and switched off with false.

  • auto living If the roller shutters are controlled with Living area (automatic), the automatic mode is used here switched on with true and switched off with false.

  • auto sleep If the roller shutters are controlled with sleeping area (automatic), the automatic mode is used here switched on with true and switched off with false.

  • closeAll Button to close all roller shutters in all areas

  • closeChildren Button to close all roller shutters in the children's area

  • closeLiving Button to close all roller shutters in the living area

  • closeSleep Button to close all shutters in the sleeping area

  • openAll Button to open all roller shutters in all areas

  • openChildren Button to open all roller shutters in the children's area

  • openLiving Button to open all roller shutters in the living area

  • openSleep Button to open all shutters in the sleeping area

  • school free Button to manually activate the holiday season and have the roller shutters open at the set time on the weekend

  • sunProtect Button to move the roller shutters into the sun protection position

  • sunProtectChildren Button to move the roller shutters in the children's area to the sun protection position

  • sunProtectLiving Button to move the roller shutters in the living area to the sun protection position

  • sunProtectSleep Button to move the roller shutters in the sleeping area to the sun protection position

Back to top


shuttercontrol0info

Data points for displaying calculated values and checking configured ones Times:

datapointsinfo

Back to top


shuttercontrol0shutters

datapointsshutters

  • autoDown For each roller shutter, automatic closing can be deactivated here with false or activated with true.

  • autoLevel Shows the current position for each roller shutter (roller shutter cannot be controlled via this).

  • autoState Shows the current status (up, down, Manu_Mode, sunProtect) for each roller shutter (roller shutter cannot be controlled via this).

  • autoSun The sun protection function can be deactivated for each roller shutter with false or activated with true.

  • autoUp For each roller shutter, automatic opening can be deactivated here with false or activated with true.

Back to top