|
Veethree D7 SDK
|
Analog sensor interfaces.
The Analog module provides interfaces for working with analog sensors and signals. It supports reading various types of analog sensors, including voltage, resistance, and temperature.
Key classes:
The Analog module uses a profile-based architecture, where each sensor is configured with a profile that defines its characteristics and how readings should be processed.
Usage pattern:
See Analog Examples for a usage examples of the analog module.
Classes | |
| class | vsdk::io::analog::analog |
| This object represents a set of user specified analog sensors that are connected to the NAFE. More... | |
| struct | vsdk::io::analog::function_channel |
| Representation of a NAFE channel. These are required by sensors. More... | |
| struct | vsdk::io::analog::sensor |
| Represents a sensor. More... | |
| class | vsdk::io::profile_builder |
| This is used to provide a valid profile for the analog class. More... | |
Typedefs | |
| using | vsdk::io::analog::analog_profile = std::tuple<std::vector<sensor>, std::vector<function_channel>> |
| Representation of an analog profile. | |
Enumerations | |
| enum | vsdk::io::analog::viex_vi_t : uint8_t { voltage = 0x0 , current = 0x1 } |
| Excitation source (VIEX_VI) | |
| enum class | vsdk::io::analog::gain_offset_coeff_pair_t : uint8_t { vsdk::io::analog::gain_offset_coeff_pair_t::zero_pt_two = 0x0 , vsdk::io::analog::gain_offset_coeff_pair_t::zero_pt_four = 0x1 , vsdk::io::analog::gain_offset_coeff_pair_t::zero_pt_eight = 0x2 , vsdk::io::analog::gain_offset_coeff_pair_t::one = 0x3 , vsdk::io::analog::gain_offset_coeff_pair_t::two = 0x4 , vsdk::io::analog::gain_offset_coeff_pair_t::four = 0x5 , vsdk::io::analog::gain_offset_coeff_pair_t::eight = 0x6 , vsdk::io::analog::gain_offset_coeff_pair_t::sixteen = 0x7 } |
| Pointer to system gain and offset calibration register pairs. More... | |
| enum class | vsdk::io::analog::pga_gain_t : uint8_t { zero_pt_two = 0x0 , zero_pt_four = 0x1 , zero_pt_eight = 0x2 , one = 0x3 , two = 0x4 , four = 0x5 , eight = 0x6 , sixteen = 0x7 } |
| Channel pga gain. More... | |
| enum class | vsdk::io::analog::hv_sel_t : uint8_t { lvsig_in = 0x0 , hv_aip_hv_ain = 0x1 } |
| hv select | |
| enum class | vsdk::io::analog::lv_sig_in_t : uint8_t { ref_div_2_ref_div_2 = 0x0 , gpio0_gpio1 = 0x1 , ref_coarse_ref_div_2 = 0x2 , vadd_ref_div_2 = 0x3 , vhdd_ref_div_2 = 0x4 , ref_div_2_vhss = 0x5 } |
| lv sig selection | |
| enum class | vsdk::io::analog::hv_ain_t : uint8_t { gnd = 0x0 , ai1n = 0x1 , ai2n = 0x2 , ai3n = 0x3 , ai4n = 0x4 , refh = 0x5 , refl = 0x6 , aicom = 0x7 } |
| AIN Pin selection. | |
| enum class | vsdk::io::analog::hv_aip_t : uint8_t { gnd = 0x0 , ai1p = 0x1 , ai2p = 0x2 , ai3p = 0x3 , ai4p = 0x4 , refh = 0x5 , refl = 0x6 , aicom = 0x7 } |
| AIP Pin selection. | |
| enum class | vsdk::io::analog::pin_fn_t : uint8_t { none , reserved , voltage , resist_1_wr , resist_2_wr , resist_3_wr , resist_4_wr , thermocouple , v_calib_h , v_calib_l , r_calib_common , r_calib_unique , rw_calib_unique , cjc , rref } |
| Function of a given pin. | |
| enum class | vsdk::io::analog::pin_t : uint8_t { none , vrsns0 , vrsns1 , vrsns2 , vrsns3 , vrsns4 , vrsns5 , gpio0 , gpio1 , rref } |
| Pin designations. | |
| enum class | vsdk::io::analog::sensor_t : uint8_t { none , thermocouple_type_b , thermocouple_type_e , thermocouple_type_j , thermocouple_type_k , thermocouple_type_n , thermocouple_type_r , thermocouple_type_s , thermocouple_type_t , voltage , resist_1_wr , resist_2_wr , rtd_2_wr , rtd_3_wr , rtd_4_wr } |
| Supported sensor types. | |
| enum class | vsdk::io::analog::thermocouple_t : uint8_t { type_b , type_e , type_j , type_k , type_n , type_r , type_s , type_t } |
| Thermocouple type. | |
| enum | vsdk::io::analog::gpo_data_t : uint8_t { vsdk::io::analog::none = 0x0 , vsdk::io::analog::vrsns0 = 0xE , vsdk::io::analog::vrsns1 = 0xF , vsdk::io::analog::vrsns2 = 0xC , vsdk::io::analog::vrsns3 = 0xB , vsdk::io::analog::vrsns4 = 0x9 , vsdk::io::analog::vrsns5 = 0x8 , vsdk::io::analog::rref = 0xA } |
| GPO data settings. More... | |
Functions | |
| constexpr const char * | vsdk::io::analog::utility::to_string (pin_t pin) |
| constexpr const char * | vsdk::io::analog::utility::to_string (sensor_t sensor) |
| constexpr double | vsdk::io::analog::utility::to_value (pga_gain_t gain) |
Variables | |
| hv_ain_t | vsdk::io::analog::function_channel::hv_ain |
| Value for CH_CONFIG0 -> HV_AIN. | |
| hv_aip_t | vsdk::io::analog::function_channel::hv_aip |
| Value for CH_CONFIG0 -> HV_AIP. | |
| hv_sel_t | vsdk::io::analog::function_channel::hv_sel |
| Value for CH_CONFIG0 -> HV_HV_SEL. | |
| lv_sig_in_t | vsdk::io::analog::function_channel::lv_sig_in |
| Value for CH_CONFIG0 -> LVSIG_IN. | |
| gpo_data_t | vsdk::io::analog::function_channel::gpo_data |
| GPO data register assignment for a given channel. | |
| pin_fn_t | vsdk::io::analog::function_channel::function |
| Useful function type for calculations when reading values. | |
| gain_offset_coeff_pair_t | vsdk::io::analog::function_channel::gain_offset_pair |
| Choose the pointer index of a calibrated gain/offset coefficient pair. | |
| uint16_t | vsdk::io::analog::function_channel::excitation_source_magnitude |
| Excitation source magnitude. | |
| pga_gain_t | vsdk::io::analog::function_channel::pga_gain |
| viex_vi_t | vsdk::io::analog::function_channel::excitation_source |
| Excitation source. | |
| bool | vsdk::io::analog::function_channel::enable_ai1p_iexc |
| Enable excitation on AI1P. | |
| bool | vsdk::io::analog::function_channel::enable_vexc_routing |
| Enable vexc internal excitation routing. | |
| bool | vsdk::io::analog::function_channel::tcc_off |
| True to disable NXPs proprietary Temperature Coefficient Correction. | |
| std::string | vsdk::io::analog::sensor::label |
| User readable label to use when getting a handle. | |
| sensor_t | vsdk::io::analog::sensor::sensor {} |
| What type of sensor is this? | |
| std::vector< uint8_t > | vsdk::io::analog::sensor::channels |
| Define the virtual channels involved in the function. | |
Analog sensor interfaces.
The Analog module provides interfaces for working with analog sensors and signals. It supports reading various types of analog sensors, including voltage, resistance, and temperature.
Key classes:
The Analog module uses a profile-based architecture, where each sensor is configured with a profile that defines its characteristics and how readings should be processed.
Usage pattern:
See Analog Examples for a usage examples of the analog module.
| using vsdk::io::analog::analog_profile = std::tuple<std::vector<sensor>, std::vector<function_channel>> |
Representation of an analog profile.
Use the vsdk::io::profile_builder to configure a valid NAFE profile
|
strong |
Pointer to system gain and offset calibration register pairs.
| enum vsdk::io::analog::gpo_data_t : uint8_t |
|
strong |
Channel pga gain.
See: Table 29. 16-bit channel-based configuration
|
constexpr |
|
constexpr |
|
constexpr |
| uint16_t vsdk::io::analog::function_channel::excitation_source_magnitude |
Excitation source magnitude.
| gain_offset_coeff_pair_t vsdk::io::analog::function_channel::gain_offset_pair |
Choose the pointer index of a calibrated gain/offset coefficient pair.
| pga_gain_t vsdk::io::analog::function_channel::pga_gain |
PGA gain