SomatXR/eDAQXR SIE channel metadata
Tag | Example | Comments |
---|---|---|
Metadata provided prior to v2.0.0 | ||
"core:description" | BRG_1 Connector 1 | User defined description |
"core:uuid" | 67d8876b-ef79-414e-8a72-94a615ba558a | System internal unique ID |
"core:sample_rate" | 2500 | Sample rate in Hz |
"data_type" | sequential_float32 | Data storage data type (composite) |
"core:schema" | somat:sequential | Data storage mode |
"somat:data_format" | float | Data storage data format type |
"somat:data_bits" | 32 | Data storage length in bits |
"somat:input_channel" | ecpuxr_500016_brg_1_1 | User defined name |
"somat:connector" | connector1@brg_1.edaqxr-500016 | Internal hardware connection name (not used in the GUI user interface) |
"somat:datamode_type" | time_history | DataMode type |
"somat:datamode_name" | dm | DataMode name |
Additional metadata provided in v2.0.0 | ||
"somat:user_interface_sample_rate" | 2500 | For all sample rate domains except the HBM Classic domain, this is the same as "core:sample_rate" |
"somat:connection" | ecpuxr-500016:brg_1.c1 | User interface hardware connection name. Does not include network node for expansion modules (e.g., MXB modules, Axis cameras) |
"somat:module_type" | EBRG | Hardware module type (marketing name) |
"somat:network_node" | edaqxr-500016 | User assigned Network node (applicable for expansion modules only) |
"somat:measurand" | Strain | User defined value for the measurement type (or any other thing the user decides to use it for) |
"somat:user_defined_column_name_1" | Group | User defined column 1 name |
"somat:user_defined_column_value_1" | A | User defined column 1 channel value |
"somat:user_defined_column_name_2" | Chan # | User defined column 2 name |
"somat:user_defined_column_value_2" | 1 | User defined column 2 channel value |
"somat:user_defined_column_name_3" | Pictures | User defined column 3 name |
"somat:user_defined_column_value_3" | rosette_tbar_3.jpg | User defined column 3 channel value |
"somat:user_defined_column_name_4" | Installer | User defined column 4 name |
"somat:user_defined_column_value_4" | Joe | User defined column 4 channel value |
"somat:electrical_units" | mV/V | System defined electrical units (i.e., source data units before scaling) |
"somat:output_units" | microstrain | User defined / selected output units (i.e., physical units) |
"somat:scaling_mode" | defined_slope_intercept | Scaling mode used to convert from "electrical_units" to "output_units" |
"somat:scaling_parameters" | m=1.0,b= 0.0 | Comma separated parameter value list dependent on the scaling mode. See Table 1. |
"somat:scaling_lead_wire_correction" | m=1987.3,b=3.123 | Scaling corrected for lead wire resistance (always in the defined_slope_intercept parameter mode). See Table 1. |
"somat:zero_offset_target" | 0 | Zero target value (typically 0) |
"somat:zero_offset_value" | 3.7653490230000002 | Zero offset value |
"somat:physical_range_min" | -4000 | User defined physical units range min |
"somat:physical_range_max" | 4000 | User defined physical units range max |
"somat:digital_filter_type" | linear_phase_fir | Digital filter type (where applicable) |
"somat:digital_filter_attenuation_frequency" | 833 | Digital filter attenuation frequency |
"hbm_enum:digital_filter_type" | 3 | Digital filter type enumeration (where applicable) |
"somat:excitation_mode" | ac_4800_hz_sine | Excitation mode |
"somat:ac_excitation_carrier_frequency" | 4800 | AC excitation mode carrier frequency |
"somat:ac_excitation_carrier_waveform" | sine | AC excitation mode carrier waveform |
"somat:excitation_range" | 5 | Excitation range in volts |
"somat:transducer_power_voltage" | 12 | Transducer power supply voltage |
"somat:sensor_type" | bridge | |
"somat:electrical_range_min" | -10 | Electrical units range min |
"somat:electrical_range_max" | 10 | Electrical units range max |
"somat:bridge_type" | full | Bridge type (full, half, quarter) |
"somat:bridge_wires" | 6 | Bridge wires (3,4,5,6) (applicable to strain gage bridges, inductive bridges, and potentiometers) |
"somat:bridge_resistance" | 350 | Bridge resistance (Ohms) |
"somat:bridge_lead_wire_resistance" | 0.2 | Bridge lead wire resistance (Ohms) |
"somat:thermocouple_type" | k | Thermocouple type |
"somat:encoder_quadrature" | 1 | Option to use quadrature counting |
"somat:encoder_track_sign" | 1 | Option to use signed counter / frequency |
“somat:encoder_index_reset” | 1 | Option to reset counter on zero index crossing |
“somat:encoder_index_divisor” | 1 | Number of zero index crossings before counter is reset |
“somat:encoder_pulses_per_round” | 50 | Pulses per revolution |
“somat:stale_data_expiration_time” | 5 | If no new message data is received in this time period (seconds), the channel data is flagged as stale. |
“somat:invalid_data_output_value” | 65535 | Output value to be used when message based channel data is flagged as stale or invalid. |
"somat:can_bit_rate" | 1000000 | CAN bit rate |
"somat:can_msg_id" | 0x000007B6 | CAN message ID (hex format) |
"somat:can_bit_length" | 16 | CAN signal number of bits |
"somat:can_bit_start" | 48 | CAN signal start bit position |
"somat:can_data_format_string" | ULSB | CAN signal data format string. See Table 2. |
"somat:can_offset" | 0 | CAN signal offset factor (linear scaling) |
"somat:can_scale" | 1 | CAN signal scale factor (linear scaling) |
"somat:can_max" | 65535 | CAN signal max value |
"somat:can_min" | 0 | CAN signal min value |
"somat:can_units" | counts | CAN signal units string |
"somat:digital_threshold_high" | 1800 | Min signal level (in mV) crossing required for digital input channel to transition to logic 1 (true) |
"somat:digital_threshold_low" | 800 | Max signal level (in mV) crossing required for digital input channel to transition to logic 0 (false) |
"somat:internal_termination" | 1 | Boolean option to use internal termination (applicable to CAN channels, RS485 sensors on MX460 modules, etc.) |
"somat:smart_module_type" | smstrb | Smart module type (smstrb or smitc) |
"somat:smart_module_sn" | SMSTRB4-350-6676 | Smart module serial number |
"somat:teds_sensor_id" | HBM_UB9_10_1234 | TEDS sensor ID |
"somat:teds_calibration_date" | 7/28/2015 | TEDS sensor calibration date |
"somat:teds_calibration_period" | 720 | TEDS sensor calibration period (days) |
Table 1: Scaling parameters
Scaling mode | Scaling parameters | Example |
---|---|---|
internal | (none) | |
defined_slope_intercept | slope, intercept | m=1.0,b= 0.0 |
defined_zero_span | physical_span, electrical_span, electrical_zero | ps=1.0,es=1.0,ez=0.0 |
defined_two_point | physical_1, physical_2, electrical_1, electrical_2 | p1=0.0,p2=1.0,e1=0.0,e2=0.0 |
experimental_two_point | physical_1, physical_2, electrical_1, electrical_2 | p1=0.0,p2=1.0,e1=0.0,e2=0.0 |
strain_gage | gage_factor, bridge_factor | gf=2.0,bf=1.0 |
shunt | resistor, polarity, physical_span, electrical_span, electrical_zero, deviation_from_ideal | res(kOhm)=100,pol=up_scale,ps=599.34,es=0.299, ez=0.000175,%dev=0.02364 |
scaling_lead_wire_correction (all modes except strain_gage) | slope(m), intercept(b) | m=1987.3,b=3.123 |
scaling_lead_wire_correction (strain_gage mode only) | gage_factor, bridge_factor_corrected | gf=2.0,bfc=0.9784 |
Table 2: CAN data type parameters
SXR format string | Data type | Byte order |
---|---|---|
UMSB | Unsigned integer | MSB First (Motorola) |
ULSB | Unsigned integer | LSB First (Intel) |
SMSB | Signed integer | MSB First (Motorola) |
SLSB | Signed integer | LSB First (Intel) |
FMSB | IEEE Floating point | MSB First (Motorola) |
FLSB | IEEE Floating point | LSB First (Intel) |