ObixClient represents the client access to an oBIX server device (note that a special-purpose variation for a Niagara R2 station also exists, as the R2ObixClient). Each is a “device-level” component in the NiagaraAX Obix driver architecture.
“Client/server” naming in the Obix driver follows a “convention” used in some other drivers, for example the OPC driver and Modbus drivers, where a “client” device actually represents a server device (here, an oBIX server), and associated NiagaraAX components are named “client” because a client connection is used to retrieve data.
The ObixClient has the standard device component properties such as status and enabled (see “Common device components” in the Drivers Guide for general information). In addition, the following properties are unique or have special importance:
-
Lobby
The URI to the root of the server's object tree. If the server host changes, only the authority (scheme://host[:port]) here needs to be changed and all sub-objects will work for the new host.
-
Auth User
The user name the client should use to access the server. It can be blank if the server supports unauthenticated access.
-
Auth Pass
The passphrase for the auth user.
-
Poll Scheduler
The poll scheduler is only used when watches on the server are not working.
Two actions are available on the ObixClient, as follows:
-
Ping
Sends a ping monitor request to verify device “health. “
-
Reattach
Attempts to reattach to the oBIX server (detaches, then attaches).