Commit 82854de7 authored by Rostislav Spinar's avatar Rostislav Spinar

Update standards in BN and SC, reworked OTA API

parent 14b12a00
......@@ -50,7 +50,7 @@
"type": "array",
"description": "Supported standards by the device.",
"items": {
"type": "integer"
"type": "string"
}
},
"osRead": {
......
{
"$schema": "http://apidocs.iqrfsdk.org/iqrf-gateway-daemon/com.iqrftech.self-desc/schema/jsonschema/1-0-0#",
"self": {
"vendor": "com.iqrftech.self-desc",
"name": "iqmeshNetwork_OtaUpload-request",
"format": "jsonschema",
"version": "1-0-0"
},
"type": "object",
"properties": {
"mType": {
"type": "string",
"description": "IQMESH Network management - Upload hex or iqrf file request.",
"enum": [
"iqmeshNetwork_OtaUpload"
]
},
"data": {
"type": "object",
"properties": {
"msgId": {
"type": "string",
"description": "Message identification for binding request with response."
},
"repeat": {
"type": "integer",
"description": "Number of repetitions of DPA messages.",
"default": 1
},
"req": {
"type": "object",
"properties": {
"deviceAddr": {
"type": "integer",
"description": "Device address to write the hex or iqrf file."
},
"fileName": {
"type": "string",
"description": "Full name of file with source code to load."
},
"startMemAddr": {
"type": "integer",
"description": "Start address on which will be the data saved into memory."
},
"loadingAction": {
"type": "string",
"description": "Loading action - WithoutCodeLoading, WithCodeLoading."
}
},
"required": [
"deviceAddr",
"fileName",
"startMemAddr",
"loadingAction"
]
},
"returnVerbose": {
"type": "boolean",
"description": "Flag that includes additional parameters in the response."
}
},
"required": [
"msgId",
"req"
]
}
},
"required": [
"mType",
"data"
]
"$schema": "http://apidocs.iqrfsdk.org/iqrf-gateway-daemon/com.iqrftech.self-desc/schema/jsonschema/1-0-0#",
"self": {
"vendor": "com.iqrftech.self-desc",
"name": "iqmeshNetwork_OtaUpload-request",
"format": "jsonschema",
"version": "1-0-0"
},
"type": "object",
"properties": {
"mType": {
"type": "string",
"description": "IQMESH Network management - Upload hex or iqrf file request.",
"enum": [
"iqmeshNetwork_OtaUpload"
]
},
"data": {
"type": "object",
"properties": {
"msgId": {
"type": "string",
"description": "Message identification for binding request with response."
},
"repeat": {
"type": "integer",
"description": "Number of repetitions of DPA messages.",
"default": 1
},
"req": {
"type": "object",
"properties": {
"deviceAddr": {
"type": "integer",
"description": "Device address to write the hex or iqrf file."
},
"hwpId": {
"type": "integer",
"description": "Hardware profile ID of the devices to write the hex or iqrf file."
},
"fileName": {
"type": "string",
"description": "Full name of file with source code to load."
},
"startMemAddr": {
"type": "integer",
"description": "Start address on which will be the data saved into memory."
},
"loadingAction": {
"type": "string",
"description": "Loading action - WithoutCodeLoading, WithCodeLoading."
}
},
"required": [
"deviceAddr",
"fileName",
"startMemAddr",
"loadingAction"
]
},
"returnVerbose": {
"type": "boolean",
"description": "Flag that includes additional parameters in the response."
}
},
"required": [
"msgId",
"req"
]
}
},
"required": [
"mType",
"data"
]
}
\ No newline at end of file
{
"$schema": "http://apidocs.iqrfsdk.org/iqrf-gateway-daemon/com.iqrftech.self-desc/schema/jsonschema/1-0-0#",
"self": {
"vendor": "com.iqrftech.self-desc",
"name": "iqmeshNetwork_OtaUpload-response",
"format": "jsonschema",
"version": "1-0-0"
},
"type": "object",
"properties": {
"mType": {
"type": "string",
"description": "IQMESH Network management - Upload hex or iqrf file response.",
"enum": [
"iqmeshNetwork_OtaUpload"
]
},
"data": {
"type": "object",
"properties": {
"msgId": {
"type": "string",
"description": "Message identification for binding request with response."
},
"rsp": {
"type": "object",
"description": "Returns following values, see its description.",
"properties": {
"deviceAddr": {
"type": "integer",
"description": "Device address to write the configuration to. Broadcast address is also allowed."
},
"writeSuccess": {
"type": "boolean",
"description": "If sets, then selected file has been successfully loaded."
}
},
"required": [
"deviceAddr",
"writeSuccess"
]
},
"raw": {
"type": "array",
"description": "Returns array of objects req-cnf-rsp, see its description.",
"items": {
"type": "object",
"properties": {
"request": {
"type": "string",
"description": "Binary buffer with DPA request."
},
"requestTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
},
"confirmation": {
"type": "string",
"description": "Binary buffer with DPA confirmation."
},
"confirmationTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
},
"response": {
"type": "string",
"description": "Binary buffer with DPA response."
},
"responseTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
}
},
"required": [
"request",
"requestTs",
"confirmation",
"confirmationTs",
"response",
"responseTs"
]
}
},
"insId": {
"type": "string",
"description": "IQRF GW daemon instance identification."
},
"status": {
"type": "integer",
"description": "IQRF GW daemon API (general or mType) status."
},
"statusStr": {
"type": "string",
"description": "IQRF GW daemon API (general or mType) status in string form."
}
},
"required": [
"msgId",
"status"
]
}
},
"required": [
"mType",
"data"
]
"$schema": "http://apidocs.iqrfsdk.org/iqrf-gateway-daemon/com.iqrftech.self-desc/schema/jsonschema/1-0-0#",
"self": {
"vendor": "com.iqrftech.self-desc",
"name": "iqmeshNetwork_OtaUpload-response",
"format": "jsonschema",
"version": "1-0-0"
},
"type": "object",
"properties": {
"mType": {
"type": "string",
"description": "IQMESH Network management - Upload hex or iqrf file response.",
"enum": [
"iqmeshNetwork_OtaUpload"
]
},
"data": {
"type": "object",
"properties": {
"msgId": {
"type": "string",
"description": "Message identification for binding request with response."
},
"rsp": {
"type": "object",
"description": "Returns following values, see its description.",
"properties": {
"deviceAddr": {
"type": "integer",
"description": "Device address to load the code to. Broadcast address is also allowed."
},
"hwpId": {
"type": "integer",
"description": "Hardware profile ID of the devices to write the hex or iqrf file."
},
"loadingAction": {
"type": "string",
"description": "Loading action - WithoutCodeLoading, WithCodeLoading."
},
"uploadResult": {
"type": "boolean",
"description": "If sets, then selected file has been successfully loaded."
},
"verifyResult": {
"type": "array",
"description": "Returns result of verify action.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "integer",
"description": "Device address."
},
"result": {
"type": "boolean",
"description": "Result."
}
},
"required": [
"address",
"result"
],
"maxItems": 239
}
},
"loadResult": {
"type": "array",
"description": "Returns result of verify action.",
"items": {
"type": "object",
"properties": {
"address": {
"type": "integer",
"description": "Device address."
},
"result": {
"type": "boolean",
"description": "Result."
}
},
"required": [
"address",
"result"
],
"maxItems": 239
}
}
},
"required": [
"deviceAddr",
"hwpId",
"loadingAction"
]
},
"raw": {
"type": "array",
"description": "Returns array of objects req-cnf-rsp, see its description.",
"items": {
"type": "object",
"properties": {
"request": {
"type": "string",
"description": "Binary buffer with DPA request."
},
"requestTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
},
"confirmation": {
"type": "string",
"description": "Binary buffer with DPA confirmation."
},
"confirmationTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
},
"response": {
"type": "string",
"description": "Binary buffer with DPA response."
},
"responseTs": {
"type": "string",
"description": "YYYY-MM-DDTHH:MM:SS.MS"
}
},
"required": [
"request",
"requestTs",
"confirmation",
"confirmationTs",
"response",
"responseTs"
]
}
},
"insId": {
"type": "string",
"description": "IQRF GW daemon instance identification."
},
"status": {
"type": "integer",
"description": "IQRF GW daemon API (general or mType) status."
},
"statusStr": {
"type": "string",
"description": "IQRF GW daemon API (general or mType) status in string form."
}
},
"required": [
"msgId",
"status"
]
}
},
"required": [
"mType",
"data"
]
}
\ No newline at end of file
......@@ -45,6 +45,13 @@
"product": {
"type": "string",
"description": "Product name."
},
"standards": {
"type": "array",
"description": "Supported standards by the device.",
"items": {
"type": "string"
}
},
"osRead": {
"type": "object",
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment