ExoSense Data Types¶

Introduction¶

This document defines the data types and units supported by the ExoSense™️ solution and related technologies used by developers interfacing edge IoT devices, third-party data, and custom insight transforms and rules.

Definitions¶

The reader of this document should have a grasp on the following items or will need to for this document to make sense.

Data Type Definition¶

Each channel requires to be set as a specific type which should be the source of truth and therefore allows for allowing down-stream support for conversions, visualizations, etc that can be trusted. In the ExoSense application, Asset Signals inherit type/unit from the channel. Type and units should not be changed for a channel/signal once created, instead a new channel or signal should be created to handle the change.

The section below details the "type" categories supported, the specific types under each category, and the unit options for each type.

There are two type categories for Data Types:

• Generic Types: Typically unit less or if a unit is provided, is a description rather than physically measured. Examples include Number, String, JSON, etc.
• Unit Originated Types: Physically measurable types of data that include a unit of measure (UOM). Examples include temperature, electrical current, memory, etc.

Type Primitives¶

Each data type falls into one of the supported Primitive formats: NUMERIC, STRING, JSON, BOOLEAN.

These are used to describe the format of the data and allows visualizations, Insight functions (transforms, rules, etc) to accept multiple data types based on the same primitive (e.g. NUMERIC) format. The primitive format category is the actual underlying encoding / format used for values of that data type.

Value Formats¶

Numeric Value Size and Format¶

Number values (any data type of Numeric primitive) are stored and processed in IEEE Double format. Numbers sent above 17 digits (52 bits) can not be stored exact and are treated as a floating point value which will be stored and visualized as a rounded number. For more information on this topic: https://en.wikipedia.org/wiki/IEEE_754

String and JSON Value Size and Format¶

Strings and JSON values must be less then 2 KB size. JSON values must be condensed.

Generic Data Types¶

The generic types are used for data that may not have units, anything that is dimensionless, or no supported unit types exist. Includes numeric, string, and structured data generic types. Generic types do not support a measurable unit and therefore standard unit conversions are not supported in the application for generic data types.

String (unit-less)¶

Key (data_type): STRING
Accepted Units (data_unit): Not Used
Primitive Format: STRING
UI Unit Abbreviation: na
Notes: Any string

Example String Channel

{
  "channels": {
    "005": {
      "display_name": "Machine Status",
      "description": "Device reported status",
      "properties": {
        "data_type": "STRING"
      },
      "protocol_config": {
        "report_rate": 60000,
        "timeout": 360000
      }
    }
  }
}

Example String Channel Data (data_in) Packet

{
  "005":"Good"
}

JSON (unit-less)¶

Key (data_type): JSON
Accepted Units (data_unit): Not Used
Primitive Format: JSON
UI Unit Abbreviation: na
Notes: Any JSON blob

Example JSON Channel

{
  "channels": {
    "017": {
      "display_name": "Machine Stats",
      "description": "Device reported stats",
      "properties": {
        "data_type": "JSON"
      },
      "protocol_config": {
        "report_rate": 60000,
        "timeout": 360000
      }
    }
  }
}

Example JSON Channel Data (data_in) Packet

{
  "017":{"network_errors":0,"RAM":"45 MB"}
}

Example JSON Signal type value that the JSON Table Panel will display

{
  "017":{
    "values" :
    [
      ["stat 1", 23, "ok", 542.32],
      ["stat 2", 103, "warning", 323.99],
      ["stat 3", 0.32, "nothing to see here", 100.81]
    ]
  }
}

Number (unit-less)¶

Key (data_type): NUMBER
Accepted Units (data_unit): Not Used
Primitive Format: NUMERIC
UI Unit Abbreviation: na
Notes: Any Real Number

Example Number Channel

{
  "channels": {
    "134": {
      "display_name": "Pulses Counted",
      "description": "Times a pulse was counted in given time frame",
      "properties": {
        "data_type": "NUMBER"
      },
      "protocol_config": {
        "sample_rate": 10,
        "report_rate": 5000,
        "timeout": 60000
      }
    }
  }
}

Example Number Channel Data (data_in) Packet

{
  "134":43
}

BOOLEAN (unit-less)¶

Key (data_type): BOOLEAN
Accepted Units (data_unit): Not Used
Primitive Format: BOOLEAN
UI Unit Abbreviation: na
Notes:

• True ("Truthy") accepted values: true, "on", 1, "yes", any number that is not 0
• False ("Falsy") accepted values: false, "off", 0, "no"
• All values will be converted to true and false at ingestion in ExoSense for use by transform insights, rules, and UI panels.

Example Boolean Channel Configuration

{
  "channels": {
    "023": {
      "display_name": "Valve 1 Open",
      "description": "Machine Valve 1 Open State Information",
      "properties": {
        "data_type": "BOOLEAN"
      },
      "protocol_config": {
        "sample_rate": 5000,
        "report_rate": 5000,
        "timeout": 60000
      }
    },
    "025": {
      "display_name": "Valve 2 Open",
      "description": "Machine Valve 2 Open State Information",
      "properties": {
        "data_type": "BOOLEAN"
      },
      "protocol_config": {
        "sample_rate": 5000,
        "report_rate": 5000,
        "timeout": 60000
      }
    }
  }
}

Example Boolean Channel Data (data_in) Packet

{
  "023":true,
  "025":0
}

Note: Generic types without accepted unit types will not be able to take advantage of unit conversion and other unit specific functionality in ExoSense.

Unit Originated Data Types¶

The following data types require a fixed unit type that is specified as a part of the origination channel configuration (config_io) and used as source of truth through the application.

Many of these types will represent base physical measurements (temperature, length, etc), or derived measurements (velocity), as noted in this Wikipedia article. The list is assumed to never be complete and future types / units could be added. Some physical quantities have simply been left off the list for simplicity and assumed lack of need for Industrial IoT applications.

Example Unit Originated Data Type Channel Configuration

{
  "channels": {
    "002": {
      "display_name": "Temperature",
      "description": "Temperature Sensor Reading",
      "properties": {
        "data_type": "TEMPERATURE",
        "data_unit": "DEG_CELSIUS",
        "precision": 2
      },
    }
  }
}

Example Unit Originated Data Type Channel Data (data_in) Packet

{
  "002":43
}

Acceleration¶

Data Type (data_type): ACCELERATION
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ACCELERATION",
  "data_unit": "METER_PER_SEC2"
}

Amount of Substance¶

Data Type (data_type): AMOUNT
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "AMOUNT",
  "data_unit": "MOLE"
}

Angular acceleration¶

Key (data_type): ANGULAR_ACCEL
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ANGULAR_ACCEL",
  "data_unit": "DEG_PER_SEC2"
}

Angular Velocity / Speed¶

Key (data_type): ANGULAR_VEL
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ANGULAR_VEL",
  "data_unit": "ROTATIONS_PER_MIN"
}

Area¶

Key (data_type): AREA
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "AREA",
  "data_unit": "METER2"
}

Array of Numbers¶

Key (data_type): ARRAY_NUMBERS
Primitive Format: JSON
Accepted Units (data_unit): Not Used

Notes: The array can be of any length (up to the JSON primitive maximum size), and does not need to be consistently of the same length.

Example Channel Properties Configuration:

{
  "data_type": "ARRAY_NUMBERS"
}

Example Channel / Signal Value

[1,2,3,4,5,6,7,8,9,10,11,12]

Array of Points¶

Key (data_type): ARRAY_POINTS
Primitive Format: JSON
Accepted Units (data_unit): Not Used

Notes: The inner arrays are always two numbers. The outer array can be any length (up to the JSON primitive maximum size), and can vary in length.

Example Channel Properties Configuration:

{
  "data_type": "ARRAY_POINTS"
}

Example Channel / Signal Value

[[23, 42],[10,12],[56,98.6]]

Battery Percentage¶

Key (data_type): BATTERY_PERCENTAGE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "BATTERY_PERCENTAGE",
  "data_unit": "PERCENT"
}

Notes: Device diagnostic

Capacitance¶

Key (data_type): CAPACITANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "CAPACITANCE",
  "data_unit": "FARAD"
}

Concentration (Mass)¶

Key (data_type): CONCENTRATION_MASS
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "CONCENTRATION_MASS",
  "data_unit": "GRAM_PER_LITER"
}

Concentration Ratio (Particles)¶

Key (data_type): PARTICLES
Primitive Format: NUMERIC
Accepted Units (data_unit):

Notes: Psuedo-units to describe the concentration of particles as a quantity of quantity.

Example Channel Properties Configuration:

{
  "data_type": "PARTICLES",
  "data_unit": "PPM"
}

Currency¶

Key (data_type): CURRENCY
Primitive Format: NUMERIC
Accepted Units (data_unit):
AFN, ALL, DZD, USD, EUR, AOA, XCD, ARS, AMD, AWG, AUD, AZN, BSD, BHD, BDT, BBD, BYR, BZD, XOF, BMD, BTN, INR, BOB, BOV, BAM, BWP, NOK, BRL, BND, BGN, BIF, CVE, KHR, XAF, CAD, KYD, CLF, CLP, CNY, COP, COU, KMF, CDF, NZD, CRC, HRK, CUC, CUP, ANG, CZK, DKK, DJF, DOP, EGP, SVC, ERN, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GBP, GNF, GYD, HTG, HNL, HKD, HUF, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JPY, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, CHF, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXN, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, PHP, PLN, QAR, RON, RUB, RWF, SHP, WST, STN, SAR, RSD, SCR, SLL, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, SZL, SEK, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYI, UYU, UZS, VUV, VEF, VND, YER, ZMW, ZWL

Notes:

• Currency codes based on list found here: https://www.iban.com/currency-codes.html
• No Unit Abbreviations
• Conversions between currency is complicated and always changing based on world-wide markets. ExoSense and related technology will not support currency conversions.

Example Channel Properties Configuration:

{
  "data_type": "CURRENCY",
  "data_unit": "USD"
}

Data¶

Key (data_type): DATA
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "DATA",
  "data_unit": "MEGABYTE"
}

Density¶

Key (data_type): DENSITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "DENSITY",
  "data_unit": "KG_PER_M3"
}

Displacement¶

Key (data_type): DISPLACEMENT
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "DISPLACEMENT",
  "data_unit": "METERS"
}

Electrical Charge¶

Key (data_type): ELEC_CHARGE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_CHARGE",
  "data_unit": "COULOMB"
}

Electric Current¶

Key (data_type): ELEC_CURRENT
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_CURRENT",
  "data_unit": "AMPERE"
}

Electrical Conductance¶

Key (data_type): ELEC_CONDUCTANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_CONDUCTANCE",
  "data_unit": "SIEMENS"
}

Electrical Conductivity**¶

Key (data_type): ELEC_CONDUCTIVITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_CONDUCTIVITY",
  "data_unit": "SIEMENS_PER_METER"
}

Electrical Potential (Voltage)¶

Key (data_type): ELEC_POTENTIAL
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_POTENTIAL",
  "data_unit": "VOLT"
}

Electrical Resistance¶

Key (data_type): ELEC_RESISTANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_RESISTANCE",
  "data_unit": "OHM"
}

Electrical Resistivity¶

Key (data_type): ELEC_RESISTIVITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ELEC_RESISTIVITY",
  "data_unit": "OHM_METER"
}

Energy¶

Key (data_type): ENERGY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ENERGY",
  "data_unit": "JOULE"
}

Energy (Reactive)¶

Key (data_type): ENERGY_REACTIVE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ENERGY_REACTIVE",
  "data_unit": "KILOVOLTAMPS_REACTIVE_HOUR"
}

Field Level¶

Key (data_type): FIELD_LEVEL
Primitive Format: NUMERIC
Accepted Units (data_unit):

Notes: Used for logarithmic measures. Reference: https://en.wikipedia.org/wiki/Level_(logarithmic_quantity)

Example Channel Properties Configuration:

{
  "data_type": "FIELD_LEVEL",
  "data_unit": "DECIBEL"
}

Flow (Volumetric)¶

Key (data_type): FLOW
Primitive Format: NUMERIC
Accepted Units (data_unit):

Notes: Flow as PERCENT will not support conversions

Example Channel Properties Configuration:

{
  "data_type": "FLOW",
  "data_unit": "LITERS_PER_SEC"
}

Flow (Mass)¶

Key (data_type): FLOW_MASS
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "FLOW_MASS",
  "data_unit": "KG_PER_SEC"
}

Force¶

Key (data_type): FORCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "FORCE",
  "data_unit": "NEWTON"
}

Frequency¶

Key (data_type): FREQUENCY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "FREQUENCY",
  "data_unit": "HERTZ"
}

GPS / Location¶

Key (data_type): LOCATION
Primitive Format: JSON
Accepted Units (data_unit):

Notes:

• LAT_LONG contains both latitude and longitude in a JSON structured
• LAT_LONG_ALT unit includes optionally sending altitude and acceleration.

Example Channel Properties Configuration:

{
  "data_type": "LOCATION",
  "data_unit": "LAT_LONG"
}

Example Channel / Signal Data values

{"lat": "{value}","lng":"{value}"}

{"lat": "{value}","lng":"{value}","alt":"{value}","acc":"{value}"}

Heat¶

Key (data_type): HEAT
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "HEAT",
  "data_unit": "JOULE"
}

Humidity¶

Key (data_type): HUMIDITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "HUMIDITY",
  "data_unit": "PERCENT"
}

Illuminance¶

Key (data_type): ILLUMINANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ILLUMINANCE",
  "data_unit": "LUX"
}

Inductance¶

Key (data_type): INDUCTANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "INDUCTANCE",
  "data_unit": "HENRY"
}

Irradiance¶

Key (data_type): IRRADIANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "IRRADIANCE",
  "data_unit": "WATT_PER_METER2"
}

Jerk¶

Key (data_type): JERK
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "JERK",
  "data_unit": "METER_PER_SEC3"
}

Length¶

Key (data_type): LENGTH
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "LENGTH",
  "data_unit": "METERS"
}

Linear density¶

Key (data_type): LINEAR_DENSITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "LINEAR_DENSITY",
  "data_unit": "KILOGRAM_PER_METER"
}

Luminance¶

Key (data_type): LUMINANCE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "LUMINANCE",
  "data_unit": "CANDELA_PER_METER2"
}

Luminous Flux¶

Key (data_type): LUMINOUS_FLUX
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "LUMINOUS_FLUX",
  "data_unit": "LUMENS"
}

Luminous Intensity¶

Key (data_type): LUMINOUS_INTENSITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "LUMINOUS_INTENSITY",
  "data_unit": "CANDELA"
}

Mass¶

Key (data_type): MASS
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "MASS",
  "data_unit": "KILOGRAM"
}

Percentage¶

Key (data_type): PERCENTAGE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "PERCENTAGE",
  "data_unit": "PERCENT"
}

pH¶

Key (data_type): PH
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "PH",
  "data_unit": "PH"
}

Plane Angle¶

Key (data_type): ANGLE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "ANGLE",
  "data_unit": "RADIAN"
}

Power¶

Key (data_type): POWER
Primitive Format: NUMERIC Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "POWER",
  "data_unit": "WATT"
}

Power (Apparent)¶

Key (data_type): POWER_APPARENT
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "POWER_APPARENT",
  "data_unit": "VOLTAMPS"
}

Power (Reactive)¶

Key (data_type): POWER_REACTIVE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "POWER_REACTIVE",
  "data_unit": "VOLTAMPS_REACTIVE"
}

Power Level¶

Key (data_type): POWER_LEVEL
Primitive Format: NUMERIC
Accepted Units (data_unit):

Notes: Used for logarithmic measures. Reference: https://en.wikipedia.org/wiki/Level_(logarithmic_quantity)

Example Channel Properties Configuration:

{
  "data_type": "POWER_LEVEL",
  "data_unit": "DECIBEL"
}

Pressure¶

Key (data_type): PRESSURE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "PRESSURE",
  "data_unit": "BAR"
}

Signal Strength as Percent¶

Key (data_type): SIGNAL_STRENGTH_PERCENTAGE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Notes: Device diagnostic

Example Channel Properties Configuration:

{
  "data_type": "SIGNAL_STRENGTH_PERCENTAGE",
  "data_unit": "PERCENT"
}

Solid angle¶

Key (data_type): SOLID_ANGLE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "SOLID_ANGLE",
  "data_unit": "STERADIAN"
}

Speed¶

Key (data_type): SPEED
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "SPEED",
  "data_unit": "METER_PER_SEC"
}

Temperature¶

Key (data_type): TEMPERATURE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Note: For use cases involving temperature differences, please see the TEMPERATURE_DELTA type.

Example Channel Properties Configuration:

{
  "data_type": "TEMPERATURE",
  "data_unit": "DEG_CELSIUS"
}

Temperature Delta¶

Key (data_type): TEMPERATURE_DELTA
Primitive Format: NUMERIC
Accepted Units (data_unit):

Note: The Temperature Delta (TEMPERATURE_DELTA) type is used when a signal represents the delta or difference in temperature, rather than an absolute temperature value. It is important to use this type rather than TEMPERATURE type in order for the application and functions to properly handle unit conversions.

Example Channel Properties Configuration:

{
  "data_type": "TEMPERATURE_DELTA",
  "data_unit": "DEG_CELSIUS"
}

Time¶

Key (data_type): TIME
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "TIME",
  "data_unit": "SECONDS"
}

Torque¶

Key (data_type): TORQUE
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "TORQUE",
  "data_unit": "NEWTON_METER"
}

Turbidity¶

Key (data_type): TURBIDITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Notes: Unit conversions are not supported in the ExoSense application for Turbidity.

Example Channel Properties Configuration:

{
  "data_type": "TURBIDITY",
  "data_unit": "FTU"
}

URL¶

Key (data_type): URL
Primitive Format: JSON
Accepted Units (data_unit): Not Used

Notes: A JSON object that contains at minimum a key url. The url value must be a string that consists of a proper URL address scheme starting with https, etc. Optional title key to provide a title that would be displayed in the UI instead of the full URL address. The application (example ExoSense) will define what URL types are actually supported (click-able in the UI). Validation and security checks are not provided by the platform or application. Recommend only for use of encrypted and password protected URLs. OEMs implementing device or custom Insight support to generate URL values, do so at their own risk to their users. Feature must be enabled by ExoSense administrators.

Example Channel Properties Configuration:

{
  "data_type": "URL"
}

Example Channel / Signal Value Reference

{"url": "{proper_url_value_here}","title":"{optional_title_value_here}"}

Example Channel / Signal Values

{"url": "https://exosite.com","title":"Device Link"}

Velocity¶

Key (data_type): VELOCITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "VELOCITY",
  "data_unit": "METER_PER_SEC"
}

Viscosity, Dynamic¶

Key (data_type): DYNAMIC_VISCOSITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "DYNAMIC_VISCOSITY",
  "data_unit": "PASCAL_SEC"
}

Viscosity, Kinematic¶

Key (data_type): KINEMATIC_VISCOSITY
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "KINEMATIC_VISCOSITY",
  "data_unit": "METERS2_PER_SEC"
}

Volume¶

Key (data_type): VOLUME
Primitive Format: NUMERIC
Accepted Units (data_unit):

Note: Important to take note of the format of data unit for Liters and Millileters in this Volume type uses LITRE and MILLILITRES which is not the synxtax used for other unit types in this schema document where LITER is used. Please be sure to use as documented here.

Example Channel Properties Configuration:

{
  "data_type": "VOLUME",
  "data_unit": "METER3"
}

Weight¶

Key (data_type): WEIGHT
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "WEIGHT",
  "data_unit": "NEWTON"
}

Work¶

Key (data_type): WORK
Primitive Format: NUMERIC
Accepted Units (data_unit):

Example Channel Properties Configuration:

{
  "data_type": "WORK",
  "data_unit": "JOULE"
}

Change log¶

• Added TEMPERATURE_DELTA type with same units as TEMPERATURE to support temperature delta unit conversions in the application.
• Added MILLITORR and MICRONS_HG units for type PRESSURE
• Updated the abbreviation in ExoSense for MICRONS to use µm instead of µ
• Added ELEC_CHARGE type with units COULOMB, AMPERE_HOUR, MILLIAMPERE_HOUR
• Added IRRADIANCEtype with unit WATT_PER_METER2
• Added HECTOPASCAL unit for type PRESSURE
• Added ARRAY_POINTS and ARRAY_NUMBERS data types
• Added MEGAPASCAL unit for type PRESSURE
• Added ENERGY_REACTIVE type with units VOLTAMPS_REACTIVE_HOUR, KILOVOLTAMPS_REACTIVE_HOUR, MEGAVOLTAMPS_REACTIVE_HOUR
• Added FEET_PER_MIN unit for type SPEED and VELOCITY
• Added FEET_PER_MIN2 unit for type ACCELERATION
• Removing reference of primitive_type in config_io as it is assumed by data_type and not needed. If provied, must match the primitive format for each data type.
• Updated format of Accepted Units into tables and added channel property examples.
• Added Mass units: MICROGRAM
• Added Concentration Mass units: MILLIGRAM_PER_METER3, MICROGRAM_PER_METER3, MICROGRAM_PER_LITER
• Moved Particles up and changed heading to Concentration Ratio (Particles)
• Add POUND_FORCE unit to Force type.
• Split Power to Power, Power (Apparent), and Power (Reactive). Add additional units to Power types.
• Add CONCENTRATION_MASS, TURBIDITY, and ELEC_CONDUCTIVITY types
• Change VELOCITY unit INCH_PER_SEC abbrevation to in/s (was ips)
• Add ACCELERATION unit MILLMETERS_PER_SEC2 (abreviation: mm/s²)
• Added a note about Numeric primitve type value size and format
• Fixed Luminous Flux data type 'data_type' value to LUMINOUS_FLUX, was LUMINANCE_FLUX.
• Created this document as seperate from "ExoSense™️ Channel and Signal Data Schema", using v3.0 since the other document is also moving to 3.0. Will track version history seperately moving forward.
• Added many new Numeric measurement types and units
• Changed format to show the accepted units and the abbreviations used in the application
• Added BOOLEAN type
• Added URL type
• Added a new inheritied element primitive_type to specify the format for each data type
• Removed non-supported data types