obixDriver-ObixClient

This component represents the client access to an oBIX server device. A special-purpose variation for a Niagara R2 station also exists as the R2ObixClient. Each is a device-level component in the Niagara 4 oBIX driver architecture.

Figure 4. ObixClient properties

One way to access these properties is to right-click the ObixNetwork, click Views > AX Property Sheet, and expand or double-click ObixClient.

As with other driver networks, an oBIX network has an Alarm Source Info container you can use to differentiate oBIX network alarms from other component alarms in the station.

In addition to the standard components (Status, Enabled Fault Cause, Health, Alarm Source Info), these properties are unique or have special importance:

Property	Value	Description
Lobby	URL-style text	Defines the URI at the root of the server's object tree. If the server host changes, only the authority (scheme://host[:port]) needs to change and all sub-objects will work for the new host.
Auth User	text	Defines the user name the client should use to access the server. It can be blank if the server supports unauthenticated access.
Auth Pass	text	Defines the passphrase for the `Auth User`.
Debug Responses	`true` and `false` (default)	Enables and disables responses from the server to client requests.
Debug Requests	`true` and `false` (default)	Enables and disables client requests to the server.
Poll Scheduler	additional properties	Defines the client polling schedule only when watches on the server are not working.
State	read-only	Detached
Alarms	additional properties	Integrates native alarms from the ObixClient into the Framework alarming subsystem.
Histories	additional properties	Opens the Obix History Manager view.
Points	additional properties	Opens the Obix Points Manager view.
Watch Safety Factor	hours minutes seconds (defaults to 10 seconds)	Specifies the time added to the watch interval to calculate the requested lease time of the watch. This is the change-of-value (CoV) subscription lifetime that the client requests from the server. This is more important if using a shorter watch interval, because the driver calculates two values to use as the requested lease time, choosing the larger of the two: `T1 = watch interval * 2T2 = watch interval + watch safety factor` For large watch intervals, the requested lease time is inherently big (2x). But the safety factor provides an independent way to control requested lease time, such that you could make it 3 or 4 times the watch interval, if desired.

Actions

The ObixClientsupports two actions:

Ping sends a ping monitor request to verify device health.
Reattach disconnects from the oBIX server and attempts to connect again.