ioBroker.schedule-switcher

Back to the README

Introduction

This adapter allows the user to switch devices on/off or 100/0 using time schedules. The schedules can be fully configured by a vis or vis-2 widget. One schedule switches one or more ioBroker states and consists of one or more triggers that define when and how the state should be switched. It is possible to configure at which time and on which weekdays the trigger should be triggered. Astro triggers or countdowns can also be created.

Summary

Instance Settings
Objecte
Example trigger evenst as JSON
Example trigger as JSON
Example sendTo Trigger (Experts only)
Example widget as JSON
Example history as JSON
Example widget view as JSON
Create widget
Change name
Create condition
Change text
Use css
Create trigger
create astro trigger
Create one time trigger
HTML settings
HTML Funktion for VIS-2 only
CSS

Instance settings schedule-switcher

+ icon: Add new schedule
ID: object channel id
Object id: object
Object name: Name of the widget
Trigger count: Number of triggers
Status: Status enabled/disabled
Delay between 2 switching operations in ms: Prevents states from being set at the same time
History switching as JSON (max 100/0 for off) Max. history json
Create HTML for VIS and VIS-2 (VIS-2 see description) HTML overview enabled

States

onoff
schedule-switcher.0.onoff.6.data All triggers as JSON
schedule-switcher.0.onoff.6.enabled Active or Inactive
schedule-switcher.0.onoff.6.views Where widgets were created for the objects
Status
schedule-switcher.0.counterTrigger Number of triggers (active and inactive)
schedule-switcher.0.history History from schedules switching
schedule-switcher.0.nextEvents Next switching operations as JSON Table
schedule-switcher.0.sendto With VIS-2, changes are passed to the adapter via this object

Example trigger events JSON

[
    {
        "type": "TimeTrigger", // TimeTrigger, AstroTrigger or OneTimeTrigger
        "name": "Rollloade Wohn", // Name
        "triggerid": 0, // Trigger ID
        "action": "OnOffStateAction", // OnOffStateAction or Condition
        "states": ["0_userdata.0.test", "0_userdata.0.test5"], // States
        "active": true, // enabled true or false
        "hour": 16, // Hour
        "minute": 22, // Minute
        "day": 9, // Day
        "dateISO": "2024-11-09T15:22:00.000Z", // Time without timezone
        "timestamp": 1731165720000, // Timestamp without timezone
        "objectId": 1 // ObejektId schedule-switcher.0.onoff.<objectid>.data
    }
]

Example trigger JSON

{
    "type": "OnOffSchedule",
    "name": "Rolllade Wohn", // Name of the last widget created
    "active": false, // Every 24 hours a check is made to see if there is a widget. If none is found, the schedule is deactivated. If TRUE, it is not deactivated.
    "onAction": {
        // Action for On
        "type": "OnOffStateAction",
        "valueType": "number",
        "onValue": 0,
        "offValue": 100,
        "booleanValue": true,
        "idsOfStatesToSet": ["0_userdata.0.test4"] // States max. 10
    },
    "offAction": {
        // Action for Off
        "type": "OnOffStateAction",
        "valueType": "number",
        "onValue": 0,
        "offValue": 100,
        "booleanValue": false,
        "idsOfStatesToSet": ["0_userdata.0.test4"] // States max. 10
    },
    "triggers": [
        {
            "type": "AstroTrigger", // Trigger - AstroTrigger - OneTimeTrigger
            "astroTime": "sunrise",
            "shiftInMinutes": 0,
            "weekdays": [1, 2, 3, 4, 5, 6],
            "id": "0",
            "action": {
                "type": "ConditionAction",
                "condition": {
                    "type": "StringStateAndConstantCondition",
                    "constant": "true",
                    "stateId": "0_userdata.0.test",
                    "sign": "=="
                },
                "action": {
                    "type": "OnOffStateAction",
                    "name": "On"
                }
            }
        }
    ]
}

Example widgets JSON

{
    "vis-2.0": {
        // Which VIS version
        "main": {
            // Project
            "w000005": {
                // Widget ID
                "prefix": "main", // Project
                "namespace": "vis-2.0", // Which VIS version
                "view": "Rollladen", // Which view
                "widgetId": "w000005", // Widget ID
                "newId": "schedule-switcher.0.onoff.6.data", // New Object
                "oldId": "timer-switch.0.onoff.1.data", // Old Object
                "enabled": "schedule-switcher.0.onoff.6.enabled", // Enabled Objekt
                "stateCount": 1, // Counter States
                "state": [
                    // States
                    {
                        "oid-stateId1": "0_userdata.0.test5"
                    }
                ],
                "conditionCount": 1, // Counter Conditions
                "condition": [
                    // States of Conditions
                    {
                        "oid-conditionStateId1": "0_userdata.0.test"
                    }
                ]
            },
            "w000006": {
                // Which VIS version
                "prefix": "main", // Project
                "namespace": "vis-2.0", // Which VIS version
                "view": "Test", // Which view
                "widgetId": "w000006", // Widget ID
                "newId": "schedule-switcher.0.onoff.6.data", // New Object
                "oldId": "timer-switch.0.onoff.1.data", // Old Object
                "enabled": "schedule-switcher.0.onoff.6.enabled", // Enabled Objekt
                "stateCount": 1, // Counter States
                "state": [
                    // States
                    {
                        "oid-stateId1": "0_userdata.0.test4"
                    }
                ],
                "conditionCount": 1, // Counter Conditions
                "condition": [] // States of Conditions
            }
        }
    }
}

Example of creating or editing triggers with sendTo (experts)

sendTo("schedule-switcher.0", "add-trigger", { // Create new trigger
    "dataId":"schedule-switcher.0.onoff.6.data",
    "triggerType":"TimeTrigger",
    "actionType":"OnOffStateAction"
});

sendTo("schedule-switcher.0", "update-trigger", { // Set the action for the new trigger
    "dataId":"schedule-switcher.0.onoff.6.data",
    "trigger":{
        "type":"TimeTrigger",
        "hour":12,
        "minute":32,
        "weekdays":[1,2,3,4,5],
        "id":"0", // Known ID
        "action":{
            "type":"OnOffStateAction",
            "name":"On"
        }
    }
});

sendTo("schedule-switcher.0", "add-trigger", { // Create new Astrotrigger
    "dataId":"schedule-switcher.0.onoff.6.data",
    "triggerType":"AstroTrigger",
    "actionType":"OnOffStateAction"
});

sendTo("schedule-switcher.0", "update-trigger", { // Set the action for the new trigger
    "dataId":"schedule-switcher.0.onoff.6.data",
    "trigger":{
        "type":"AstroTrigger",
        "astroTime":"sunrise", // sunrise, sunset or solarNoon
        "shiftInMinutes":0,
        "weekdays":[1,2,3,4,5],
        "id":"0", // ID abgleichen
        "action":{
            "type":"OnOffStateAction",
            "name":"On"
        }
    }
});

sendTo("schedule-switcher.0", "disable-schedule", { // deactivate trigger
    "dataId":"schedule-switcher.0.onoff.6.data"
});

sendTo("schedule-switcher.0", "enable-schedule", { // activate trigger
    "dataId":"schedule-switcher.0.onoff.6.data"
});

sendTo("schedule-switcher.0", "add-one-time-trigger", { // Create onetimetrigger
    "dataId":"schedule-switcher.0.onoff.6.data",
    "trigger":"{\"type\":\"OneTimeTrigger\",\"date\":\"2024-10-17T06:14:22.660Z\",\"timedate\":false,\"action\":{\"type\":\"OnOffStateAction\",\"name\":\"On\"}}"
});

sendTo("schedule-switcher.0", "delete-trigger", { // Delete trigger with known ID
    "dataId":"schedule-switcher.0.onoff.6.data",
    "triggerId":"0"
});

sendTo("schedule-switcher.0", "change-active", { // Leave schedule active without widget (will be checked on restart or every 24 hours)
    "dataId":"schedule-switcher.0.onoff.6.data",
    "active":false, // false: Automatic deactivation if no widget is available
});

sendTo("schedule-switcher.0", "change-active", { // Leave schedule active without widget (will be checked on restart or every 24 hours)
    "dataId":"schedule-switcher.0.onoff.6.data",
    "active":true, // true: Schedule will not be deactivated if no widget is present
});

Example history JSON

[
  {
    "setObjectId": "0_userdata.0.test4",
    "objectId": 0,
    "value": "true",
    "object": "0_userdata.0.test4",
    "trigger": "TimeTrigger",
    "astroTime": "unknown",
    "shift": 0,
    "date": 0,
    "hour": 20,
    "minute": 48,
    "weekdays": [
      [
        1,
        2,
        3,
        4,
        5,
        6,
        0
      ]
    ],
    "time": 1729622880040
  },
  {
    "setObjectId": "0_userdata.0.test4",
    "objectId": 0,
    "value": "true",
    "object": "0_userdata.0.test4",
    "astroTime": "unknown",
    "shift": 0,
    "date": 0,
    "hour": 20,
    "minute": 47,
    "weekdays": [
      [
        1,
        2,
        3,
        4,
        5,
        6,
        0
      ]
    ],
    "time": 1729622820071
  }
]

Example Widget View JSON

{
    "vis-2.0": {
        "main": {
            "w000004": {
                "prefix": "main", // Project
                "namespace": "vis-2.0", // VIS
                "view": "default", // View
                "widgetId": "w000004", // Widget ID
                "newId": "schedule-switcher.0.onoff.3.data" // Object ID
            }
        }
    },
    "vis.0": {
        "main": {
            "w00001": {
                "prefix": "main",
                "namespace": "vis.0",
                "view": "Rollo",
                "widgetId": "w00001",
                "newId": "schedule-switcher.0.onoff.3.data"
            }
        }
    }
}

Create widget

Insert a widget in a view

Select ID for schematic data
Select Schedule Activation ID
Select ID of the switched state (max. 10 possible)

Define value type and the values that should be set

Create on time schedule

Change name

Change names - objects are customized

Create condition

Create a condition.

Change text

Change text on/off and all on/all off

Use css Description see css

Use Enable CSS to customize the style

Trigger

Click on the pen to enter the time or click on the trash can to delete the trigger

Select switching state
Select a condition (optional)
Enter time (hh:mm)

 ⚠ Does not show any time field in Firefox.

Select day of the week
Click save at the top right

Done

Astro Trigger

Click on the pen to select the astro time or click on the trash can to delete the trigger

Select switching state
Select a condition (optional)
Select astro time (Sunrise, Sunset or Noon)

Enter offset in minutes (optional)
Select day of the week
Click save at the top right

Done

One Time Trigger

Select switching state
Select a condition (optional)
Enter time (hh:mm:ss)
Click save at the top right

Done

Select switching state
Select a condition (optional)
Enter or select time/date (dd.mm.yyyy hh:mm:ss)
Click save at the top right

 ⚠ Does not show any time field in Firefox.

Done

HTML for VIS and VIS-2

html.background_color_body Background color of the body. Complete with VIS and only the widget with VIS-2 - default #000000
html.background_color_even background color trigger even number - default #1E1E1E
html.background_color_odd background color trigger odd number - default #18171C
html.background_color_trigger background color trigger object - default #000000
html.background_color_weekdays_hover background color when hovering over the days of the week - click to activate/deactivate - default blue
html.column_align_01 Header text alignment column 1 - default center
html.column_align_02 Header text alignment column 2 - default center
html.column_align_03 Header text alignment column 3 - default center
html.column_align_04 Header text alignment column 4 - default center
html.column_align_05 Header text alignment column 5 - default center
html.column_align_06 Header text alignment column 6 - default center
html.column_align_07 Header text alignment column 7 - default center
html.column_align_08 Header text alignment column 8 - default center
html.column_align_09 Header text alignment column 9 - default center
html.column_align_10 Header text alignment column 10 - default center
html.column_text_01 Header text column 1 - default Schedule
html.column_text_02 Header text column 2 - default Devices
html.column_text_03 header text column 3 - default switch
html.column_text_04 header text column 4 - default Mon
html.column_text_05 header text column 5 - default Tu
html.column_text_06 Header text column 6 - default We
html.column_text_07 Header text column 7 - default Th
html.column_text_08 header text column 8 - default Fr
html.column_text_09 header text column 9 - default Sa
html.column_text_10 Header text column 10 - default Su
html.column_width_01 width of column 1 - default auto
html.column_width_02 width of column 2 - default auto
html.column_width_03 Width of column 3 - default auto
html.column_width_04 Width of column 4 - default auto
html.column_width_05 Width of column 5 - default auto
html.column_width_06 Width of column 6 - default auto
html.column_width_07 Width of column 7 - default auto
html.column_width_08 Width of column 8 - default auto
html.column_width_09 Width of column 9 - default auto
html.column_width_70 Width of column 10 - default auto
html.font_color_text_disabled Text color from disabled object - default red
html.font_color_text_enabled Text color of the activated object - default yellow
html.font_color_weekdays_disabled Text color of disabled weekdays - default red
html.font_color_weekdays_enabled Text color of enabled weekdays - default yellow
html.header_border head margin in px - default 2
html.header_font_family head font family - default Helvetica
html.header_font_size head font size - default 15
html.header_linear_color_1 head background image: linear gradient 1 - default #BDBDBD
html.header_linear_color_2 head background image: linear gradient 2 - default #BDBDBD
html.header_tag_border_color Head HTML TAG <td> border color - default #424242
html.header_width head TAG <table> size default auto
html.column_align_row_01 Text alignment of the rows in column 1 - default left
html.column_align_row_02 Text alignment of the rows in column 2 - default left
html.column_align_row_03 Text alignment of the rows in column 3 - default left
html.column_align_row_04 Text alignment of the rows in column 4 - default left
html.column_align_row_05 Text alignment of the rows in column 5 - default left
html.column_align_row_06 Text alignment of the rows in column 6 - default left
html.column_align_row_07 Text alignment of the rows in column 7 - default left
html.column_align_row_08 Text alignment of the rows in column 8 - default left
html.column_align_row_09 Text alignment of the rows in column 9 - default left
html.column_align_row_10 Text alignment of the rows in column 10 - default left
html.headline_color Header font color (schedule, device ...) - default #ffffff
html.headline_font_size Header font size in px - default 16
html.headline_height Header height in px - default 35
html.headline_underlined Header underline in px - default 3
html.headline_underlined_color Header underline color - default #ffffff
html.headline_weight Header text weight - default normal
html.html_code HTML Code for VIS, VIS-2, Jarvis, IQontrol etc
html.icon_false Icon Trigger off - default ⚪
html.icon_switch_symbol Icon switch to activate/deactivate the timer - default ⏱
html.icon_true Icon Trigger on - default 🟡
html.jarvis Compatible with Jarvis - default false
html.p_tag_text_algin HTML <p> Text align (Last Update and Footer) - default center
html.table_tag_border_color Border color for <table> - default #424242
html.table_tag_cell border-spacing for <table> in px - default 6
html.table_tag_text_align Text algin for <table> - default center
html.table_tag_width Width for <table> - default auto
html.td_tag_border_bottom Border bottom for <td> in px - default 1
html.td_tag_border_color Border color for <td> - default #424242
html.td_tag_border_right Border right for <td> in px - default 1
html.td_tag_cell Padding text for <td> in px - default 6
html.top_font_family Font family for header and footer - default Helvetica
html.top_font_size Font size for header and footer in px - default 20
html.top_font_weight Font weight for header and footer - default normal"
html.top_text Own text for header - default your text
html.top_text_color Text color for header and footer - default #ffffff
html.update Start manual update

Create an HTML widget and enter the object under HTML {schedule-switcher.0.html.html_code}
Click on the text “Last updated” to manual update
Click on the icon to activate/deactivate the widget
To delete a trigger you first have to tick the checkbox and then press the 'delete' button
Change times/Astro and press the 'save' button to apply the changes
Click on the day of the week to activate/deactivate it
In the trigger name line, the next event on/off is displayed under days of the week

Function for VIS-2 ONLY!!!

Unfortunately, ONLY with VIS-2 the functions listed below have to be inserted manually (see pictures)

function deleteTrigger(stateId, command, id, dataid, count) {
    var checked = document.getElementById('delete' + count).checked;
    if (checked) {
        var data = {
            "command": command,
            "message": {
                "triggerId": id,
                "dataId": dataid,
            }
        };
        vis.conn.setState(stateId + '.sendto', { val: JSON.stringify(data), ack: false });
    }
}
function changeweekdays(stateId, command, dataid, id, changeid, type) {
    if (type === "OneTimeTrigger") return;
    var data = {
        "command": command,
        "message": {
            "changeid": changeid,
            "triggerid": id,
            "dataid": dataid
        }
    };
    vis.conn.setState(stateId + '.sendto', { val: JSON.stringify(data), ack: false });
}
function updateTrigger(stateId) {
    vis.conn.setState(stateId + '.html.update', { val: true, ack: false });
}
function setState(stateId, value) {
    vis.conn.setState(stateId, { val: value == 'false' ? false : true, ack: false });
}
function sendToAstro(stateId, command, dataid, id, count) {
    var timeselect = document.getElementById('timeselect' + count).value;
    var shift = document.getElementById('shift' + count).value;
    var data = {
        "command": command,
        "message": {
            "astrotime": timeselect,
            "shift": shift,
            "triggerid": id,
            "dataid": dataid
        }
    };
    vis.conn.setState(stateId + '.sendto', { val: JSON.stringify(data), ack: false });
}
function sendToDateTime(stateId, command, id, dataid, count) {
    var value = document.getElementById('datetime' + count).value;
    var data = {
        "command": command,
        "message": {
            "time": value,
            "triggerid": id,
            "dataid": dataid
        }
    };
    vis.conn.setState(stateId + '.sendto', { val: JSON.stringify(data), ack: false });
}
function sendToTime(stateId, command, id, dataid, count) {
    var value = document.getElementById('nexttime' + count).value;
    var data = {
        "command": command,
        "message": {
            "time": value,
            "triggerid": id,
            "dataid": dataid
        }
    };
    vis.conn.setState(stateId + '.sendto', { val: JSON.stringify(data), ack: false });
}

CSS

app-on-off-schedules-widget {
    /* Primary color (button background, toggle switch color) */
    --ts-widget-primary-color: #337ab7;

    /* Background color of the widget */
    --ts-widget-bg-color: #424242;
    /* Background color of the triggers */
    --ts-widget-trigger-bg-color: #272727;

    /* Foreground color (font color and scrollbar color) */
    --ts-widget-fg-color: white;
    /* Font color of the switched states id */
    --ts-widget-oid-fg-color: #a5a5a5;
    /* Font color in buttons */
    --ts-widget-btn-fg-color: white;
    /* Font color of a disabled weekday */
    --ts-widget-weekdays-disabled-fg-color: #5D5D5D;
    /* Font color of an enabled weekday */
    --ts-widget-weekdays-enabled-fg-color: white;
    /* Font color of the name of the widget (defaults to --ts-widget-fg-color) */
    --ts-widget-name-fg-color: white;
    /* Font color of switched time (defaults to --ts-widget-fg-color) */
    --ts-widget-switched-time-fg-color: white;
    /* Font color of switched value (defaults to --ts-widget-fg-color)*/
    --ts-widget-switched-value-fg-color: white;
    /* Font color of the astro time (defaults to --ts-widget-fg-color) */
    --ts-widget-astro-time-fg-color: black;
    /* Font color of the astro time's shift */
    --ts-widget-astro-shift-fg-color: #5d5d5d;
    /* Font color of condition (defaults to --ts-widget-fg-color) */
    --ts-widget-condition-fg-color: white;
    /* Font color of toogle button off */
    --ts-widget-off-color: #c0c0c0;
    /* Color background toogle button off */
    --ts-widget-off-color-container: #808080;
    /* Color of next astro switching time */
    --ts-widget-astro-next-fg-color: white;

    /* Font family used in the whole widget */
    --ts-widget-font-family: 'Roboto', 'Segoe UI', BlinkMacSystemFont, system-ui, -apple-system;
    /* Font size of the name of the widget */
    --ts-widget-name-font-size: 2em;
    /* Font size of the switched oid */
    --ts-widget-oid-font-size: 30px;
    /* Font size of switch text */
    --ts-widget-state-action-width: 65px;
    /* Font size of next astro switching time */
    --ts-widget-astro-next-font-size: 2em;
    /* Width of date time input */
    --ts-widget-datetime-width: 230px;

    /* Display of edit name button. Use 'none' to hide the button and 'block' to show it
    --ts-widget-edit-name-button-display: block;
    /* Display of condition. Use 'none' to hide the condition and 'block' to show it
    -ts-widget-condition-display: block;
    /* Display of time icon. Use 'none' to hide the button and 'block' to show it
    --ts-widget-time-icon-display: none;

    /* Applies a filter to icons used in buttons (safe, edit, remove, cancel), for
       white use invert(1) and for black invert(0) */
    --ts-widget-img-btn-filter: invert(1);

    /* Add trigger dropdown background color */
    --ts-widget-add-trigger-dropdown-bg-color: #f1f1f1;
    /* Add trigger dropdown font color */
    --ts-widget-add-trigger-dropdown-fg-color: black;
    /* Add trigger dropdown hover background color */
    --ts-widget-add-trigger-dropdown-hover-bg-color: #ddd;

    /* ! Changing these may break the layout, change at your own risk */

    /* Font size of weekdays */
    --ts-widget-weekdays-font-size: 23px;
    /* Font size of switched value (on/off) */
    --ts-widget-switched-value-font-size: 2em;
    /* Font size of switched time */
    --ts-widget-switched-time-font-size: 2em;
    /* Font size of the astro time (e.g. Sunrise, ...) */
    --ts-widget-astro-time-font-size: 1.5em;
    /* Font size of the astro time's shift */
    --ts-widget-astro-shift-font-size: 1em;
    /* Font size of condition */
    --ts-widget-condition-font-size: 1em;
}