Service Agreement
Register and login
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Sign Up | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Sign in | ||||
| Request description | ||||
| token | User's APIToken | |||
| infotype | fixed to "register" | |||
| Ifno | User's APIToken | |||
| Send a message | ||||
| { "token": "API_001", "infotype": "register", "info": "" } | ||||
| Response JSON data format | ||||
| { "infotype": "register", "info": "OK", "token": "" } { "infotype": "untoken", "info": "Please log in again" } | ||||
Get individual device status
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Get individual device status | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Get the status of a single device, which is the cached data of the server; To get the latest status, you need to call the request update command in 1.4.4. Verify whether it is the latest state, which can be judged by the timestamp. | ||||
| Request description | ||||
| infotype | Fixed to damread | |||
| info | Fixed Fields | |||
| unid | is the unique ID of the requested device | |||
| Request Format | ||||
| { "token":"API_0011", "infotype": "damread", "info": { "unid": "JY9220351854ALLR" } } | ||||
| Response JSON data format | ||||
| { "infotype": "damread", "info": { "name": "Agricultural Greenhouse (32A)1", "unid": "JY9220351854ALLR", "AI":Array[16], "AO": [], "DI": [ { "t": 1641279994271, "io": 0, "name": "DI1", "value": false, "alarm": false }, { "t": 1641279994271, "io": 1, "name": "DI2", "value": false, "alarm": false }, { "t": 1641279994271, "io": 15, "name": "DI16", "value": true, "alarm": false } ], "DO": [ { "t": 1641279994271, "io": 0, "name": "Fan 1#", "value": true }, { "t": 1641279994271, "io": 1, "name": "Fan 2#", "value": true }, { "t": 1641279994271, "io": 31, "name": "Lower Roll Film 2#Off", "value": false } ] } } | ||||
Get the status of all devices under the account
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Get individual device status | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Get all device status | ||||
| Request description | ||||
| infotype | Fixed to damreadall | |||
| Example Body Section | ||||
| { "token":"API_0011", "infotype": "damreadall", "info": "" } | ||||
| Response JSON data format | ||||
| { "infotype": "damreadall", "info": [ { "name": "Agricultural Greenhouse (32A)1", "unid": "JY9220351854ALLR", "AI": [ { "t": 1641280155749, "io": 0, "name": "Air Temperature", "unit": "℃", "value": 0, "alarm": false }, { "t": 1641280155749, "io": 1, "name": "Air Humidity", "unit": "%", "value": 0, "alarm": false }, { "t": 1641280155749, "io": 2, "name": "Soil Moisture", "unit": "%", "value": 0, "alarm": false }, { "t": 1641280155749, "io": 3, "name": "Soil Temperature", "unit": "℃", "value": 0, "alarm": false } ], "AO": [], "DI": [ { "t": 1641280174443, "io": 0, "name": "DI1", "value": false, "alarm": false }, { "t": 1641280174443, "io": 1, "name": "DI2", "value": false, "alarm": false }, { "t": 1641280174443, "io": 2, "name": "DI3", "value": false, "alarm": false } ], "DO": [ { "t": 1641280174443, "io": 0, "name": "Fan 1#", "value": true }, { "t": 1641280174443, "io": 1, "name": "Fan 2#", "value": true }, { "t": 1641280174443, "io": 2, "name": "Volume opened", "value": true } ] } ] } | ||||
Read Status
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Read Status | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Read Status Register read support for DO DI AI AO. | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Support rdo,rdi,rai,rao operations | |||
| unid | is the unique ID of the requested device | |||
| regstart | The starting address of the register accessed, starts from 1 by default. | |||
| regnum | Number of registers accessed, depending on the device model. | |||
| rdo | Read DO status | |||
| rdi | Read status of DI | |||
| rai | Read AI state | |||
| rao | Read AO status | |||
| Read DO status: example Body section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "rdo", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| Read DO Status: Response JSON Data Format | ||||
| { "infotype": "damopr", "info": "Manual operation: RDO [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 1, "regstart": -1, "regnum": 2, "vbyte": "AAA=", "strinfo": "0101020000B9FC", "RqDly": 0 } } | ||||
| Read DI Status: Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "rdi", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| Read DI Status: Response JSON Data Format | ||||
| { "info": "Manual operation: RDI [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 2, "regstart": -1, "regnum": 2, "vbyte": "AAA=", "strinfo": "0102020000B9B8", "RqDly": 0 } } | ||||
| Read AI Status: Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "rai", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| Read AI Status: Response JSON Data Format | ||||
| { "infotype": "damopr", "info": "Manual operation: RAI [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 4, "regstart": 0, "regnum": 10, "vbyte": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=", "strinfo": "0104140000000000000000000000000000000000000009581", "RqDly": 0 } } | ||||
| Read AO status: example Body section | ||||
| { "token": "API_001", "infotype": "damopr", "info": { "opr": "rao", "unid": "JY9220351854ALLR", "regstart": 1, "regnum": 10 } } | ||||
| Read AO Status: Response JSON Data Format | ||||
| { "infotype": "damopr", "info": "Manual operation: RAO [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 3, "regstart": 0, "regnum": 10, "vbyte": "AAAAAAAAAAAACgAAAAAAAAAAAAA=", "strinfo": "0103140000000000000000000A0000000000000000000082BF", "RqDly": 0 } } | ||||
[Relay operation]Close all channels
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Close all channels | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| [Relay Operation] Turns off all channels. After controlling the relay, it will actively push the real-time data of the device. | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to aclose | |||
| unid | is the unique ID of the requested device | |||
| Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "aclose", "unid": "JY9220351854ALLR" } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: ACLOSE [JY9220351854ALLR] 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 15, "regstart": 0, "regnum": 32, "vbyte": null, "strinfo": "010F000000205413", "RqDly": 0 } } | ||||
[Relay operation]Close a channel
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Close a channel relay | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Close a channel relay. After controlling the relay, it will actively push the real-time data of the device. | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to close | |||
| unid | is the unique ID of the requested device | |||
| io | Controlled channel. 1 is the first relay channel 2 is the second relay channel | |||
| Example Body Section | ||||
| { "token":"API_0011", "infotype": "damopr", "info": { "opr": "close", "unid": "JY9220351854ALLR", "io": 1 } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: CLOSE [JY9220351854ALLR] 1 30000", "token": "" } | ||||
[Relay Operation] Turn off after a period of time
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Turn off after a period of time | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay, turn off after a period of time. After controlling the relay, it will actively push the real-time data of the device. (requires change postback enabled) | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to closeone | |||
| unid | is the unique ID of the requested device | |||
| io | Controlled channel. 1 is the first relay channel 2 is the second relay channel | |||
| diy | The delay time controlled by, the unit is 0.1 seconds; Value range: 1-65000 | |||
| Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "closeone", "unid": "JY9220351854ALLR", "io": 1, "dly": 10 } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: CLOSEONE [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 16, "regstart": 3, "regnum": 2, "vbyte": null, "strinfo": "011000030002B1C8", "RqDly": 0 } } | ||||
[Relay Operation]Open all channels
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Open all channels | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operates the relay to turn on all channels. After controlling the relay, it will actively push the real-time data of the device. | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to aopen | |||
| unid | is the unique ID of the requested device | |||
| Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "aopen", "unid": "JY9220351854ALLR", } } | ||||
| Response JSON data format | ||||
| { "info": "Manual operation: AOPEN [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 15, "regstart": 0, "regnum": 32, "vbyte": null, "strinfo": "010F000000205413", "RqDly": 0 } } | ||||
[Relay operation]Open a channel
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Open a channel | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay to open a channel. | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "open", "unid": "JY9220351854ALLR", "io": 1, } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: OPENONE [JY9220351854ALLR] 1_10 30000", "token": "" } | ||||
[Relay Operation] Turns on for a while and then turns off
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| After opening for a while close | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay, open for a period of time and then close. After controlling the relay, it will actively push the real-time data of the device. (requires change postback enabled) | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to openone | |||
| unid | is the unique ID of the requested device | |||
| io | Controlled channel. 1 is the first relay channel 2 is the second relay channel | |||
| dly | Control delay time, the unit is 0.1 seconds; Value range: 1-65000 | |||
| Example Body Section | ||||
| { "token":"API_001", "infotype": "damopr", "info": { "opr": "openone", "unid": "JY9220351854ALLR", "io": 1, "dly": 10 } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: OPENONE [JY9220351854ALLR] 1_10 30000", "token": "" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 16, "regstart": 3, "regnum": 2, "vbyte": null, "strinfo": "011000030002B1C8", "RqDly": 0 } } | ||||
[Relay operation]Multi-channel operation
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Multi-channel operation | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operation relay, multi-channel operation. After the operation is completed, the data will be actively pushed. | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to wdo | |||
| unid | is the unique ID of the requested device | |||
| regstart | The starting channel of thecontrol. 1 is from the first relay channel 2 is from the second relay channel | |||
| doinfo | Relay control status group, supports multiple Value meaning: 0 means off 1 means open 2 means ignore the operation 0211 means that the 1st channel is closed, the 2nd channel is ignored, the 3rd channel is open, and the 4th channel is open. | |||
| Example Body Section | ||||
| { "token": "API_001", "infotype": "damopr", "info": { "opr": "wdo", "unid": "JY9220351854ALLR", "regstart": 1, "doinfo": [ 0, 2, 1, 1 ] } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: WDO [JY9220351854ALLR] 1_0211 30000", "token": "" } | ||||
[Holding register operation]Write operation
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Write Holding Registers | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Write Holding Register | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to wao | |||
| unid | is the unique ID of the requested device | |||
| regstart | Start register for control. To operate such registers, please refer to the relevant register descriptions in the manual. | |||
| aoinfos | 16-bit integer array representing the written data content. | |||
| Example Body Section | ||||
| { "token": "API_0011", "infotype": "damopr", "info": { "opr": "wao", "unid": "JY9220351854ALLR", "regstart": 1, "aoinfo": [ 10, 1000 ] } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: WAO [JY9220351854ALLR] 1__10_1000 30000" } | ||||
[Holding register operation]Write operation Hex
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Write Holding Registers | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Write holding registers in HEX format (hold) | ||||
| Request description | ||||
| infotype | Fixed to damopr | |||
| info | Fixed Fields | |||
| opr | Fixed to waohex | |||
| unid | is the unique ID of the requested device | |||
| regstart | Start register for control. To operate such registers, please refer to the relevant register descriptions in the manual. | |||
| aoinfos | A string of hexadecimal data. | |||
| Example Body Section | ||||
| { "token": "API_0011", "infotype": "damopr", "info": { "opr": "waohex", "unid": "JY9220351854ALLR", "regstart": 1, "aoinfos": "000A03E8" } } | ||||
| Response JSON data format | ||||
| { "infotype": "damopr", "info": "Manual operation: WAOHEX [JY9220351854ALLR] 1_000A03E8 30000" } { "infotype": "ModbusReg", "sn": "JY9220351854ALLR", "info": { "teamsn": "JY9220351854ALLR", "sn": "JY9220351854ALLR", "addr": 1, "code": 16, "regstart": 0, "regnum": 2, "vbyte": null, "strinfo": "01100000000241C8", "RqDly": 0 } } | ||||
[Lora operation]Read communication parameters
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Turn off after a period of time | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay, turn off after a period of time | ||||
| Request description | ||||
| Example Body section | ||||
| Response JSON data format | ||||
[Lora operation]Read working parameters
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Turn off after a period of time | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay, turn off after a period of time | ||||
| Request description | ||||
| Example Body section | ||||
| Response JSON data format | ||||
[Lora operation]Write communication parameters
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Turn off after a period of time | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay, turn off after a period of time | ||||
| Request description | ||||
| Example Body section | ||||
| Response JSON data format | ||||
[Lora operation]Write working parameters
| Name | version number | Date created | Last Update | Status |
|---|---|---|---|---|
| Turn off after a period of time | 1.0 | 2021/12/30 | 2021/12/30 | Definition |
| Description | ||||
| Operate the relay, turn off after a period of time | ||||
| Request description | ||||
| Example Body section | ||||
| Response JSON data format | ||||
Mail：service@juyingele.com
Tel：010-82899827/1 4006688400
Add: 412, Block B, Jinyu Jiahua Building, Shangdi, Beijing
android
IOS
Copyright © 2021 Beijing Juying Aoxiang Electronics Co., Ltd. All rights reserved