Skip to Content

Changes for page 07 HTTP API

Last modified by Devin Chen on 2025/05/06 11:44
From version 16.1
edited by Mora Zhou
on 2023/12/22 10:06
Change comment: There is no comment for this version
To version 26.1
edited by Devin Chen
on 2025/05/06 11:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Mora
1 +XWiki.DevinChen
Content
... ... @@ -427,11 +427,12 @@
427 427  (% class="table-bordered" %)
428 428  |**acturl**|(% colspan="3" %)we-data/realcfgs
429 429  |**Functions**|(% colspan="3" %)Get the tags configuration information in the specified group in V-BOX.
430 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
430 +|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
431 431  |boxId|(% colspan="2" %)VBoxID(“None” means custom tags grouping)
432 432  |groupId|(% colspan="2" %)Group ID (Required)
433 433  |pageSize|(% colspan="2" %)Number of each page, 10 by default
434 434  |pageIndex|(% colspan="2" %)Number of current page, start from 1
435 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
435 435  |(% rowspan="15" %)**Return value**|Field name|(% colspan="2" %)Description
436 436  |(% rowspan="11" %)cfgList|monitorId|Tags ID
437 437  |monitorName|Tags name
... ... @@ -582,16 +582,21 @@
582 582  
583 583  == **Tags data list** ==
584 584  
586 +{{warning}}
587 +This API is not for getting the real-time data all the time.If you need to get the continuously updated real-time monitoring point data values,you need to use **[[Send switch to device>>https://docs.we-con.com.cn/bin/view/V-BOX/V-Net/Manual/6%20HTTP%20API/#HSendswitchtodevice]] **API with this API
588 +{{/warning}}
589 +
585 585  **~ {{id name="_Toc24963744"/}}Parameters**
586 586  
587 587  (% class="table-bordered" %)
588 588  |**acturl**|(% colspan="3" %)we-data/realdata
589 589  |**Functions**|(% colspan="3" %)Get the tags data in the specified group in V-BOX.
590 -|(% rowspan="5" %)**Parameters**|Parameter|(% colspan="2" %)Description
595 +|(% colspan="1" rowspan="6" %)**Parameters**|Parameter|(% colspan="2" %)Description
591 591  |boxId|(% colspan="2" %)VBoxID(“None” means custom tag grouping)
592 592  |groupId|(% colspan="2" %)Group ID (Required)
593 593  |pageSize|(% colspan="2" %)Number of each page, 10 by default
594 594  |pageIndex|(% colspan="2" %)Number of current page, start from 1
600 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
595 595  |(% rowspan="11" %)**Return value**|Field name|(% colspan="2" %)Description
596 596  |(% rowspan="7" %)List|(% colspan="2" %)Real-time data list
597 597  |com|Communication port ID
... ... @@ -706,9 +706,11 @@
706 706  (% class="table-bordered" %)
707 707  |**acturl**|(% colspan="2" %)we-data/updrealdata
708 708  |**Functions**|(% colspan="2" %)Modify tag data
709 -|(% rowspan="3" %)**Parameters**|Parameter|Description
715 +|(% rowspan="5" %)**Parameters**|Parameter|Description
716 +|boxId|Box ID
710 710  |monitorId|Tag ID
711 711  |value|value
719 +|devType|Device type (0:Box, 1:HMI)
712 712  |**Return value**|(% colspan="2" %)None
713 713  
714 714  **Operating procedures**
... ... @@ -720,25 +720,26 @@
720 720  
721 721  **Step2:** Set parameters on Params
722 722  
723 -"monitorId":"91541"
731 +boxId:6397578
732 +monitorId:1001
733 +value:66
734 +devType:1
724 724  
725 -"value":"60"
726 -
727 727  (% style="text-align:center" %)
728 -[[image:V-BOX HTTP manual_html_5a3153add75ca7b4.png||height="246" width="800" class="img-thumbnail"]]
737 +[[image:1746502882467-849.png]]
729 729  
730 730  **Step3:** Get sign
731 731  
732 -comid=2&compvtkey=589625dce895454dbff9782c299db156&monitorId=91541&sid=2d7bfd344aa64d8ebc9beea0e4dad8ad&ts=1573897380&value=60&key=f1cd9351930d4e589922edbcf3b09a7c
741 +boxId=6397578&comid=128&compvtkey=7e421dd30a394d74b7b9c079e67e272c&devType=1&monitorId=1001&sid=d8c98edd64da40289fef565c94924fe5&ts=171746501715435&value=66&key=f1cd9351930d4e589922edbcf3b09a7c
733 733  
734 -MD5 sign: 4119b1abc9176a187f781bece04a5296
743 +MD5 sign: 4802a362fde2ca5053ad79fe4d272200
735 735  
736 736  **Step4: **Set common of header
737 737  
738 -{"monitorId":"91541","value":"60","sid":"2d7bfd344aa64d8ebc9beea0e4dad8ad","comid":"2","compvtkey":"589625dce895454dbff9782c299db156","ts":"1573897380","sign":"4119b1abc9176a187f781bece04a5296"}
747 +{"compvtkey":"7e421dd30a394d74b7b9c079e67e272c","sign":"4802a362fde2ca5053ad79fe4d272200","comid":"128","sid":"d8c98edd64da40289fef565c94924fe5","ts":171746501715435}
739 739  
740 740  (% style="text-align:center" %)
741 -[[image:V-BOX HTTP manual_html_59d54a5d886ef614.png||height="244" width="700" class="img-thumbnail"]]
750 +[[image:1746503047845-902.png]]
742 742  
743 743  **Result**
744 744  
... ... @@ -755,9 +755,9 @@
755 755  }
756 756  
757 757  (% style="text-align:center" %)
758 -[[image:V-BOX HTTP manual_html_590c8dab9e80fd0f.png||height="425" width="700" class="img-thumbnail"]]
767 +[[image:1746503002289-932.png]]
759 759  
760 -== ** {{id name="_Toc24963751"/}}Historical tags name list** ==
769 +== **Historical tags name list** ==
761 761  
762 762  **Parameters**
763 763  
... ... @@ -764,8 +764,9 @@
764 764  (% class="table-bordered" %)
765 765  |**acturl**|(% colspan="3" %)we-data/monitors
766 766  |**Functions**|(% colspan="3" %)Get a list of historical tags
767 -|(% rowspan="2" %)**Parameters**|Parameter|(% colspan="2" %)Description
768 -|boxId|(% colspan="2" %)VBoxID (Not required)
776 +|(% rowspan="3" %)**Parameters**|Parameter|(% colspan="2" %)Description
777 +|boxId|(% colspan="2" %)Box ID (Not required)
778 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
769 769  |(% rowspan="4" %)**Return value**|Field name|(% colspan="2" %)Description
770 770  |(% rowspan="3" %)list|(% colspan="2" %)Tag list
771 771  |monitorId|tag ID
... ... @@ -841,7 +841,7 @@
841 841  (% style="text-align:center" %)
842 842  [[image:V-BOX HTTP manual_html_2a739377a9fb10b2.png||height="400" width="700" class="img-thumbnail"]]
843 843  
844 -== ** {{id name="_Toc24963755"/}}Historical tag data list** ==
854 +== **Historical tag data list** ==
845 845  
846 846  **~ {{id name="_Toc24963756"/}}Parameters**
847 847  
... ... @@ -968,7 +968,7 @@
968 968  (% class="table-bordered" %)
969 969  |**acturl**|(% colspan="3" %)we-data/alarmdata
970 970  |**Function**|(% colspan="3" %)Get alarm data
971 -|(% rowspan="9" %)**Parameters**|Parameter|(% colspan="2" %)Description
981 +|(% rowspan="10" %)**Parameters**|Parameter|(% colspan="2" %)Description
972 972  |boxId|(% colspan="2" %)VBoxID, (Required)
973 973  |monitorBeginTime|(% colspan="2" %)Monitoring start time, (Not required)
974 974  |monitorEndTime|(% colspan="2" %)Monitoring end time, (Not required)
... ... @@ -985,6 +985,7 @@
985 985  
986 986  (Not necessary)
987 987  )))
998 +|devType|(% colspan="2" %)Device type (0:Box, 1:HMI)
988 988  |(% rowspan="12" %)**Return value**|Field name|(% colspan="2" %)Description
989 989  |(% rowspan="8" %)List|(% colspan="2" %)Alarm data list
990 990  |monitorId|tag ID
1746502870811-166.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +36.4 KB
Content
1746502882467-849.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +36.4 KB
Content
1746503002289-932.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +20.3 KB
Content
1746503047845-902.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.DevinChen
Size
... ... @@ -1,0 +1,1 @@
1 +42.1 KB
Content