MICRO-EPSILON colorSENSOR CFO Series, Instruction Manual

Page: 119 / 124

Page 119
Anhang | API Communication with Controller (Version 0.7.1)
colorSENSOR CFO
Error codes:
LPLC.system.action_failed
A 3.5.3.43 /api/system/time/zones
Query for time zones available
GET
The key
timezone_names
provides a list of time zones (text) (e.g. Europe/Berlin). There are also time zones
without slash-based grouping (e.g. UTC).
A 3.5.4 Websockets
A 3.5.4.1 Overview
/websocket/notifications/websocket
Websocket clients establish a connection to this URL to receive application data continuously. This includes
new sample values, as well as events such as learning new colors or changing the color space.
Attribute Model Content
id Text UUID of Websocket data set
source Text Source / reason for data set (e.g. “recognition_profile.matcher”)
timestamp Number Sensor uptime in seconds
payload Object Dictionary always contains an
event
attribute (e.g. “changed” or
“created”). The attributes “
uuid
(with regard to new or modified ele-
ment) and
data
(new / modified element) are optional
A 3.5.4.2 Fallback Techniques
If the browser is not capable of communicating with websockets, the
/websocket/notifications
path is
available as the endpoint for the SockJS client library, which provides automated and abstracted alternatives
such as XHR streaming, JSONP, Long Polling, etc.