Skip to content

Commit ba10442

Browse files
committed
feat: Device functions ADR
Remove contradictory text on function names, add SDK responsibilities Signed-off-by: Iain Anderson <[email protected]>
1 parent d447dba commit ba10442

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs_src/design/adr/device-service/0021-invoking-functions.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ this is unintuitive.
5858
}
5959
```
6060

61-
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.
61+
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.
6262

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

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

109-
** The device SDKs will provide an API for the service implementations to implement these operations **
109+
** Device SDK enhancement **
110+
111+
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.
110112

0 commit comments

Comments
 (0)