# Controls

Tutorial on writing setpoints and schedules for active building control.

## Overview¶

The aedifion Edge Device allows writing setpoints or whole schedules of many setpoints to any writable datapoint on any building automation component in the attached building network. The semantics of writing setpoints and schedules abstracts from the underlying building networks and automation protocols and thereby provides a unified, fine-grained control of the building's automation components. In this article, we cover basic concepts and examples of writing setpoints and schedules for active building control.

### Preliminaries¶

The examples provided in this section partly build on each other. For the sake of brevity, boiler plate code such as imports or variable definitions is only shown once and left out in subsequent examples.

To execute the examples provided in this tutorial, the following is needed:

• A project with writable datapoints.
• Optionally, a working installation of Python or Curl.

## Setpoints vs. schedules¶

Before writing actual setpoints and schedules, we should clearly understand what they are and how they differ in their functionality.

### Setpoints¶

Setpoints can be acknowledged or not. In the former case, a reference is returned which can be used to query information about the state of the setpoint write operation. In the latter case, no direct feedback is given about the success or failure of a setpoint write operation and no state is kept for the setpoint write operation.

Once a setpoint is created by the user, the setpoint write operation is immediately started and cannot be delayed, modified, or cancelled afterwards.

Existing setpoints (at the same priority) are overwritten without any warning by a new setpoint. However, if the setpoint write operation is acknowledged, the overwritten value will be returned as part of that operation's state.

If an error occurs on any stage for any reason, the whole setpoint write operation fails. No recovery action is taken, i.e., it is left to the user to ensure that the system is in the desired state.

Once a setpoint is successfully written, it remains active until it is overwritten by another setpoint. In other words, a written setpoint never expires on its own and is never reset automatically.

In summary, setpoints are single one-shot best-effort low-overhead irrevocable write operations. They are fast and easy to use.

### Schedules¶

Schedules are comprised of multiple timed setpoint write operations.

Schedules can have arbitrary length in terms of time and number of setpoints. They can range from short daily control routines to complex, periodically updated optimization plans that consist of hundreds to thousands of setpoints.

Schedules are replicated from the API to the Edge Device. Thus, they run even if the connection to the Internet, in particular to the API, is lost. Since they are persisted locally, they even survive a crash or reset of the Edge Device, e.g., due to a power cut, and just resume where they left off afterwards.

Before a schedule becomes active on the Edge Device, the current state of the datapoint that is written to by the schedule is saved before overwriting it, so that the schedule can fall back to this state in case of error.

When active, a schedule's state and each of its state transitions are logged to the API and can be queried through the API using the schedule's unique reference.

Most parts of a schedule are modifiable. In particular, setpoints can be added to a schedule and existing setpoints can be modified and deleted - even while the schedule is already running.

Schedules have different failure mechanisms built-in and utmost care is taken to never leave the system in an undesired and/or inconsistent state. First, schedules have a configurable or automatically determined reset value that is written if an unrecoverable error occurs. Second, schedules can reset themselves if a periodic heartbeat from the API is missed, e.g., when Internet connectivity is down for too long on long running schedules that require periodic updates.

Schedules can be cancelled after they have been initialized, before and during execution.

In summary, schedules are stateful, acknowledged, robust, and modifiable. They are more complex than bare setpoint write operations but also more robust.

In the following, we define schedules in more detail. You may skip these and go on directly to the usage scenarios of setpoints and schedules.

States and transitions of schedules

The lifecycle of a schedule is defined by five possible states:

1. A new schedule is always created in state initialized.
2. When the schedule is syntactically correct and the specified project and data points exist the schedule will transition into state active after a few seconds.
3. When a (critical) error occurs at any time, the schedule transitions into state failed where it has reached end-of-life (EoL).
4. When a user cancels a schedule, it first transitions into stopping where it awaits acknowledgement from the Edge Device and cannot be modified anymore.
5. When the schedule has been completely executed or successfully stopped by the user, it transitions into terminated where it has reached EoL.

Structure and execution of a schedule

A schedule $$S$$ is defined as a series of setpoints, i.e.,

$$S = \left(s_1,...,s_n\right)=\left(\left(id_1,t_1,v_1\right),...,\left(id_n,t_n,v_n\right)\right)$$

where $$s_1,...,s_n$$ are setpoints and each single setpoint $$s_i$$ within is defined by a unique id $$id_i$$, a start time $$t_i$$ and its value $$v_i$$.

Setpoints are executed strictly in order of time. If two setpoints have the same start time, their ordering in $$S$$ determines which is executed first. With $$t_1 \leq ... \leq t_n$$ wlog., a schedule thus executes as follows:

• The schedule starts with execution of $$s_1$$ at time $$t_1$$ where $$v_1$$ is written.
• Setpoint $$s_i$$ is written at time $$t_i$$ and overwrites the previous value $$v_{i-1}$$ with $$v_i$$.
• If $$s_i$$ lies in the past, i.e., $$S$$ is created after $$t_i$$, $$s_i$$ is written immediately.
• The schedule ends with execution of $$s_n$$ (we refer to this as the stop event) at time $$t_n$$ where $$v_n$$ is written.

### Usage scenarios¶

Due to the different properties of setpoints and schedules, the user should carefully choose which one to use in his/her scenario.

For example:

• Use setpoints to switch on and off components like a human would on a real switch, but use schedules to switch on and off components on predefined points in time like a timer would do.
• Use setpoints to make permanent changes, but use schedules to make temporary changes as schedules leave the system in the same state as before running the schedule.

## API Tutorial¶

Setpoints and schedules are written and managed through the HTTP API. In this section, we go through the steps of unlocking setpoints and schedules for an existing project, configuring selected datapoints for writing, and, finally, writing sample setpoints and schedules.

### Enabling write access¶

Setpoints and schedules write directly to building automation components and may thus (deliberately) complement, interfere with, or completely override existing control and automation. This is a critical operation and thus disabled per default on all projects. Further, there is a series of safeguards in place that limit and protect access to this feature. We go through these safeguards one by one in the following.

1. Activating setpoints and schedules in the project

The setpoints and schedules feature is by default completely locked for all projects. Trying to post a setpoint or schedule results - even with the right roles and permissions (next step) - in an error:

{
"success": false,
"error": "Project 1 not found or setpoint writing not enabled for project.",
"operation": "post"
}


• the project (id) for which you wish to activate writing.
• whether you wish to enable setpoints or schedules or both.
• the maximum priority that is allowed for writing setpoints and schedules, e.g., for protocols such as BACnet which support different priorities. Writing at higher priorities will not be possible.

2. Configuring roles and permissions

Writing requires write permissions on datapoints. If you do not have sufficient access, you will receive an error message similar to this one:

{
"success": false,
}


By default, the automatically created admin role of a project has full read/write access on all datapoints. It is, however, strongly advised to set up roles with more restricted write access, e.g., limited to only the necessary datapoints, and not freely assign the admin role to all users just for the sake of simplicity. Please refer to our administration tutorial on how to set up roles and permissions for projects and datapoints exactly as you need them.

3. Configuring datapoints for writing

In addition to the general feature lock (step 1) and the role-based access control (step 2), a third safeguard is in place: lower and upper bounds for writing that are defined individually for each datapoint. Trying to write to a datapoint that has no bounds configured results in this error:

{
"success": false,
"error": "Datapoint 'bacnet100-4120-Real-room-temperature-setpoint-RTs_real' has no bounds for setpoint writing. Cowardly refusing setpoint schedule - please contact support@aedifion.com",
"operation": "create"
}


Writing bounds can be configured through the PUT /v2/datapoint endpoint which requires the following parameters:

Parameter Datatype Type Required Description Example
project_id integer query yes The numeric id of the project. 1
dataPointID string query yes The alphanumeric id of the datapoint for which to configure writing bounds. bacnet100-4120-Real-room-temperature-setpoint-RTs_real
setpoint_min_value float body (JSON) yes Lower bound for writing to this datapoint. 15
setpoint_max_value float body (JSON) yes Upper bound for writing to this datapoint. 25

Here is an example of configuring writing bounds for a room temperature setpoint. A range of 15° to 25° Celsius seems reasonable in this example:

import requests

api_url = 'https://api.aedifion.io'
auth_john = ("john.doe@aedifion.com", "mys3cr3tp4ssw0rd")
project_id = 1
dataPointID = "bacnet100-4120-Real-room-temperature-setpoint-RTs_real"
datapoint_update = {
"setpoint_min_value":15,
"setpoint_max_value":25
}
r = requests.put(f"{api_url}/v2/datapoint",
auth=auth_john,
json=datapoint_update,
params={"project_id": project_id, "dataPointID": dataPointID})

curl 'https://api3.aedifion.io/v2/datapoint?project_id=1&dataPointID=bacnet100-4120-Real-room-temperature-setpoint-RTs_real'
-X PUT
-u john.doe@aedifion.com:mys3cr3tp4ssw0rd
-H 'Content-Type: application/json'
-d '{
"setpoint_max_value": 25,
"setpoint_min_value": 15
}'

1. Point your browser to https://api.aedifion.io/ui/.
3. From the main tags (Meta, Company, ...) select the Datapoint tag, then the PUT /v2/datapoint endpoint (yellow).
4. Provide the project_id, dataPointID and the datapoint_details, e.g., "setpoint_max_value": 25 and "setpoint_min_value": 15.
5. Click "Try it out!".
6. Inspect the response body and code.

The answer confirms that our request was successful.

{
"success": true,
"operation": "update",
"resource": {
"dataPointID": "bacnet100-4120-Real-room-temperature-setpoint-RTs_real",
"hash_id": "7fSjkcIH",
"id": 533,
"project_id": 1,
"setpoint_max_value": 25,
"setpoint_min_value": 15
}
}


Within the configured bounds, writing is now possible while any attempt to write outside these bounds results in an error:

{
"success": false,
"error": "Setpoints for datapoint 'bacnet100-4120-Real-room-temperature-setpoint-RTs_real' are restricted to [15.0,25.0]. Cowardly refusing schedule due to value 30.",
"operation": "create"
}


### Writing single setpoints¶

Setpoints are written through the POST /v2/datapoint/setpoint endpoint. The caller must provide the following parameters:

Parameter Datatype Type Required Description Example
project_id integer query yes The numeric id of the project. 1
dataPointID string query yes The alphanumeric id of the datapoint that should be written to. bacnet100-4120-Real-room-temperature-setpoint-RTs_real
value string query yes A string containing an integer or float value that should be written to the data point or the special string null to clear the value. 16.7
priority integer query no The priority at which to write the setpoint (default = 13). 15
acked boolean query no Whether this setpoint operation is acknowledged or not. False
dryrun boolean query no Whether this is a dry run that only tests but does not actually write the setpoint. False

Having enabled write access, we can now write a setpoint. Please carefully choose a datapoint when executing these examples as you are operating on a real building.

project_id = 1
dataPointID = "bacnet100-4120-Real-room-temperature-setpoint-RTs_real"
r = requests.post(f"{api_url}/v2/datapoint/setpoint",
auth=auth_john,
params={'project_id': 1,
'dataPointID': dataPointID,
'value': 16.7,
'priority': 15})
print(r.text)

curl "https://api-dev.aedifion.io/v2/datapoint/setpoint?dataPointID=bacnet100-4120-Real-room-temperature-setpoint-RTs_real&project_id=1&value=16.7&priority=13"
-X POST
-u john.doe@aedifion.com:mys3cr3tp4ssw0rd

1. Point your browser to https://api.aedifion.io/ui/.
3. From the main tags (Meta, Company, ...) select the Datapoint tag, then the POST /v2/datapoint/setpoint endpoint (yellow).
4. Provide the dataPointID, project_id and the value.
5. Click "Try it out!".
6. Inspect the response body and code.

A successful setpoint write operation (from the point of view of the API) returns HTTP 200 (OK) and a JSON containing the details of the setpoint:

{
"success":true,
"operation":"create",
"resource": {
"acked": false,
"dataPointID": "bacnet100-4120-Real-room-temperature-setpoint-RTs_real",
"dryrun": false,
"priority": 15,
"value": 16.7
}
}


Interpreting the response: For unacknowledged setpoint write operations, a successful response (HTTP 200) only means that the API accepted the request, i.e., the Edge Device is correctly configured and the user is authorized for writing to the building. There may still be errors on the side of the Edge Device that are not reported back to the API. If a real acknowledgement is required, the user should set acked = True or use schedules instead.

We have now set the desired temperature to 16.7 °C and the HVAC system will probably start working hard to follow your control input. Spin up any existing building management system of your choice and check the effect of your actions.

The written setpoint will remain active until it is cleared or overwritten. Since 16.7 °C is pretty cold for an office, we will soon wish to reset this ourselves and let the existing building automation system regain control. To this end, we need to write 'null' to the previously written datapoint and priority. Let's do an acknowledged write this time. And, let's be more careful and do a dryrun first.

r = post(f"{api_url}/v2/datapoint/setpoint",
auth=auth_john,
params={'project_id': 1,
'dataPointID': dataPointID,
'value': 'null',
'priority': 15,
'acked': True,
'dryrun': True})
print(r.text)


Note that the response now contains a reference for this setpoint write operation.

{
"success": true,
"operation": "create",
"resource": {
"acked": true,
"dataPointID": "bacnet100-4120-Real-room-temperature-setpoint-RTs_real",
"dryrun": true,
"priority": 15,
"project_id": 1,
"reference": "0cce300f-6b9e-447d-ae29-0e7125e2fa36",
"value": "null"
}
}


Note that the response contains a reference. This reference can be used to look up the state of the setpoint write operation using the GET /v2/datapoint/setpoint/{reference} endpoint. Querying the previous reference returns the following answer (the log is returned as a JSON-formatted string that we reformatted to a list here for better readability):

{
"dataPointID": "bacnet100-4120-Real-room-temperature-setpoint-RTs_real",
"log": [
{
"msg": "Setpoint initialized on API.",
"status": "initialized",
"acked": true,
"dryrun": true,
"time": "2018-12-28T13:10:33.760509Z"
},
{
"msg": "Setpoint request sent to edge device.",
"status": "requested",
"time": "2018-12-28T13:10:33.774182Z"
},
{
"msg": "[DRYRUN] Successfully wrote value 'null' at priority 15 to object instance 3004665 of type 'analogOutput'",
"priorityArray": "[16, 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', 'null', '16.7', '22.5']",
"status": "written",
"overwritten_value": "16.7",
"time": "2018-12-28T13:10:34.146189Z"
}
],
"old_value": "16.7",
"priority": 15,
"project_id": 1,
"reference": "0cce300f-6b9e-447d-ae29-0e7125e2fa36",
"status": "written",
"value": "null"
}


The status of the operation is now written which means that it was successful and the setpoint is in effect (if this wasn't a dry run). The field old_value contains the value that would be overwritten by this setpoint if this wasn't a dry run, i.e., 16.7° Celsius as was written in the previous unacknowledged setpoint write operation above. Note that additionally the complete priority array (for BACnet datapoints) as it was before this setpoint write operation is returned in the last log message. This lets you determine the last state of the datapoint before your setpoint. In this example, the setpoint at priority 16 will take over and our office would be heated to a comfy 22.5 °C. However, since this was a dry run, the setpoint at priority 15 (16.7 °C) remains active.

Please carefully choose which setpoints to write when you are operating on a real building. To avoid overwriting existing setpoints, use the dryrun feature to determine the current state of the targeted datapoint before writing anything to it.

Having inspected the state of the datapoint and decided that we really want to reset it, we now switch the dryrun flag to False and repeat the above operation. The answer will look almost completely the same as above except that the logs will not indicate a dry run anymore.

### Creating schedules¶

Schedules are the generalization of setpoints. They allow you to specify multiple setpoints that are written at predefined points in time. And, schedules will automatically clean-up after themselves, i.e., reset the written datapoint to the same state it was in before the schedule, if you let them.

A new schedule is created through the POST /v2/datapoint/schedule endpoint. The caller must identify the datapoint in the query and provide the details of the schedule as a JSON object in the body of the request:

Parameter Datatype Type Required Description Example
project_id integer query yes The numeric id of the project. 1
dataPointID string query yes The alphanumeric id of the datapoint on which to create the schedule. bacnet100-4120-Real-room-temperature-setpoint-RTs_real
name string body (JSON) no A human readable name for this schedule. Weekend_override
resetValue integer body (JSON) no The value to write when the schedule finishes or fails. Uses existing value before schedule, if not provided. null
priority integer body (JSON) no The priority at which to write to the datapoint (default = 13). 15
repeat string body (JSON) no Repeat interval of this schedule. One of 'hourly', 'daily', 'weekly', 'monthly', or 'yearly'. Coming soon. 'weekly'
heartbeat integer body (JSON) no Duration in seconds after which the schedule deletes itself if no heartbeat is received. 60
setpoints list of dict body (JSON) yes A list of setpoints. Each setpoint is defined by a unique id, a start time, and a value. [{'id':0, 'start':'2018-11-09T18:00:00Z', 'value':'18.5'}, {'id':1, 'start':'2018-11-12T7:00:00Z', 'value':'21.0'}]

The different options for defining a schedule deserve some more explanation. The example schedule in the above table realizes a very simple weekend override for the office temperature in winter. In detail, it would do the following:

• Operate on datapoint bacnet100-4120-Real-room-temperature-setpoint-RTs_real of project 1 at priority 15.
• Start on 2018-11-09T18:00h Z (a Friday afternoon) by setting the desired room temperature to 18.5°C (to save energy when no one is in on the weekend).
• Continue on 2018-12-11T07:00 Z (a Monday morning) by setting the desired room temperature to 21.0°C (to provide thermal comfort during work hours).
• Repeat this simple schedule weekly.
• If no heartbeat is received for 60 seconds, stop the schedule and reset the desired temperature to null thereby letting the existing automation regain control.

Let's post the request and inspect the answer. Note that we'll leave out the repeat feature because it is not supported yet and also leave out an explicit resetValue so that it is determined automatically.

project_id = 1
dataPointID = "bacnet100-4120-Real-room-temperature-setpoint-RTs_real"
schedule = {
"name": "Weekend_override",
"priority": 15,
"heartbeat": 60,
"setpoints": [
{"id": 0, "start": "2018-11-09T18:00:00Z", "value": "18.5"},
{"id": 1, "start": "2018-11-12T07:00:00Z", "value": "21.0"}
]
}
r = requests.post(f"{api_url}/v2/datapoint/schedule",
auth=auth_john,
params={"dataPointID": dataPointID, "project_id": project_id},
json=schedule)
print(r.text)


curl "https://api.aedifion.io/v2/datapoint/schedule?dataPointID=bacnet100-4120-Real-room-temperature-setpoint-RTs_real&project_id=1" -X POST -u john.doe@aedifion.com:mys3cr3tp4ssw0rd -H 'Content-Type: application/json' -d '{ "name": "Weekend_override", "priority": 15, "heartbeat": 60, "setpoints": [ {"id": 0, "start": "2018-11-09T18:00:00Z", "value": "18.5"}, {"id": 1, "start": "2018-11-12T07:00:00Z", "value": "21.0"}
] }'

1. Point your browser to https://api.aedifion.io/ui/.
3. From the main tags (Meta, Company, ...) select the Datapoint tag, then the POST /v2/datapoint/schedule endpoint (yellow).
4. Provide the dataPointID, project_id and the schedule.
5. Click "Try it out!".
6. Inspect the response body and code.

When this request is posted to the API, the API will check (among permissions) the syntactic correctness of the request and that no other schedule is active on the same datapoint and priority. If the request is accepted by the API, it is sent to the Edge Device in the building network. It is important to note that the API returns immediately after sending the schedule to the Edge Device, i.e., without waiting for a confirmation from the remote device. Instead, the Edge Device will asynchronously update the schedule's status on the API at a later point. Creation of schedules is asynchronous because it requires one round of communication with the Edge Device that may be subject to delay and intermittent connectivity that would heavily slow down or even break synchronous operation.

The reply from the API is similar to the following:

{
"success": true,
"operation": "create",
"resource": {
"name": "Weekend_override",
"status": "initialized",
"datapoint_id": 127,
"priority": 15,
"heartbeat": 60,
"log": "[{\"msg\": \"Schedule created by user.\", \"status\": \"initialized\", \"time\": \"2018-11-08T13:37:40.819719Z\"}]",
"setpoints": [
{
"id": 0,
"start": "2018-11-09T18:00:00Z",
"value": "18.5"
},
{
"id": 1,
"start": "2018-11-12T07:00:00Z",
"value": "21"
}
]
}
}


The answer confirms that the schedule has been created and provides further details that deserve a detailed explanation.

• The status of the schedule is in state initialized meaning that the schedule has been accepted by the API and sent to the Edge Device in the building network (c.f. Overview). The Edge Device may still reject the schedule, e.g., if the requested datapoint is non-writable.
• The answer contains a reference to this schedule that can be used with the GET /v2/datapoint/schedule/{reference} endpoint to retrieve information about the state of the schedule at a later time. This is necessary since schedules operate on the Edge Device in the building asynchronously from the aedifion.io platform and API (c.f. Overview).
• The answer further contains a JSON-formatted log which is filled by the API and Edge Device with any notable events concerning this schedule. The log is a list of events where each event notes at least the status of the schedule, a human readable message msg, and the time of the event.

### Querying schedules¶

When a setpoint is created or executed, the Edge Device updates the schedule's status on the API on each major event, e.g., on activation, on writing a setpoint from the schedule, and any kind of error. It is the user's responsibility to check the status of his/her schedule continuously. To this end, the GET /v2/datapoint/schedule/{reference} can be used to which the caller must only provide a single argument:

Parameter Datatype Type Required Description Example
reference string path yes The alphanumeric id of the schedule returned on creation. 18f86b8a-1669-49da-adc3-e171c8e4e229

In the following, we get the schedule but print only its log for the sake of clarity.

import json

def printLog(schedule):
print("Log:")
for event in log:
print(f" -> {event['time']} - {event['status']:11s} {event['msg']}")

r = requests.get(f"{api_url}/v2/datapoint/schedule/{reference}", auth=auth_john)
schedule = r.json()
printLog(schedule)

curl "https://api.aedifion.io/v2/datapoint/schedule/18f86b8a-1669-49da-adc3-e171c8e4e229"
-X GET
-u john.doe@aedifion.com:mys3cr3tp4ssw0rd

1. Point your browser to https://api.aedifion.io/ui/.
3. From the main tags (Meta, Company, ...) select the Datapoint tag, then the GET /v2/datapoint/schedule/{reference} endpoint (blue).
4. Provide the reference value.
5. Click "Try it out!".
6. Inspect the response body and code.
Log:
-> 2018-11-27T13:37:40.819719Z - initialized Schedule created by user.
-> 2018-11-27T13:37:41.448276Z - active      Schedule successfully activated on remote logger.


Note how a second item has been appended to the log, i.e., the confirmation from the Edge Device that the schedule has been accepted and activated. If we wait for a minute, we will see two more events being appended to the log:

Log:
-> 2018-11-27T13:37:40.819719Z - initialized Schedule created by user.
-> 2018-11-27T13:37:41.448276Z - active     Schedule successfully activated on remote logger.
-> 2018-11-27T13:38:41.588739Z - active     Successfully wrote setpoint (id=reset, value=null, priority = 15).
-> 2018-11-27T13:38:41.809271Z - failed     Deletion of schedule on missing heartbeat (2 setpoints deleted before execution).


What happened? We set the heartbeat for this schedule to 60 seconds but didn't send any heartbeats. Exactly 60 seconds after activating this schedule, the Edge Device thus cancelled this schedule by

• writing the reset value (null in our case) which needs to be done since we could have written setpoints before, then
• cancelling all remaining scheduled setpoints, and, finally,
• notifying the API about the failure of this schedule.

This schedule has now reached End-of-Life: We could query it again and again but nothing would change anymore and attempts to update or delete this schedule will be rejected.

### Updating and modifying schedules¶

Since our first test schedule timed-out, let's create a second with a much higher heartbeat of 600 seconds on which we can calmly try our updates. Please note down the returned reference, e.g., in this example: 18f86b8a-1669-49da-adc3-e171c8e4e229. Go on and GET the schedule to make sure that it has actually been accepted and now is active.

All schedules that are not in state failed or terminated (such as our second test schedule) can be updated and modified through the PUT /v2/datapoint/schedule/{reference} endpoint with the following parameters:

Parameter Datatype Type Required Description Example
reference string path yes The alphanumeric id of the schedule to modify. 18f86b8a-1669-49da-adc3-e171c8e4e229
name string body (JSON) no The new name for the schedule. Modified_Weekend_override
resetValue string body (JSON) no The new reset value of this schedule. 21
heartbeat integer body (JSON) no Duration in seconds after which the schedule deletes itself if no heartbeat is received. 120
setpoints_add list of dict body (JSON) no A list of new setpoints to add to the schedule. If a new setpoint has the same id as an existing setpoint, the update is rejected. [
setpoints_modify list of dict body (JSON) no A list of existing setpoints to modify identified by their id. If a setpoint from this list does not exist, the update is rejected. [
setpoints_delete list of dict body (JSON) no A list of existing setpoints to delete identified by their id. If a setpoint from this list does not exist, the update is rejected. [

Let's post this update which changes the schedule's name, its reset value and heartbeat, adds one setpoint, modifies two setpoints, and deletes the newly added setpoint.

reference = '18f86b8a-1669-49da-adc3-e171c8e4e229' # from create
update_schedule = {
'name': 'Modified_Weekend_override',
'resetValue': '21',
'heartbeat': 120,
{'id':2, 'start':'2018-11-12T09:00:00Z', 'value':'20'}
],
'setpoints_modify': [
{'id':0, 'start':'2018-11-09T19:00:00Z', 'value':'17'},
{'id':1, 'start':'2018-11-12T08:00:00Z', 'value':'22'}]
],
'setpoints_delete': [
{'id':2, 'start':'2018-11-12T09:00:00Z', 'value':'20'}
]
}

r = requests.put(f"{api_url}/v2/datapoint/schedule/{reference}",
auth=auth_john,
json=update_schedule)
print(r.status_code, r.json())


Order of updates: Updates of setpoints are processed in the following order:

1. New setpoints are added from setpoints_add.
2. Setpoints in setpoints_modify are modified accordingly.
3. Setpoints in setpoints_delete are removed.

This order of applying updates means that one could add a new setpoint, modify it, and delete it within in the same update operation (although this evidently does not make much sense).

### Deleting schedules¶

Any schedule that is not terminated or failed can be stopped through the DELETE /v2/datapoint/schedule/{reference} endpoint which takes a single argument:

Parameter Datatype Type Required Description Example
reference string path yes The alphanumeric id of the schedule returned on creation. 18f86b8a-1669-49da-adc3-e171c8e4e229
reference = '18f86b8a-1669-49da-adc3-e171c8e4e229'
r = requests.delete(f"{api_url}/v2/datapoint/schedule/{reference}")
print(r.status_code, r.json())

curl 'https://api.aedifion.io/v2/datapoint/schedule/18f86b8a-1669-49da-adc3-e171c8e4e229'
-X DELETE
-u john.doe@aedifion.com:mys3cr3tp4ssw0rd

1. Point your browser to https://api.aedifion.io/ui/.
3. From the main tags (Meta, Company, ...) select the Datapoint tag, then the DELETE /v2/datapoint/schedule/{reference} endpoint (blue).
4. Provide the reference value.
5. Click "Try it out!".
6. Inspect the response body and code.

On success, the API will return the deleted schedule in the resource field of the answer. After deletion, the schedule is either in state finished or terminated and can still be queried through the GET /v2/datapoint/schedule/{reference} endpoint, but cannot be modified or executed anymore.

{
"operation": "delete",
"resource": {
"datapoint_id": 127,
"heartbeat": 3600,
"log": "[{\"msg\": \"Schedule created by user.\", \"status\": \"initialized\", \"time\": \"2018-11-27T15:10:44.662878Z\"}, {\"msg\": \"Schedule successfully activated on remote logger.\", \"status\": \"active\", \"time\": \"2018-11-27T15:10:45.315786Z\"}, {\"msg\": \"User triggered DELETE /v2/datapoint/schedule/\", \"status\": \"stopping\", \"time\": \"2018-11-27T15:55:38.145546Z\"}]",
"name": "Modified_Weekend_override",
"priority": 15,
"setpoints": [
{
"id": 0,
"start": "2018-11-09T19:00:00Z",
"value": "17"
},
{
"id": 1,
"start": "2018-11-12T08:00:00Z",
"value": "22"
}
],
"status": "stopping"
},
"success": true
}


Note that the status of the schedule is now reported as stopping. The reason is that, similar to the creation of a schedule, the API will forward the delete request to the Edge Device then return immediately. Just as everything about schedules, deletion is asynchronous and the caller should thus GET the schedule a short time after issuing the delete in order to verify that everything worked out as expected.

## Limitations and caveats¶

Adding, modifying, deleting setpoints in the past

Updating a running schedule, it is not allowed to add, modify, or delete setpoints that lie in the past in order to prevent inconsistent states. To account for potential communication delays between the API and the Edge Device, an additional security margin of 60 seconds into the future is enforced. In other words, all setpoints that are added, modified, or deleted within an update, must have a start time that is at least 60 seconds into the future.

Deleting stop events

The time-wise last setpoint in a schedule is referred to as the stop event. The value that it writes is left in the system. In the 99% of cases, this means that defining reset as the value of the time-wise last setpoint is the right choice as this will write the value that was written for this datapoint and priority before the schedule went active.

However, when the stop event $$s_n$$ is deleted, the latest (time-wise) remaining setpoint $$s_i$$ automatically becomes the new stop event, including its original value $$v_i$$. Similarly, when a setpoint $$s_m$$ with $$t_m > t_n$$ is added $$s_m$$ automatically becomes the new stop event, including its original value $$v_m$$. If $$v_i$$ (or $$v_m$$) is something other than reset the system might be unintentionally left in a different state after the schedule than expected by the user.

The bottom line is that the user must take care while adding, modifying, and deleting setpoints from a schedule that the last (time-wise) setpoint writes a value that "correctly" resets the system. Again, usually reset will be the right choice of value for the stop event.

## Planned features¶

The following features will be released soon.

• Pausing and un-pausing a running schedule through the additional endpoint PUT /v2/datapoint/schedule/{reference}/toggle
• ASAP execution of setpoints in fresh schedules.

Missing a feature? Request it!

## FAQ¶

What happens if the Edge Device loses internet connection?
Since all current schedules are replicated on the Edge Device, all schedules continue running without any interruption. However, the Edge Device can no longer receive heartbeats from the API. Thus, all schedules with a heartbeat will eventually time-out and then be safely reset.

What happens when the Edge Device crashes?
All schedules (and their state) are persisted in a local database on the harddrive of the Edge Device. The Edge Device is set to automatically reboot when it crashes and will reload and reactivate all running schedules (as long as the HD is intact). This process takes no more than one minute. As everything, crash events and subsequent reloads are logged to the API.

Why can't I add, modify, or delete setpoints of running schedules that lie in the past?
The short answer: We do our very best, but what's past is past and nobody can change it.
The long answer: While there may be valid use cases for adding, modifying, or deleting setpoints with a start time in the past, this is deliberately prevented for different reasons: First, there are no intuitive well-defined semantics for changing setpoints in the present that have already been written in the past -- altering the past would almost certainly result in a state of the system that is different to what the user expects. Second, all actions are logged on the API and this log should be an exact transcript of all written setpoints -- adding, modifying, and deleting setpoints in the past would render this log inconsistent with the actual course of events.

My setpoint or schedule seems to have no effect!
A setpoint or schedule operation will have no effect if the data point has already an active value, i.e., a value that is not null, written at a higher priority.

I cannot write at priority higher than 8!
In order to preserve life safety mechanism, the API will generally refuse to write at priorities higher than 8 (= manual operator). Higher priorities can be unlocked on request to support@aedifion.com and require written consent.

What are stop events?
We refer to the time-wise last element $$s_n$$ in a schedule as the stop event. The stop event defines the state the data point is left in after the schedule has finished. In 99% of the use cases, a user would choose $$v_n=$$ 'reset' which instructs the system to clean up and reset to the initial state (automatically determined before writing anything) after finishing with the schedule. However, a user may set $$v_n$$ to other values to change a system's state before the schedule does so, if this is explicitly desired.

Last update: