quercus SmartLoop TS Owner's manual

Software version 1.5.x
Firmware version 1.5.x
www.quercus.biz
www.quercus-technologies.com
www.quercus.com.br
Quercus Technologies
PROGRAMMING MANUAL
PROGRAMMING MANUAL

QuercusVL Programming Manual (v 1.5.0)
March 2014
© 2014 Quercus Technologies. All rights reserve .
This manual, including the information of the system described within the manual, is provided under a license and can
be solely use for the purposes escribe in the license. The contents of this manual are provi e for information
purposes only an can be mo ifie with no prior warning. The manual can not be fully or partially repro uce , place
in a istribution system or release to thir parties without the express permission of Quercus Technologies.
Quercus Technologies

Index
1. Intro uction..................................................................................14
2. Basic Programming........................................................................16
2.1. C++......................................................................................16
2.1.1. Memory management.........................................................18
2.1.2. Buil of executable.............................................................19
2.2. C...........................................................................................20
2.2.1. Memory management.........................................................22
2.2.2. Buil of executable.............................................................23
2.3. Other examples.......................................................................23
3. Reference Class.............................................................................24
3.1. Compatibility between QuercusVL® pro ucts...............................24
3.2. Hierarchy................................................................................26
3.3. Classes...................................................................................27
3.4. System Class .........................................................................27
3.4.1. Properties.........................................................................27
3.4.2. Metho s...........................................................................28
3.4.3. Events..............................................................................29
3.5. Units Class..............................................................................30
3.5.1. Properties.........................................................................30
3.6. Unit Class...............................................................................31
3.6.1. Properties.........................................................................31
3.6.2. Metho s...........................................................................34
3.7. UnitStatus Class.....................................................................38
3.7.1. Properties.........................................................................38
3.8. VersionInformation Class..........................................................39
3.8.1. Properties.........................................................................39
3.9. Detectors Class.......................................................................40
3.9.1. Properties.........................................................................40
3.10. Detector Class.......................................................................40
Quercus Technologies

3.10.1. Properties.......................................................................41
3.10.2. Metho s..........................................................................43
3.11. PresenceDetector Class...........................................................44
3.12. QueueDetector Class..............................................................44
3.13. Spee Detector Class...............................................................45
3.13.1. Properties.......................................................................45
3.14. Re LightDetector Class...........................................................46
3.14.1. Properties.......................................................................46
3.15. Class Stoppe CarDetector.......................................................48
3.15.1. Properties.......................................................................49
3.16. TrafficLights Class..................................................................50
3.16.1. Properties.......................................................................50
3.17. TrafficLight Class....................................................................51
3.17.1. Properties.......................................................................51
3.17.2. Metho s..........................................................................52
3.18. HistoricInci ences Class..........................................................53
3.18.1. Properties.......................................................................53
3.18.2. Metho s..........................................................................53
3.19. HistoricSummaries Class.........................................................55
3.19.1. Properties.......................................................................55
3.19.2. Metho s..........................................................................55
3.20. RealTimeInformation Class......................................................57
3.20.1. Properties.......................................................................57
3.20.2. Metho s..........................................................................59
3.21. Regions Class........................................................................59
3.21.1. Properties.......................................................................60
3.22. Region Class..........................................................................60
3.22.1. Properties.......................................................................60
3.22.2. Metho s..........................................................................62
3.23. Lights Class...........................................................................62
3.23.1. Properties.......................................................................62
3.24. Light Class............................................................................63
Quercus Technologies

3.24.1. Properties.......................................................................63
3.24.2. Metho s..........................................................................63
3.25. Inci ence Class......................................................................64
3.25.1. Properties.......................................................................64
3.25.2. Metho s..........................................................................67
3.26. Images Class.........................................................................67
3.26.1. Properties.......................................................................68
3.27. Image Class..........................................................................68
3.27.1. Properties.......................................................................68
3.27.2. Metho s..........................................................................69
3.28. Vi eo Class ..........................................................................69
3.28.1. Properties.......................................................................69
3.28.2. Metho s..........................................................................71
3.29. Summary Class......................................................................72
3.29.1. Properties.......................................................................72
3.29.2. Metho s..........................................................................77
3.30. Spee sDistribution Class.........................................................77
3.30.1. Properties.......................................................................77
3.31. LengthsDistribution Class........................................................78
3.31.1. Properties.......................................................................78
3.32. OccupationsDistribution Class..................................................79
3.32.1. Properties.......................................................................79
3.33. Spee sUpperLimit Class..........................................................79
3.33.1. Properties.......................................................................79
3.34. LengthsUpperLimit Class.........................................................80
3.34.1. Properties.......................................................................80
3.35. OccupationsUpperLimit Class...................................................81
3.35.1. Properties.......................................................................81
3.36. Timestamp Class....................................................................81
3.36.1. Properties.......................................................................81
3.37. Notification Class...................................................................82
3.37.1. Properties.......................................................................82
Quercus Technologies

3.38. Configuration Class................................................................82
3.38.1. Metho s..........................................................................83
3.39. ConfigurationDetector Class.....................................................94
3.39.1. Properties.......................................................................94
3.39.2. Metho s..........................................................................98
3.40. ConfigurationPresenceDetector Class .......................................98
3.41. ConfigurationQueueDetector class............................................99
3.42. ConfigurationSpee Detector class.............................................99
3.42.1. Properties.......................................................................99
3.43. ConfigurationRe LightDetector class.......................................100
3.43.1. Properties.....................................................................100
3.44. ConfigurationStoppe CarDetector Class...................................105
3.44.1. Properties.....................................................................105
3.45. ConfigurationOutputActuator class..........................................108
3.45.1. Properties.....................................................................108
3.45.2. Metho s .......................................................................110
3.46. ConfigurationOutputActuatorCon itions class............................110
3.46.1. Metho s........................................................................110
3.47. ConfigurationOutputActuatorCon ition class.............................112
3.47.1. Properties.....................................................................112
3.47.2. Metho s .......................................................................113
3.48. ConfigurationTrafficLight class................................................114
3.48.1. Properties.....................................................................114
3.48.2. Metho s........................................................................115
3.49. ConfigurationLights Class.......................................................116
3.49.1. Metho s........................................................................116
3.50. ConfigurationLight class........................................................117
3.50.1. Properties.....................................................................117
3.50.2. Metho s.......................................................................119
3.51. SystemInformation class ......................................................119
3.51.1. Properties.....................................................................119
3.51.2. Metho s........................................................................120
Quercus Technologies

3.52. SettingsEntry class...............................................................121
3.52.1. Properties.....................................................................121
3.52.2. Metho s........................................................................122
3.53. VLDetectorType Type............................................................122
3.54. VLNotificationCo e Type........................................................122
3.55. VLInci enceType Type...........................................................123
3.56. VLLightType Type.................................................................123
3.57. VLFiel Type Type.................................................................123
3.58. VLOperatorType Type...........................................................123
3.59. VLTimestampObject Type......................................................124
3.60. VLLogSystem Type...............................................................124
3.61. VLConfigurationActionType Type.............................................124
3.62. VLCon itionOperatorType Type...............................................125
4. Communications protocol..............................................................126
4.1. Message format.....................................................................127
4.2. Message version....................................................................128
4.3. Compatibility between QuercusVL® pro ucts.............................130
4.4. Initial concepts .....................................................................132
4.4.1. Units..............................................................................132
4.4.2. Booleans.........................................................................132
4.4.3. Coor inates.....................................................................132
4.5. Common structures................................................................132
4.5.1. Timestamp......................................................................132
4.5.2. Region............................................................................133
4.5.3. DetectorHea er...............................................................133
4.5.4. Spee Detector.................................................................134
4.5.5. QueueDetector................................................................135
4.5.6. PresenceDetector.............................................................135
4.5.7. Light..............................................................................135
4.5.8. TrafficLight......................................................................136
4.5.9. Re LightDetector.............................................................136
4.5.10. Stoppe CarDetector........................................................138
Quercus Technologies

4.5.11. Vi eoInformation............................................................138
4.5.12. OutputActuatorCon ition.................................................139
4.5.13. OutputActuator..............................................................139
4.6. Event messages.....................................................................140
4.6.1. InputChange ..................................................................140
4.6.2. Notification......................................................................140
4.6.3. SummaryInformation........................................................141
4.6.4. Inci enceInformation........................................................142
4.6.5. RealTimeInformation........................................................144
4.7. Query messages ...................................................................144
4.7.1. VersionQuery...................................................................144
4.7.2. RealTimeQuery................................................................145
4.7.3. StatusQuery....................................................................146
4.7.4. IOQuery.........................................................................147
4.7.5. ImageQuery....................................................................147
4.7.6. SnapshotQuery................................................................148
4.7.7. UnitTasksQuery...............................................................150
4.7.8. DetectorTasksQuery.........................................................151
4.7.9. DetectorsCountQuery........................................................151
4.7.10. DetectorInformationQuery...............................................152
4.7.11. TrafficLightsCountQuery..................................................154
4.7.12. TrafficLightInformationQuery............................................154
4.7.13. SetUnitTasksQuery.........................................................155
4.7.14. SetDetectorTasksQuery...................................................156
4.7.15. OutputQuery..................................................................156
4.7.16. RebootQuery.................................................................157
4.7.17. Vi eoQuery...................................................................157
4.8. Confirmation messages...........................................................158
4.8.1. ACK...............................................................................158
4.8.2. NAK...............................................................................158
4.9. Configuration messages..........................................................160
4.9.1. Ping...............................................................................161
Quercus Technologies

4.9.2. Login..............................................................................161
4.9.3. Logout............................................................................162
4.9.4. Passwor Change..............................................................162
4.9.5. SyncTime........................................................................163
4.9.6. SetTime..........................................................................163
4.9.7. Up ateFirmware...............................................................164
4.9.8. RestoreFirmware..............................................................164
4.9.9. FormatRWPartition...........................................................165
4.9.10. ExportLog.....................................................................165
4.9.11. SystemInfo....................................................................166
4.9.12. ExportStatus..................................................................167
4.9.13. ImportConfiguration.......................................................167
4.9.14. ExportConfiguration........................................................168
4.9.15. ApplyChanges................................................................168
4.9.16. Discar Changes.............................................................169
4.9.17. Restart.........................................................................169
4.9.18. GetEntriesCount.............................................................170
4.9.19. GetEntry.......................................................................171
4.9.20. SetEntry.......................................................................171
4.9.21. RestoreEntry..................................................................172
4.9.22. GetDetectorsCount.........................................................172
4.9.23. RemoveDetector............................................................173
4.9.24. GetDetector...................................................................174
4.9.25. SetPresenceDetector.......................................................175
4.9.26. SetQueueDetector..........................................................176
4.9.27. SetRe LightDetector.......................................................177
4.9.28. SetSpee Detector..........................................................178
4.9.29. SetStoppe CarDetector...................................................178
4.9.30. GetTrafficLightsCount......................................................179
4.9.31. RemoveTrafficLight.........................................................180
4.9.32. GetTrafficLight...............................................................180
4.9.33. SetTrafficLight...............................................................181
Quercus Technologies

4.9.34. GetLanguage....................................................................182
4.9.35. SetLanguage.................................................................183
4.9.36. GetOutputActuatorsCount................................................183
4.9.37. RemoveOutputActuator...................................................184
4.9.38. GetOutputActuator.........................................................184
4.9.39. SetOutputActuator..........................................................185
5. Communications protocol (ol versions)..........................................187
5.1. Common structures................................................................187
5.1.1. OutputActuator................................................................187
5.1.2. DetectorHea er...............................................................187
5.1.3. Spee Detector.................................................................188
5.1.4. QueueDetector................................................................189
5.1.5. PresenceDetector.............................................................189
5.1.6. TrafficLight......................................................................190
5.1.7. Re LightDetector.............................................................190
5.1.8. Stoppe CarDetector.........................................................192
5.2. Event messages.....................................................................193
5.2.1. Inci enceInformation........................................................193
5.3. Query messages....................................................................193
5.3.1. SnapshotQuery................................................................193
5.3.2. DetectorInformationQuery.................................................194
5.3.3. TrafficLightInformationQuery.............................................194
5.4. Configuration messages..........................................................195
5.4.1. SystemInfo.....................................................................195
5.4.2. GetDetector....................................................................195
5.4.3. SetPresenceDetector........................................................195
5.4.4. SetQueueDetector............................................................196
5.4.5. SetRe LightDetector.........................................................196
5.4.6. SetSpee Detector............................................................196
5.4.7. SetStoppe CarDetector.....................................................196
5.4.8. GetTrafficLight.................................................................196
5.4.9. SetTrafficLight.................................................................197
Quercus Technologies