Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scheduler and layer documentation #3260

Open
wants to merge 1 commit into
base: docs/main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -317,3 +317,34 @@ The configuration will be created with the following schema:
Please note that the ``created-by`` label is used to identify the configuration created by the IoT Hub portal.

> For more information see [Automatic IoT device and module management](https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-automatic-device-management).

## Site management

### Layers

It is possible to define a hierarchical structure corresponding to the areas in which the sensors are installed. On each layer, one or more devices can be associated. These layers will then be used for planning and schedulers.

![alt text](images/layers.png)

> Note: As a layer can only refer to one planning (so one type of device model), only one type of devices should be linked to a layer.

### Planning

This functionality is designed to define commands to send to devices based on a schedule. A schedule can only be associated with a single device model, which allows you to obtain the list of available commands. A schedule must be linked to one or more layers with associated devices for the orders to be taken into account.

![alt text](images/planning.png)

> Note: When a layer is associated to a planning, all its children are automatically added too.

#### Planning parameters

- ``Name``: The ID of the device model.
- ``Device Model``: The name of the device model.
> Note: Available commands depend on the selected device model.
- ``Business Day``: Scheduled commands for business days.
- ``Off Day``: Scheduled command for off days.
- ``Date of application of this planning``: Start and end dates of validity of the planning.
- ``Select your application areas``: Treeview displaying the list of layers.
> Note: Layers can be created after planning, but the link between the two entities can only be made here.
>
> A layer can be associated to only one schedule.
1 change: 1 addition & 0 deletions docs/dev-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ Here are different settings that the user can configure:
* **Ideas__Authentication__Header**: (Optional, default value `Ocp-Apim-Subscription-Key`) Authentication header name.
* **Ideas__Authentication__Token**: Authentication token.
* **Job__SyncDatabaseJobRefreshIntervalInMinutes**: (Optional, default value `5`) The refresh interval in `minutes` to collect data from Azure IoT Hub (Devices, Iot Edge Devices...) and store them on the database of the Portal.
* **Job__SendCommandsToDevicesIntervalInMinutes**: (Optional, default value `10`) The interval in `minutes` to send scheduled commands to devices.

### Connection strings

Expand Down
6 changes: 6 additions & 0 deletions docs/dev-guide/migrations/v5-to-v6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Migrate from v5 to v6

In this new version, a site management has been added, giving the possibility to schedule commands to send to devices.

The following optional parameter has been added:
`Job__SendCommandsToDevicesIntervalInMinutes`: The interval in `minutes` to send scheduled commands to devices. Its default value is 10.
Binary file added docs/images/layers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/planning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ nav:
- 'Migrations':
- 'dev-guide/migrations/v3-to-v4.md'
- 'dev-guide/migrations/v4-to-v5.md'
- 'dev-guide/migrations/v5-to-v6.md'
- 'Project conception':
- 'dev-guide/conception/diagrams.md'
- Concepts: 'concepts.md'
Expand Down
Loading