ObixClientLibrary

Obix Client Library for retrieving Obix points from a device, in my case Niagara/Tridium Jace and Web Supervisors.

This is based on the work of TylerJWatson - https://github.com/tylerjwatson/NetBIX. As development on his library looks to have stopped 7 years ago, and as I made a bunch of small changes to it offline, I decided not to fork his library but reupload fresh and credit him. He wrote the majority of this, I've only made a bunch of small tweaks, additions, and ran it through Visual Studio code analysis to clean stuff up.

Installation

Create a Class Library project within your VS solution called Obix Client Library (or the name of your choosing). Add the files here to your project. In your main project add a reference to this library.

Basic Usage

For ease of use add some imports to your code:

Imports ObixClientLibrary
Imports ObixClientLibrary.Extensions
Imports ObixClientLibrary.Framework

Basic connection to a Obix server:

Dim obixClient As XmlObixClient = GetClient(ServerAddress, UserName, Password, AuthenticationType)
Dim connectResult As ObixResult = obixClient.Connect()
If connectResult = ObixResult.kObixClientSuccess Then
  msgbox("Connect success!")
Else
  msgbox("Connect failed!  Reason given: " & ObixResult.Message(connectResult))
End If  

Notes:

Most of the above is self explanitory except for AuthenticationType. That is a integer which is 1 for N4 Digest, 2 for Ax Digest, and 3 for HTTP Basic. Defaults to 3 if not supplied.

Limitations

This only works with HTTP Basic authentication so setup a user with HTTP Basic. I could not figure out the code for AX or N4 authentication although I have place holders for them in the code that is commented. If someone sees this and knows please put in a pull request or raise a issue.