Query The Connection Status Of An Endpoint; Query The Claiming Status Of An Endpoint; Unclaiming An Endpoint - Lightware UBEX Series User Manual

 
     
9. Programmer's Reference 9. Programmer's Reference
9.6.9. Query the Connection Status of an Endpoint
Command and Response
ç GET•/SYS/ENDPOINTS/<UBEX_EP>.ConnectionStatus
pr•/SYS/ENDPOINTS/<UBEX_EP>.ConnectionStatus=<status>
æ
Parameters
Identifier Parameter description
Connection status of
<status>
the selected endpoint
Example
ç GET /SYS/ENDPOINTS/UBEX0039A1.ConnectionStatus
æ pr /SYS/ENDPOINTS/UBEX0039A1.ConnectionStatus=Online
Applied F-series endpoint firmware package: v1.4.1 | Applied R-series endpoint firmware package: v1.4.1 | Applied MMU firmware package: v1.2.1 | LDC software: v1.34.0b2
UBEX series – Matrix Application Mode – User's Manual UBEX series – Matrix Application Mode – User's Manual
Value Explanation
The device powered off or not
Offline
connected to the UBEX matrix.
The device is establishing connection
Connecting
to the UBEX matrix.
The device is powered on and ready
Online
to use in the UBEX matrix.
9.6.10. Query the Claiming Status of an Endpoint
Command and Response
ç GET•/SYS/ENDPOINTS/<UBEX_EP>.ClaimingStatus
pr•/SYS/ENDPOINTS/<UBEX_EP>.ClaimingStatus=<status>
æ
Parameters
Identifier Parameter description
Claiming status of the
<status>
selected endpoint
Example
ç GET /SYS/ENDPOINTS/UBEX0039A1.ClaimingStatus
æ pr /SYS/ENDPOINTS/UBEX0039A1.ClaimingStatus=Claimed
9.6.11. Unclaiming an Endpoint
The command makes the selected endpoint to be unclaimed from the UBEX matrix.
Command and Response
ç CALL•/SYS/ENDPOINTS:unclaimEndpoint(<UBEX_EP>)
æ mO•/SYS/ENDPOINTS:unclaimEndpoint=
Example
ç CALL /SYS/ENDPOINTS:unclaimEndpoint(UBEX0039A1)
æ mO /SYS/ENDPOINTS:unclaimEndpoint=
Value Explanation
The device is under the unclaiming
procedure, it can be after the running of the
Unclaiming
unclaimEndpoint() or unclaimAllEndpoint()
commands typically.
The device is under initialization, it can
Initializing be during the first connecting to the MMU
typically.
Claiming The device is under the claiming procedure.
The device is under the reclaiming
Reclaiming procedure, it can be after operation mode
changing typically.
The device is under the restoring procedure,
Restoring it can be during rebooting of a claimed
endpoint device.
The device is claimed by the MMU and
Claimed
ready to use in the UBEX matrix.
112 112