PhantomLib (.NET)

PhantomLib lets your application receive PHANTOM® sensor data straight from the gateway on your network, without a web service in between. It is written in C# and runs on Windows and on Linux under Mono.

It is message-based: you start listening threads, hand them a callback, and the library invokes it every time a message arrives.

Where this fits

You want	Use
Data from the cloud	EI-Analytic™ API
Data stored as JSON on your own server	PHANTOM® Web Service
Messages as the gateway emits them, in .NET	PhantomLib
:::

Download

PhantomLib-1.8.zipThe library, a console example and its SDK documentation

The archive contains PhantomLib.dll, the PhantomLibExample console application, and PhantomLibSDK.pdf — the document this page was transcribed from.

Starting and stopping

public void start(ProcessPhantomMessages messageProcessor, bool receive_vibration_data)
public void stop()

messageProcessor is the delegate that receives every incoming message. receive_vibration_data switches long vibration data on or off — see the warning below.

Your callback has this shape:

void processMessages(Phantom.Messages message, Phantom.MessageData data)

message tells you the type; data carries the payload, which you cast to the class for that type.

Only one machine can receive vibration data

The gateway sends short messages over UDP and long vibration data over TCP. Any number of computers on the network can receive the UDP messages, but only one can receive the TCP stream.

That is what receive_vibration_data controls. Passing true on two machines at once will not work — decide which one collects waveforms.

Your callback runs on other threads

The delegate is invoked from the context of different threads. To update a UI or serialise the messages you need to marshal back to the main thread — Invoke or a queue.

Messages

Phantom.Messages constant	Payload class	Carries
RECEIVED_PHANTOM_ACCEL_DATA	MessageDataEIMONanoAccel	Vibration waveforms
RECEIVED_PHANTOM_ACCEL_STATE	MessageEIMONanoAccelState	RMS, battery, temperature
RECEIVED_PHANTOM_ACCEL_SETTINGS	MessageEIMONanoAccelSettings	Current node settings
RECEIVED_PHANTOM_TEMP_DATA	MessageDataEIMONanoTemp	Thermocouple / infrared
RECEIVED_PHANTOM_CURRENT_DATA	MessageEIMONanoCurrentData	Current, 3 channels
RECEIVED_PHANTOM_CURRENT_DATAV2	MessageEIMONanoCurrentDataV2	Current v2, min/max/avg
RECEIVED_PHANTOM_ACCUMULATED_CURRENT_DATA	MessageEIMONanoAccumulatedCurrentData	Accumulated current in Ah
RECEIVED_PHANTOM_RPM_DATA	MessageEIMONanoRPMData	RPM
RECEIVED_PHANTOM_420_DATA	MessageData420	4-20 mA, as voltage
RECEIVED_PHANTOM_THERMAL_IMAGE	ThermalCameraImage	Thermal image
RECEIVED_PHANTOM_THERMAL_DATA	ThermalCameraData	Thermal camera state

Vibration data

public class MessageDataEIMONanoAccel : MessageData {
    public Reason recording_reason;
    public string phantom_code;
    public float temperature;
    public short[] channel1;
    public short[] channel2;
    public short[] channel3;
    public double calibration;
    public int sample_rate;
}

• channel1–channel3 are signed 16-bit samples. Multiply each by calibration to get G (9.8 m/s²).
• channel3 is null on biaxial nodes — check before dereferencing.
• temperature is the node’s internal radio transmitter temperature in °C, not the machine temperature.

public enum Reason { REQUESTED = 1, SCHEDULED = 2, ALARM = 3 }

State and settings

public class MessageEIMONanoAccelState : MessageData {
    public string phantom_code;
    public float battery;        // V
    public float temperature;    // °C, radio transmitter
    public float rms1, rms2, rms3;  // velocity RMS in mm/s
}

public class MessageEIMONanoAccelSettings : MessageData {
    public string phantom_code;
    public int send_interval;        // minutes, full acceleration data
    public int sample_rate;
    public int samples_to_get;
    public int range;                // G
    public float alarm1, alarm2, alarm3;   // mm/s
    public int alarmcheck_interval;  // seconds
}

Temperature

public class MessageDataEIMONanoTemp : MessageData {
    public Reason recording_reason;
    public string phantom_code;
    public TemperatureType type;
    public float temperature;           // thermocouple module
    public float battery;
    public float ambient_temperature;   // measured by the infrared module
    public float module_temperature;    // radio transmitter
}

public enum TemperatureType { THERMOCOUPLE = 1, INFRARED = 2 }

Current

public class MessageEIMONanoCurrentData : MessageData {
    public string phantom_code;
    public float battery;
    public float module_temperature;
    public float current1, current2, current3;   // A
}

public class MessageEIMONanoCurrentDataV2 : MessageData {
    public float battery;
    public float module_temperature;
    public float min_current1, min_current2, min_current3, min_current4;
    public float max_current1, max_current2, max_current3, max_current4;
    public float avg_current1, avg_current2, avg_current3, avg_current4;
    public uint version;
}

public class MessageEIMONanoAccumulatedCurrentData : MessageData {
    public float accumulated_current1, accumulated_current2,
                 accumulated_current3, accumulated_current4;   // Ah
    public DateTime startPeriod;
    public DateTime endPeriod;
}

The v2 module reports minimum, maximum and average since the last message. Accumulated current is in ampere-hours since the sensor started, over the period the two DateTime fields delimit.

RPM and 4-20 mA

public class MessageEIMONanoRPMData : MessageData {
    public string phantom_code;
    public float battery;
    public float module_temperature;
    public float rpm;
}

public class MessageData420 : MessageData {
    public string phantom_code;
    public float battery;
    public float module_temperature;
    public float channel1_voltage, channel2_voltage,
                 channel3_voltage, channel4_voltage;
    public uint version;
}

4-20 mA channels report voltage, measured across a 100 Ω resistor to ground: 20 mA reads 2.0 V and 4 mA reads 0.4 V.

Thermal camera

public class ThermalCameraImage : MessageData {
    public Reason recording_reason;
    public uint version;
    public uint sequence;
    public float[,,] temp_data;   // [frames, width, height], °C per pixel
    public int image_rows;
    public int image_columns;
    public int image_frames;
}

public class ThermalCameraData : MessageData {
    public float battery;
    public float module_temperature;
    public float average_frame_temperature;
    public float average_roi_temperature;
    public uint version;
}

temp_data is three-dimensional: frames, then width, then height, with each value the temperature of that pixel in Celsius.

Note

average_roi_temperature is documented as not used right now.

Changing sensor settings

public void send_einano_accel_config(
    string ip_address, string phantom_code,
    int send_interval, float alarm1, float alarm2, float alarm3,
    int alarmcheck_interval)

Parameter	Notes
ip_address	The gateway’s IP, not the sensor’s. It is shown on the gateway’s own LED display
send_interval	Minutes between full acceleration sends. Affects battery life
alarm1–alarm3	Thresholds in mm/s
alarmcheck_interval	Seconds between alarm checks. Affects battery life

Where to find the gateway IP

The gateway shows its own IP address on its LED display — read it from the unit itself.

If the gateway is on DHCP that address can change, which would silently break a hard-coded ip_address. The Modbus integration requires a static IP for the same reason; setting one is worth it here too.

The change is not immediate

The request goes to the gateway, which stores it and passes it to the node the next time the node connects to ask for its configuration. Expect a delay before it takes effect — the same deferred model the PHANTOM® Web Service uses for saveSettings.

Known issues in the source documentation

Caution

The SDK document is v1.7 while the distributed library is 1.8, so it may lag behind the assembly. These specific defects were found while transcribing it, and are reproduced above as published rather than silently corrected:

• RECEIVED_PHANTOM_420_DATA and RECEIVED_PHANTOM_THERMAL_DATA are both described as “the data of the Phantom RPM node” — copy-paste errors
• ThermalCameraData prose refers to a temperature field, but the class declares module_temperature
• ThermalCameraImage, MessageEIMONanoCurrentDataV2 and MessageEIMONanoAccumulatedCurrentData are described as having phantom_code, but none declares it — presumably it lives on the MessageData base class, which the document never defines

Packaging

The library ships as PhantomLib-1.8.zip, a Visual Studio working folder that includes .vs/, bin/ and obj/ build artifacts, plus a console example (PhantomLibExample) and Newtonsoft.Json 13.0.1. Target framework is .NET Framework 4.5.2.

Note

Publishing it as a NuGet package would make consuming and updating it considerably easier than distributing a zipped solution folder.