Skip to content

Commit

Permalink
feat: Device functions ADR
Browse files Browse the repository at this point in the history
Remove contradictory text on function names, add SDK responsibilities

Signed-off-by: Iain Anderson <[email protected]>
  • Loading branch information
iain-anderson committed Dec 20, 2021
1 parent d447dba commit ba10442
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs_src/design/adr/device-service/0021-invoking-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ this is unintuitive.
}
```

Note: the `attributes` structure is analagous to `attributes` in a `deviceResource`. Each device service should document and implement a scheme of required attributes that will allow for selection of the relevant funtion. The function's `name` is intended for UI and logging purposes and should not be used for actual function selection on the device.
Note: the `attributes` structure is analagous to `attributes` in a `deviceResource`. Each device service should document and implement a scheme of required attributes that will allow for selection of the relevant funtion.

**Define MessageBus topics on which function call requests and replies are to be made**

Expand Down Expand Up @@ -102,9 +102,11 @@ or if a call fails
|--------|--------
| 0 | The operation was successful
| 1 | Parameters were missing, out of range or non-parsable
| 2 | The Device is DOWN or DISABLED
| 2 | The Device is DOWN or DISABLED (OperatingState / AdminState)
| 3 | No such device or function
| 100+ | Implementation-specific errors, defined for each Device Service

** The device SDKs will provide an API for the service implementations to implement these operations **
** Device SDK enhancement **

The device SDKs will handle the messagebus communcations and parameter marshalling. The generic errors defined above may be detected in this SDK code. The SDKs will define APIs for the individual device services to implement the function invocations.

0 comments on commit ba10442

Please sign in to comment.