Ocean Optics NeoFox Engineering Note - Manual (Page 12)

NeoFox Communication Interfaces
12 013-20000-010-04-201211
Parameter Name Type Range Param Type Address V1
DLL ParamType Constant Set Function Get Function
• Parameter Name – The name of the parameter, as you will find it throughout this document and others that
describe the NeoFox.
• Type – The data type of the parameter.
• Range – The valid range of values for the parameter or value. For writable parameters, developers should
ensure that the values written are within the acceptable range. For readable parameters, the developer should
consider values that are outside of the given range invalid.
• Param Type – The parameter code, which is used in the both the DLL interface and the serial interface. In
the DLL, this value is passed to DeviceGetParameter as the ParamType argument in order to read a value
and it is passed to DeviceSetParameter as the ParamType argument in order to set a value. In the serial
protocol, it serves as the ParamType code within a command message to set a parameter.
• Address V1 -- The address for the parameter within the serial interface’s readback “data dump”. This
address is only valid for protocol version 1 (ie: the ProtocolRev field = 1). Future versions of the protocol
may have parameters located at different addresses.
• DLL ParamType Constant – The constant which has been defined in the NeoFoxDLL.h file to represent
the ParamType code for this parameter.
• Set Function – The DLL function to call in order to set the parameter.
• Get Function – The DLL function to call in order to read the parameter.
Percent Oxygen Float 0
≤ X
20 740
NEOFOX_OXYGEN Read-Only DeviceGetParameterFloat
The Percent Oxygen parameter is the partial pressure of oxygen, expressed as percent of 1 ATM. Note that it does not
actually represent the concentration of oxygen relative to ambient pressure. The Percent Oxygen option produced by the
Converted Oxygen parameter can be used to represent the concentration of ambient pressure.
Converted Oxygen
Float 0
≤ X
23 864
NEOFOX_OXYGEN_CONVERTED Read-Only DeviceGetParameterFloat
Converted oxygen is the current oxygen reading, converted from percent of 1ATM to an alternate unit. The Oxygen Units
parameter documentation has more information about which units are available.
Oxygen Units
Uint Enum 152 488
NEOFOX_OXYGEN_UNITS DeviceSetParameter DeviceGetParameter
Sets the unit type for the Converted Oxygen parameter.
The
Ambient pressure is measured in the electronics unit itself. Therefore, the percent oxygen concentration value will be
incorrect if the ambient pressure of the electronics unit and the ambient pressure of the probe's environment are not the
same. See
NeoFox Calibration and Measurement for more information about the converted oxygen parameters.
Value Units Description DLL Constant
0 Percent of 1 ATM Gaseous – Partial Pressure NEOFOX_O2_UNITS_PERCENT_
PARTIAL_PRESSURE
1 Parts per Million Dissolved – Concentration NEOFOX_O2_UNITS_DO_PPM
4 Torr Gaseous – Partial Pressure NEOFOX_O2_UNITS_TORR
7
8 Micro Mole per Liter
Percent Concentration Dissolved – Concentration
Gaseous – Concentration
NEOFOX_O2_UNITS_UMOL_L
NEOFOX_O2_UNITS_PERCENT_
CONCENTRATION