Skip to content

Commit 403c9ff

Browse files
authored
Refresh docs (#369)
* Refresh docs * Also add builtins * update examples * Remove builtins from plugins without JSON-RPC
1 parent 8d020a7 commit 403c9ff

File tree

14 files changed

+2875
-988
lines changed

14 files changed

+2875
-988
lines changed

DeviceIdentification/doc/DeviceIdentificationPlugin.md

Lines changed: 75 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- Generated automatically, DO NOT EDIT! -->
2-
<a name="head.Device_Identification_Plugin"></a>
2+
<a id="head_Device_Identification_Plugin"></a>
33
# Device Identification Plugin
44

55
**Version: 1.0.0**
@@ -12,24 +12,25 @@ DeviceIdentification interface for Thunder framework.
1212

1313
### Table of Contents
1414

15-
- [Introduction](#head.Introduction)
16-
- [Description](#head.Description)
17-
- [Properties](#head.Properties)
15+
- [Introduction](#head_Introduction)
16+
- [Description](#head_Description)
17+
- [Methods](#head_Methods)
18+
- [Properties](#head_Properties)
1819

19-
<a name="head.Introduction"></a>
20+
<a id="head_Introduction"></a>
2021
# Introduction
2122

22-
<a name="head.Scope"></a>
23+
<a id="head_Scope"></a>
2324
## Scope
2425

25-
This document describes purpose and functionality of the DeviceIdentification interface (version 1.0.0). It includes detailed specification about its properties provided.
26+
This document describes purpose and functionality of the DeviceIdentification interface (version 1.0.0). It includes detailed specification about its methods and properties provided.
2627

27-
<a name="head.Case_Sensitivity"></a>
28+
<a id="head_Case_Sensitivity"></a>
2829
## Case Sensitivity
2930

3031
All identifiers of the interfaces described in this document are case-sensitive. Thus, unless stated otherwise, all keywords, entities, properties, relations and actions should be treated as such.
3132

32-
<a name="head.Acronyms,_Abbreviations_and_Terms"></a>
33+
<a id="head_Acronyms,_Abbreviations_and_Terms"></a>
3334
## Acronyms, Abbreviations and Terms
3435

3536
The table below provides and overview of acronyms used in this document and their definitions.
@@ -47,7 +48,7 @@ The table below provides and overview of terms and abbreviations used in this do
4748
| :-------- | :-------- |
4849
| <a name="term.callsign">callsign</a> | The name given to an instance of a plugin. One plugin can be instantiated multiple times, but each instance the instance name, callsign, must be unique. |
4950

50-
<a name="head.References"></a>
51+
<a id="head_References"></a>
5152
## References
5253

5354
| Ref ID | Description |
@@ -57,12 +58,70 @@ The table below provides and overview of terms and abbreviations used in this do
5758
| <a name="ref.JSON">[JSON](http://www.json.org/)</a> | JSON specification |
5859
| <a name="ref.Thunder">[Thunder](https://github.com/WebPlatformForEmbedded/Thunder/blob/master/doc/WPE%20-%20API%20-%20Thunder.docx)</a> | Thunder API Reference |
5960

60-
<a name="head.Description"></a>
61+
<a id="head_Description"></a>
6162
# Description
6263

6364
DeviceIdentification JSON-RPC interface.
6465

65-
<a name="head.Properties"></a>
66+
<a id="head_Methods"></a>
67+
# Methods
68+
69+
The following methods are provided by the DeviceIdentification interface:
70+
71+
Built-in methods:
72+
73+
| Method | Description |
74+
| :-------- | :-------- |
75+
| [exists](#method_exists) | Checks if a JSON-RPC method or property exists |
76+
77+
<a id="method_exists"></a>
78+
## *exists [<sup>method</sup>](#head_Methods)*
79+
80+
Checks if a JSON-RPC method or property exists.
81+
82+
### Description
83+
84+
This method will return *True* for the following methods/properties: *deviceidentification, exists*.
85+
86+
### Parameters
87+
88+
| Name | Type | M/O | Description |
89+
| :-------- | :-------- | :-------- | :-------- |
90+
| params | object | mandatory | *...* |
91+
| params.method | string | mandatory | Name of the method or property to look up |
92+
93+
### Result
94+
95+
| Name | Type | M/O | Description |
96+
| :-------- | :-------- | :-------- | :-------- |
97+
| result | boolean | mandatory | Denotes if the method exists or not |
98+
99+
### Example
100+
101+
#### Request
102+
103+
```json
104+
{
105+
"jsonrpc": "2.0",
106+
"id": 42,
107+
"method": "<callsign>.1.exists",
108+
"params": {
109+
"method": "deviceidentification"
110+
}
111+
}
112+
```
113+
114+
#### Response
115+
116+
```json
117+
{
118+
"jsonrpc": "2.0",
119+
"id": 42,
120+
"result": false
121+
}
122+
```
123+
124+
<a id="head_Properties"></a>
66125
# Properties
67126

68127
The following properties are provided by the DeviceIdentification interface:
@@ -71,10 +130,10 @@ DeviceIdentification interface properties:
71130

72131
| Property | R/W | Description |
73132
| :-------- | :-------- | :-------- |
74-
| [deviceidentification](#property.deviceidentification) | read-only | Get device paltform specific information |
133+
| [deviceidentification](#property_deviceidentification) | read-only | Get device paltform specific information |
75134

76-
<a name="property.deviceidentification"></a>
77-
## *deviceidentification [<sup>property</sup>](#head.Properties)*
135+
<a id="property_deviceidentification"></a>
136+
## *deviceidentification [<sup>property</sup>](#head_Properties)*
78137

79138
Provides access to the get device paltform specific information.
80139

@@ -103,7 +162,7 @@ Provides access to the get device paltform specific information.
103162
{
104163
"jsonrpc": "2.0",
105164
"id": 42,
106-
"method": "DeviceIdentification.1.deviceidentification"
165+
"method": "<callsign>.1.deviceidentification"
107166
}
108167
```
109168

0 commit comments

Comments
 (0)