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.

Sign up for GitHub

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

Clarify that API reflects underlying Device always, not just at start-up #65

Open
wants to merge 2 commits into
base: v1.0.x
Choose a base branch
from
Open

Clarify that API reflects underlying Device always, not just at start-up #65

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3015252
Clarify that API reflects underlying Device always, not just at start-up
garethsb Sep 25, 2024
bfb45ad
Explain current channel mapping behaviour vs. activation
garethsb Sep 25, 2024
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
4 changes: 3 additions & 1 deletion docs/Behaviour.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ _(c) AMWA 2018, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_

## Start-Up Behaviour

This specification does not define the channel mapping behaviour at start-up, as this may depend on the nature of the Device the API is controlling. However, it is important that the channel mapping behaviour of the underlying Device is reflected in the API at start-up.
This specification does not define the channel mapping behaviour at start-up, as this may depend on the nature of the Device the API is controlling. It is important that the API always reflects the current channel mapping behaviour of the underlying Device.

## Interaction with Other Protocols

Expand Down Expand Up @@ -228,6 +228,8 @@ See the [Timestamps](#Timestamps) section for more details on the required inter

Once an activation has been completed the resulting changes to the map MUST be reflected in the `active` endpoint. The `activation` object in the `active` endpoint MUST contain the details of the last activation to have taken place.

Changes to the underlying Device's channel mapping behaviour (whether initiated by IS-08 or not) are reflected immediately into the Active Map `map`. Therefore the action of the most recent `activation` (or any previous activation) can have been overwritten. The only certain way to determine if the current behaviour is what the Client requires is to examine the `map`.

#### Activation Responses

Each successful activation request is allocated a unique identifier by the API. This identifier MUST be unique within an API instance and for all time.
Expand Down