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

Fix errors in README.md. #102

Merged
merged 1 commit into from
Nov 30, 2020
Merged
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
37 changes: 10 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
- "register": LwM2M Register
- "update": LwM2M Update
- "data" contains the query options and the object-list of the register message
- The *update* message is only published if the object-list changed.

### Downlink Command and Uplink Response (LwM2M Device Management & Service Enablement Interface)

Expand Down Expand Up @@ -113,6 +114,7 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
"path": {?ResourcePath}
}
```
- {?ResourcePath}: String, LwM2M full resource path. e.g. "3/0", "/3/0/0", "/3/0/6/0"
- **If {?MsgType} = "write" (single write)**:
```json
{
Expand All @@ -121,6 +123,8 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
"value": {?Value}
}
```
- {?ValueType}: String, can be: "Time", "String", "Integer", "Float", "Boolean", "Opaque", "Objlnk"
- {?Value}: Value of the resource, depends on "type".
- **If {?MsgType} = "write" (batch write)**:
```json
{
Expand Down Expand Up @@ -183,21 +187,6 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
}
```
- {?ObjectInstanceID}: Integer, LwM2M Object Instance ID
- {?ResourcePath}: String, LwM2M full resource path. e.g. "3/0", "/3/0/0", "/3/0/6/0"
- {?Content}:
```json
[
{
"name": {?ResourceName},
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
}
]
```
- {?ResourceName}: String, LwM2M resource description, e.g. "Available Power Sources"
- {?ValueType}: String, can be: "Time", "String", "Integer", "Float", "Boolean", "Opaque", "Objlnk"
- {?Value}: Value of resource, depends on the {?ValueType}.

- **The response of LwM2M will be converted to following MQTT message:**
- **Method:** PUBLISH
Expand Down Expand Up @@ -262,17 +251,11 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
```json
[
{
"name": {?ResourceName},
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
}
]
```
- {?ResourceName}: String, LwM2M resource description, e.g. "Available Power Sources"
- {?ResourcePath}: String, LwM2M resource full path. e.g. "3/0", "/3/0/0", "/3/0/6/0"
- {?ValueType}: String, can be: "Time", "String", "Integer", "Float", "Boolean", "Opaque", "Objlnk"
- {?Value}: Value of the resource, depends on "type".

- **If {?MsgType} = "ack", "data" does not exists**

Expand Down Expand Up @@ -308,11 +291,10 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
"data": {
"code": {?StatusCode},
"codeMsg": {?CodeMsg},
"reqPath": {?RequestPath},
"content": [
{
"name": {?ResourceName},
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
}
]
Expand All @@ -338,11 +320,12 @@ The MQTT message will be translated to an LwM2M DISCOVER command and sent to the
"data": {
"code": {?StatusCode},
"codeMsg": {?CodeMsg},
"reqPath": {?RequestPath},
"content": [
"name": {?ResourceName},
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
{
"path": {?ResourcePath},
"value": {?Value}
}
]
}
}
Expand Down