Scinap Sinapse API 0.0.1
The SCINAP API allows you to manage the Sinapse IoT HUB
| URL |
Scheme |
Description |
| soporte-tecnico.bitnamiapp.com:{port} |
mqtt |
Sinapse Broker hosted in soporte-tecnico bitnami machine
|
| Name |
Default value |
Possible values |
Description |
| port |
1883
|
|
Secure connection (TLS) is available through port 8883.
|
|
| Type |
In |
Name |
Scheme |
Format |
Description |
| apiKey |
user |
|
|
|
Provide your API key as the user and leave the password empty.
|
Message
Device send a payload through SPI Interface to peripheral
The IoT device receives this message and then transmit the received payload to the SPI interface indicated in the message.
The SPI return a response and this content is sent as a payload into the response message (721;).
If LOCATE is true, then the response message contains also the GPS location.
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
321;{SPI};{PAYLOAD_SPI};{FORMAT};{LOCATE}; |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"SPI": "1",
"PAYLOAD_SPI": "string",
"FORMAT": "HEX",
"LOCATE": "1"
}
Tags
Message
Device send periodically a payload through SPI Interface to peripheral
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
322;{SPI};{PAYLOAD_SPI};{FORMAT};${PERIOD_SPI};{LOCATE}; |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| PERIOD_SPI |
|
string
|
|
|
Indicates the sampling period in seconds |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"SPI": "1",
"PAYLOAD_SPI": "string",
"FORMAT": "HEX",
"PERIOD_SPI": "string",
"LOCATE": "1"
}
Tags
Message
Configuration of the UART indicated in the payload
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
130;{UART};{BAUDRATE};{DF};{SB};{PAR}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| BAUDRATE |
|
string
|
|
|
Baudrate of the UART |
| DF |
|
string
|
|
|
Data format in bits |
| SB |
|
string
|
|
|
Indicates if the UART works with stop bit or not |
| PAR |
|
string
|
|
|
Indicates if the parity is odd (0) or even (1) |
Example of payload (generated)
{
"command": "string",
"UART": "1",
"BAUDRATE": "string",
"DF": "string",
"SB": "1",
"PAR": "1"
}
Tags
Message
Device send a payload through UART Interface to peripheral
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
323;{UART};{PAYLOAD_UART};{FORMAT};{LOCATE}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"UART": "1",
"PAYLOAD_UART": "string",
"FORMAT": "HEX",
"LOCATE": "1"
}
Tags
Message
Device send AT Command to selected transceiver internally
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
300;{DEVICE_AT};{PAYLOAD_AT}; |
| DEVICE_AT |
|
string
|
|
|
Peripheral managed with AT commands. 0 = Quectel, 1 = USR WIFI, 2 = HI-LINK WIFI, 3 = USR BLUETOOTH |
| PAYLOAD_AT |
|
string
|
|
|
Payload to be sent internally to a communication device. The string can contains ASCII characters (Plain text) |
Example of payload (generated)
{
"command": "string",
"DEVICE_AT": "0",
"PAYLOAD_AT": "string"
}
Tags
Message
Device send periodically a payload through UART Interface to peripheral
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
324;{UART};{PAYLOAD_UART};{FORMAT};${PERIOD_UART};{LOCATE}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| PERIOD_UART |
|
string
|
|
|
Indicates the sampling period in seconds |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"UART": "1",
"PAYLOAD_UART": "string",
"FORMAT": "HEX",
"PERIOD_UART": "string",
"LOCATE": "1"
}
Tags
Message
Set static value for PWM
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
317;{DC};{FREQ}; |
| DC |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
Example of payload (generated)
{
"command": "string",
"DC": "string",
"FREQ": "string"
}
Tags
Message
Set static value for PWM periodically. There is a maximum of 10 steps. If any step is not needed set its parameters to -1
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
318;{DC_0};{TIME_0};{DC_1};{TIME_1};{DC_2};{TIME_2};{DC_3};{TIME_3};{DC_4};{TIME_4};{DC_5};{TIME_5};{DC_6};{TIME_6};{DC_7};{TIME_7};{DC_8};{TIME_8};{DC_9};{TIME_9};{FREQ};{NTIMES}; |
| DC_0 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_0 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_1 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_1 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_2 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_2 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_3 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_3 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_4 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_4 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_5 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_5 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_6 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_6 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_7 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_7 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_8 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_8 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_9 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_9 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
| NTIMES |
|
string
|
|
|
Number of times to perform a given schedule. -1 means always |
Example of payload (generated)
{
"command": "string",
"DC_0": "string",
"TIME_0": "string",
"DC_1": "string",
"TIME_1": "string",
"DC_2": "string",
"TIME_2": "string",
"DC_3": "string",
"TIME_3": "string",
"DC_4": "string",
"TIME_4": "string",
"DC_5": "string",
"TIME_5": "string",
"DC_6": "string",
"TIME_6": "string",
"DC_7": "string",
"TIME_7": "string",
"DC_8": "string",
"TIME_8": "string",
"DC_9": "string",
"TIME_9": "string",
"FREQ": "string",
"NTIMES": "string"
}
Tags
Message
Response that contains the payload sent by the asked SPI
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
721;{ID};{SPI};{PAYLOAD_SPI_R};{FORMAT};{LAT};{LONG};{TIMESTAMP}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example of payload (generated)
{
"command": "string",
"ID": "string",
"SPI": "1",
"PAYLOAD_SPI_R": "string",
"FORMAT": "HEX",
"LAT": "string",
"LONG": "string",
"TIMESTAMP": "string"
}
Tags
Message
Response that contains the payload sent by the asked UART
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
723;{ID};{UART};{PAYLOAD_UART_R};{FORMAT};{LAT};{LONG};{TIMESTAMP}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example of payload (generated)
{
"command": "string",
"ID": "string",
"UART": "1",
"PAYLOAD_UART_R": "string",
"FORMAT": "HEX",
"LAT": "string",
"LONG": "string",
"TIMESTAMP": "string"
}
Tags
Message
Response that contains the payload sent by the asked DEVICE managed with AT commands
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
700;{ID};{PAYLOAD_AT_R}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| PAYLOAD_AT_R |
|
string
|
|
|
Payload sent as response to a question to a peripheral managed with AT commands. The string can contains ASCII characters (Plain text) |
Example of payload (generated)
{
"command": "string",
"ID": "string",
"PAYLOAD_AT_R": "string"
}
Tags
Message
Response to actuation over PWM
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
717; |
Example of payload (generated)
{
"command": "string"
}
Tags
Device send a payload through SPI Interface to peripheral
The IoT device receives this message and then transmit the received payload to the SPI interface indicated in the message.
The SPI return a response and this content is sent as a payload into the response message (721;).
If LOCATE is true, then the response message contains also the GPS location.
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
321;{SPI};{PAYLOAD_SPI};{FORMAT};{LOCATE}; |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"SPI": "1",
"PAYLOAD_SPI": "string",
"FORMAT": "HEX",
"LOCATE": "1"
}
Device send periodically a payload through SPI Interface to peripheral
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
322;{SPI};{PAYLOAD_SPI};{FORMAT};${PERIOD_SPI};{LOCATE}; |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| PERIOD_SPI |
|
string
|
|
|
Indicates the sampling period in seconds |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"SPI": "1",
"PAYLOAD_SPI": "string",
"FORMAT": "HEX",
"PERIOD_SPI": "string",
"LOCATE": "1"
}
Configuration of the UART indicated in the payload
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
130;{UART};{BAUDRATE};{DF};{SB};{PAR}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| BAUDRATE |
|
string
|
|
|
Baudrate of the UART |
| DF |
|
string
|
|
|
Data format in bits |
| SB |
|
string
|
|
|
Indicates if the UART works with stop bit or not |
| PAR |
|
string
|
|
|
Indicates if the parity is odd (0) or even (1) |
Example of payload (generated)
{
"command": "string",
"UART": "1",
"BAUDRATE": "string",
"DF": "string",
"SB": "1",
"PAR": "1"
}
Device send a payload through UART Interface to peripheral
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
323;{UART};{PAYLOAD_UART};{FORMAT};{LOCATE}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"UART": "1",
"PAYLOAD_UART": "string",
"FORMAT": "HEX",
"LOCATE": "1"
}
Device send periodically a payload through UART Interface to peripheral
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
324;{UART};{PAYLOAD_UART};{FORMAT};${PERIOD_UART};{LOCATE}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| PERIOD_UART |
|
string
|
|
|
Indicates the sampling period in seconds |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example of payload (generated)
{
"command": "string",
"UART": "1",
"PAYLOAD_UART": "string",
"FORMAT": "HEX",
"PERIOD_UART": "string",
"LOCATE": "1"
}
Device send AT Command to selected transceiver internally
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
300;{DEVICE_AT};{PAYLOAD_AT}; |
| DEVICE_AT |
|
string
|
|
|
Peripheral managed with AT commands. 0 = Quectel, 1 = USR WIFI, 2 = HI-LINK WIFI, 3 = USR BLUETOOTH |
| PAYLOAD_AT |
|
string
|
|
|
Payload to be sent internally to a communication device. The string can contains ASCII characters (Plain text) |
Example of payload (generated)
{
"command": "string",
"DEVICE_AT": "0",
"PAYLOAD_AT": "string"
}
Set static value for PWM
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
317;{DC};{FREQ}; |
| DC |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
Example of payload (generated)
{
"command": "string",
"DC": "string",
"FREQ": "string"
}
Set static value for PWM periodically. There is a maximum of 10 steps. If any step is not needed set its parameters to -1
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
318;{DC_0};{TIME_0};{DC_1};{TIME_1};{DC_2};{TIME_2};{DC_3};{TIME_3};{DC_4};{TIME_4};{DC_5};{TIME_5};{DC_6};{TIME_6};{DC_7};{TIME_7};{DC_8};{TIME_8};{DC_9};{TIME_9};{FREQ};{NTIMES}; |
| DC_0 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_0 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_1 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_1 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_2 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_2 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_3 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_3 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_4 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_4 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_5 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_5 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_6 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_6 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_7 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_7 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_8 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_8 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_9 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_9 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
| NTIMES |
|
string
|
|
|
Number of times to perform a given schedule. -1 means always |
Example of payload (generated)
{
"command": "string",
"DC_0": "string",
"TIME_0": "string",
"DC_1": "string",
"TIME_1": "string",
"DC_2": "string",
"TIME_2": "string",
"DC_3": "string",
"TIME_3": "string",
"DC_4": "string",
"TIME_4": "string",
"DC_5": "string",
"TIME_5": "string",
"DC_6": "string",
"TIME_6": "string",
"DC_7": "string",
"TIME_7": "string",
"DC_8": "string",
"TIME_8": "string",
"DC_9": "string",
"TIME_9": "string",
"FREQ": "string",
"NTIMES": "string"
}
Response that contains the payload sent by the asked SPI
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
721;{ID};{SPI};{PAYLOAD_SPI_R};{FORMAT};{LAT};{LONG};{TIMESTAMP}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example of payload (generated)
{
"command": "string",
"ID": "string",
"SPI": "1",
"PAYLOAD_SPI_R": "string",
"FORMAT": "HEX",
"LAT": "string",
"LONG": "string",
"TIMESTAMP": "string"
}
Response that contains the payload sent by the asked UART
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
723;{ID};{UART};{PAYLOAD_UART_R};{FORMAT};{LAT};{LONG};{TIMESTAMP}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example of payload (generated)
{
"command": "string",
"ID": "string",
"UART": "1",
"PAYLOAD_UART_R": "string",
"FORMAT": "HEX",
"LAT": "string",
"LONG": "string",
"TIMESTAMP": "string"
}
Response that contains the payload sent by the asked DEVICE managed with AT commands
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
700;{ID};{PAYLOAD_AT_R}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| PAYLOAD_AT_R |
|
string
|
|
|
Payload sent as response to a question to a peripheral managed with AT commands. The string can contains ASCII characters (Plain text) |
Example of payload (generated)
{
"command": "string",
"ID": "string",
"PAYLOAD_AT_R": "string"
}
Response to actuation over PWM
TODO
Payload
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
717; |
Example of payload (generated)
{
"command": "string"
}
spiOD
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
321;{SPI};{PAYLOAD_SPI};{FORMAT};{LOCATE}; |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example (generated)
{
"command": "string",
"SPI": "1",
"PAYLOAD_SPI": "string",
"FORMAT": "HEX",
"LOCATE": "1"
}
spiP
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
322;{SPI};{PAYLOAD_SPI};{FORMAT};${PERIOD_SPI};{LOCATE}; |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| PERIOD_SPI |
|
string
|
|
|
Indicates the sampling period in seconds |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example (generated)
{
"command": "string",
"SPI": "1",
"PAYLOAD_SPI": "string",
"FORMAT": "HEX",
"PERIOD_SPI": "string",
"LOCATE": "1"
}
uartC
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
130;{UART};{BAUDRATE};{DF};{SB};{PAR}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| BAUDRATE |
|
string
|
|
|
Baudrate of the UART |
| DF |
|
string
|
|
|
Data format in bits |
| SB |
|
string
|
|
|
Indicates if the UART works with stop bit or not |
| PAR |
|
string
|
|
|
Indicates if the parity is odd (0) or even (1) |
Example (generated)
{
"command": "string",
"UART": "1",
"BAUDRATE": "string",
"DF": "string",
"SB": "1",
"PAR": "1"
}
uartOD
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
323;{UART};{PAYLOAD_UART};{FORMAT};{LOCATE}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example (generated)
{
"command": "string",
"UART": "1",
"PAYLOAD_UART": "string",
"FORMAT": "HEX",
"LOCATE": "1"
}
uartP
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
324;{UART};{PAYLOAD_UART};{FORMAT};${PERIOD_UART};{LOCATE}; |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| PERIOD_UART |
|
string
|
|
|
Indicates the sampling period in seconds |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example (generated)
{
"command": "string",
"UART": "1",
"PAYLOAD_UART": "string",
"FORMAT": "HEX",
"PERIOD_UART": "string",
"LOCATE": "1"
}
transpATOD
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
300;{DEVICE_AT};{PAYLOAD_AT}; |
| DEVICE_AT |
|
string
|
|
|
Peripheral managed with AT commands. 0 = Quectel, 1 = USR WIFI, 2 = HI-LINK WIFI, 3 = USR BLUETOOTH |
| PAYLOAD_AT |
|
string
|
|
|
Payload to be sent internally to a communication device. The string can contains ASCII characters (Plain text) |
Example (generated)
{
"command": "string",
"DEVICE_AT": "0",
"PAYLOAD_AT": "string"
}
setPwmOD
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
317;{DC};{FREQ}; |
| DC |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
Example (generated)
{
"command": "string",
"DC": "string",
"FREQ": "string"
}
setPwmP
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
318;{DC_0};{TIME_0};{DC_1};{TIME_1};{DC_2};{TIME_2};{DC_3};{TIME_3};{DC_4};{TIME_4};{DC_5};{TIME_5};{DC_6};{TIME_6};{DC_7};{TIME_7};{DC_8};{TIME_8};{DC_9};{TIME_9};{FREQ};{NTIMES}; |
| DC_0 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_0 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_1 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_1 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_2 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_2 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_3 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_3 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_4 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_4 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_5 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_5 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_6 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_6 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_7 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_7 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_8 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_8 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| DC_9 |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
| TIME_9 |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
| NTIMES |
|
string
|
|
|
Number of times to perform a given schedule. -1 means always |
Example (generated)
{
"command": "string",
"DC_0": "string",
"TIME_0": "string",
"DC_1": "string",
"TIME_1": "string",
"DC_2": "string",
"TIME_2": "string",
"DC_3": "string",
"TIME_3": "string",
"DC_4": "string",
"TIME_4": "string",
"DC_5": "string",
"TIME_5": "string",
"DC_6": "string",
"TIME_6": "string",
"DC_7": "string",
"TIME_7": "string",
"DC_8": "string",
"TIME_8": "string",
"DC_9": "string",
"TIME_9": "string",
"FREQ": "string",
"NTIMES": "string"
}
spiM
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
721;{ID};{SPI};{PAYLOAD_SPI_R};{FORMAT};{LAT};{LONG};{TIMESTAMP}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
| PAYLOAD_SPI_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example (generated)
{
"command": "string",
"ID": "string",
"SPI": "1",
"PAYLOAD_SPI_R": "string",
"FORMAT": "HEX",
"LAT": "string",
"LONG": "string",
"TIMESTAMP": "string"
}
uartM
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
723;{ID};{UART};{PAYLOAD_UART_R};{FORMAT};{LAT};{LONG};{TIMESTAMP}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
| PAYLOAD_UART_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example (generated)
{
"command": "string",
"ID": "string",
"UART": "1",
"PAYLOAD_UART_R": "string",
"FORMAT": "HEX",
"LAT": "string",
"LONG": "string",
"TIMESTAMP": "string"
}
transpATD
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
700;{ID};{PAYLOAD_AT_R}; |
| ID |
|
string
|
|
|
ID of the IoT device |
| PAYLOAD_AT_R |
|
string
|
|
|
Payload sent as response to a question to a peripheral managed with AT commands. The string can contains ASCII characters (Plain text) |
Example (generated)
{
"command": "string",
"ID": "string",
"PAYLOAD_AT_R": "string"
}
setPwmD
| Name |
Title |
Type |
Format |
Default |
Description |
| command |
|
string
|
|
|
717; |
Example (generated)
{
"command": "string"
}
SPI
| Name |
Title |
Type |
Format |
Default |
Description |
| SPI |
|
string
|
|
|
ID of the SPI interface of the commboard |
Example (generated)
"1"
UART
| Name |
Title |
Type |
Format |
Default |
Description |
| UART |
|
string
|
|
|
ID of the UART interface of the commboard |
Example (generated)
"1"
PAYLOAD
| Name |
Title |
Type |
Format |
Default |
Description |
| PAYLOAD |
|
string
|
|
|
Payload to be sent through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
Example (generated)
"string"
PAYLOAD_AT
| Name |
Title |
Type |
Format |
Default |
Description |
| PAYLOAD_AT |
|
string
|
|
|
Payload to be sent internally to a communication device. The string can contains ASCII characters (Plain text) |
Example (generated)
"string"
PAYLOAD_R
| Name |
Title |
Type |
Format |
Default |
Description |
| PAYLOAD_R |
|
string
|
|
|
Payload sent as response to a question through an interface like SPI, UART, I2C, etc. The string can contains binary, decimal, hexadecimal or ASCII characters |
Example (generated)
"string"
PAYLOAD_AT_R
| Name |
Title |
Type |
Format |
Default |
Description |
| PAYLOAD_AT_R |
|
string
|
|
|
Payload sent as response to a question to a peripheral managed with AT commands. The string can contains ASCII characters (Plain text) |
Example (generated)
"string"
FORMAT
| Name |
Title |
Type |
Format |
Default |
Description |
| FORMAT |
|
string
|
|
|
Indicates the format of the payload |
Example (generated)
"HEX"
LOCATE
| Name |
Title |
Type |
Format |
Default |
Description |
| LOCATE |
|
string
|
|
|
Indicates if a location should be sent in the response |
Example (generated)
"1"
PERIOD
| Name |
Title |
Type |
Format |
Default |
Description |
| PERIOD |
|
string
|
|
|
Indicates the sampling period in seconds |
Example (generated)
"string"
BAUDRATE
| Name |
Title |
Type |
Format |
Default |
Description |
| BAUDRATE |
|
string
|
|
|
Baudrate of the UART |
Example (generated)
"string"
DF
| Name |
Title |
Type |
Format |
Default |
Description |
| DF |
|
string
|
|
|
Data format in bits |
Example (generated)
"string"
SB
| Name |
Title |
Type |
Format |
Default |
Description |
| SB |
|
string
|
|
|
Indicates if the UART works with stop bit or not |
Example (generated)
"1"
PAR
| Name |
Title |
Type |
Format |
Default |
Description |
| PAR |
|
string
|
|
|
Indicates if the parity is odd (0) or even (1) |
Example (generated)
"1"
ID
| Name |
Title |
Type |
Format |
Default |
Description |
| ID |
|
string
|
|
|
ID of the IoT device |
Example (generated)
"string"
LAT
| Name |
Title |
Type |
Format |
Default |
Description |
| LAT |
|
string
|
|
|
GPS latitude of the IoT device in the moment of the message generation |
Example (generated)
"string"
LONG
| Name |
Title |
Type |
Format |
Default |
Description |
| LONG |
|
string
|
|
|
GPS longitude of the IoT device in the moment of the message generation |
Example (generated)
"string"
TIMESTAMP
| Name |
Title |
Type |
Format |
Default |
Description |
| TIMESTAMP |
|
string
|
|
|
Timestamp of the message generation |
Example (generated)
"string"
DEVICE_AT
| Name |
Title |
Type |
Format |
Default |
Description |
| DEVICE_AT |
|
string
|
|
|
Peripheral managed with AT commands. 0 = Quectel, 1 = USR WIFI, 2 = HI-LINK WIFI, 3 = USR BLUETOOTH |
Example (generated)
"0"
DC
| Name |
Title |
Type |
Format |
Default |
Description |
| DC |
|
string
|
|
|
Duty cycle of PWM signal. Is a percentage from 0% to 100% |
Example (generated)
"string"
FREQ
| Name |
Title |
Type |
Format |
Default |
Description |
| FREQ |
|
string
|
|
|
Frequency of a signal in KHz |
Example (generated)
"string"
TIME
| Name |
Title |
Type |
Format |
Default |
Description |
| TIME |
|
string
|
|
|
Hour:Minute when an action should be executed. The format is HH:MM |
Example (generated)
"string"
NTIMES
| Name |
Title |
Type |
Format |
Default |
Description |
| NTIMES |
|
string
|
|
|
Number of times to perform a given schedule. -1 means always |
Example (generated)
"string"