MooringSDK 1.6.8

About

The MooringSDK is an SDK provided by Phaidra to simplify site integration by providing Authentication mangement, persistent caching, and stream management. It requires a number of configurations that are provided by Phaidra during the onboarding process.

The source code for this SDK is available as requested, as is additional documentation.

For more questions about the process, configurations, etc. Please reach out to the customer success team and they'll be happy to help.

Quickstart

The SDK is meant to act as a singleton within your client. Thus it should be configured and created once, and used across your code as required.

var auth0Endpoint = ""; // Provided by Phaidra
var auth0ClientID = ""; // Provided by Phaidra
var auth0ClientSecret = ""; // Provided by Phaidra

var authConfig = new Auth0Config(auth0Endpoint, auth0ClientID, auth0ClientSecret);

var phaidraEndpoint = ""; // Provided by Phaidra
var phaidraHealthpoint = ""; // Provided by Phaidra
var connectionID = ""; // Provided by Phaidra
var cacheDir = "/tmp/phaidra-cache" // Directory for persistent cache to be written

var config = new MooringConfig(phaidraEndpoint, phaidraHealthpoint, connectionID, cacheDir, authConfig);

var mooring = new Mooring(config);

The Mooring object will need to be "Started" to spin up background threads for sending data to Phaidra.

mooring.Start();

Now pass the Mooring object to wherever you're fetching sensor data and push the data to Phaidra using the Mooring object's Push() function.

var points = new List<DataPoint>();
var epochTimestamp = DateTimeOffset.UtcNow.ToUnixTimeMilliseconds();

points.Add(new DataPoint(epochTimestamp, "sensor-1", "example-value"));
points.Add(new DataPoint(epochTimestamp, "sensor-2", 123));
points.Add(new DataPoint(epochTimestamp, "sensor-3", 123.456));
points.Add(new DataPoint(epochTimestamp, "sensor-4", true));

mooring.Push(points);

To begin streaming setpoints from Phaidra, a callback will need to be provided. This creates threads in the background.

public async Task ActionCallback(MooringAction action)
{
    Console.WriteLine($"Received action {action.SetpointId}");
}

mooring.StartActionStream(ActionCallback);