OceanDirectPython 3.1.3
OceanDirect Python API
|
Subclass containing advanced features that may or may not be in the spectrometer. More...
Public Member Functions | |
__init__ (self, 'Spectrometer' device) | |
None | set_enable_lamp (self, bool enable) |
Enable or disable the lamp. | |
bool | get_enable_lamp (self) |
Return the lamp state. | |
None | set_shutter_open (self, bool shutterState) |
This function will open or close the shutter on the spectrometer. | |
None | get_shutter_state (self) |
This function returns the shutter state of the spectrometer. | |
list[float] | get_wavelength_coeffs (self) |
Read the wavelength coefficients from the device. | |
list[float] | get_nonlinearity_coeffs (self) |
Read the nonlinearity coefficients stored in the device. | |
int | get_nonlinearity_coeffs_count1 (self) |
Read the nonlinearity coefficients count from the device. | |
float | get_nonlinearity_coeffs1 (self, int index) |
Read the nonlinearity coefficients count of a given position from the device. | |
float | get_tec_temperature_degrees_C (self) |
Returns the temperature reading (celsius) of a detector thermistor. | |
None | set_temperature_setpoint_degrees_C (self, float temp_C) |
Apply the setpoint temperature (Celsius) in the thermo-electric cooler. | |
None | set_tec_enable (self, bool coolerEnable) |
Enable or disable the thermo-electric cooler attached to the detector. | |
bool | get_tec_enable (self) |
Read the state of the thermo-electric cooler whether it's enable or disable. | |
float | get_temperature_setpoint_degrees_C (self) |
Read the set point temperature of the thermo-electric cooler. | |
bool | get_tec_stable (self) |
Returns the state of thermo-electric cooler temperature on whether it reached the stable temperature or not. | |
bool | get_tec_fan_enable (self) |
Returns the thermo-electric cooler fan state whether it's enabled or not. | |
int | get_light_source_count (self) |
Gets the number of light sources that are represented by the given featureID. | |
bool | has_light_source_enable (self, int light_source_index) |
Queries whether the indicated light source within the given feature instance has a usable enable/disable control. | |
bool | is_light_source_enabled (self, int light_source_index) |
Queries whether the indicated light source within the given feature instance is enabled (energized). | |
None | enable_light_source (self, int light_source_index, bool enable) |
Attempts to enable or disable the indicated light source within the given feature instance. | |
None | set_single_strobe_enable (self, bool enable) |
Set the enable status of the single strobe signal. | |
None | set_single_strobe_delay (self, int delayMicrosecond) |
Set the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge. | |
None | set_single_strobe_width (self, int widthMicrosecond) |
Set the amount of time, in microseconds, that the single strobe pulse should remain high after it begins. | |
bool | get_single_strobe_enable (self) |
Get the enable status of the single strobe signal. | |
int | get_single_strobe_delay (self) |
Get the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge. | |
int | get_single_strobe_width (self) |
Get the amount of time, in microseconds, that the single strobe pulse should remain high after it begins. | |
int | get_light_source_count (self) |
Gets the number of light sources that are represented by the given featureID. | |
bool | has_light_source_enable (self, int light_source_index) |
Queries whether the indicated light source within the given feature instance has a usable enable/disable control. | |
bool | is_light_source_enabled (self, int light_source_index) |
Queries whether the indicated light source within the given feature instance is enabled (energized). | |
None | enable_light_source (self, int light_source_index, bool enable) |
Attempts to enable or disable the indicated light source within the given feature instance. | |
None | set_single_strobe_enable (self, bool enable) |
Set the enable status of the single strobe signal. | |
None | set_single_strobe_delay (self, int delayMicrosecond) |
Set the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge. | |
None | set_single_strobe_width (self, int widthMicrosecond) |
Set the amount of time, in microseconds, that the single strobe pulse should remain high after it begins. | |
bool | get_single_strobe_enable (self) |
Get the enable status of the single strobe signal. | |
int | get_single_strobe_delay (self) |
Get the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge. | |
int | get_single_strobe_width (self) |
Get the amount of time, in microseconds, that the single strobe pulse should remain high after it begins. | |
int | get_single_strobe_delay_minimum (self) |
Get the minimum amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge. | |
int | get_single_strobe_delay_maximum (self) |
Get the maximum amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge. | |
int | get_single_strobe_delay_increment (self) |
Gets the single strobe delay increment in microseconds. | |
int | get_single_strobe_width_minimum (self) |
Get the minimum amount of time, in microseconds, that the single strobe pulse should remain high after it begins. | |
int | get_single_strobe_width_maximum (self) |
Get the maximum amount of time, in microseconds, that the single strobe pulse should remain high after it begins. | |
int | get_single_strobe_width_increment (self) |
Get the single strobe width increment. | |
int | get_single_strobe_cycle_maximum (self) |
Gets the single strobe cycle maximum in microseconds. | |
None | set_continuous_strobe_period (self, int period) |
Sets the continuous strobe period in microseconds. | |
None | set_continuous_strobe_enable (self, bool enable) |
Sets the continuous strobe enable state on the device. | |
int | get_continuous_strobe_period (self) |
Get the continuous strobe period in microseconds. | |
bool | get_continuous_strobe_enable (self) |
Gets the continuous strobe state (enabled or disabled) of the device. | |
int | get_continuous_strobe_period_minimum (self) |
Gets the minimum continuous strobe period of the device in microseconds. | |
int | get_continuous_strobe_period_maximum (self) |
Gets the maximum continuous strobe period of the device in microseconds. | |
int | get_continuous_strobe_period_increment (self) |
This function gets the current size of the strobe period increment of the device in microseconds. | |
int | get_continuous_strobe_width (self) |
Gets the strobe width of the device in microseconds. | |
None | set_continuous_strobe_width (self, int widthMicrosecond) |
Sets the continuous strobe width on the device. | |
None | clear_data_buffer (self) |
Clear the data buffer. | |
int | get_data_buffer_number_of_elements (self) |
Get the number of data elements currently in the buffer. | |
int | get_data_buffer_capacity (self) |
Get the present limit of how many data elements will be retained by the buffer. | |
int | get_data_buffer_capacity_maximum (self) |
Get the maximum possible configurable size for the data buffer. | |
int | get_data_buffer_capacity_minimum (self) |
Get the minimum possible configurable size for the data buffer. | |
None | set_data_buffer_capacity (self, int capacity) |
Set the number of data elements that the buffer should retain. | |
None | set_data_buffer_enable (self, bool enable) |
Enable or disable data buffering. | |
bool | get_data_buffer_enable (self) |
Reads the device data buffering enable state. | |
None | abort_acquisition (self) |
Abort spectra acquisition and put the device into an idle state. | |
None | acquire_spectra_to_buffer (self) |
Start spectra acquisition. | |
bool | get_device_idle_state (self) |
Return device idle state. | |
int | get_number_of_backtoback_scans (self) |
Get the number of back-to-back scans. | |
None | set_number_of_backtoback_scans (self, int numScans) |
Set the number of spectra that the device will capture per trigger event. | |
int | get_raw_spectrum_with_metadata (self, list[list[float]] list_raw_spectra, list[int] list_timestamp, int buffer_size) |
Returns spectra with metadata information. | |
int | get_usb_endpoint_primary_out (self) |
This function returns the usb primary OUT endpoint for the type specified. | |
int | get_usb_endpoint_primary_in (self) |
This function returns the usb primary IN endpoint for the type specified. | |
int | get_usb_endpoint_secondary_out (self) |
This function returns the usb secondary OUT endpoint for the type specified. | |
int | get_usb_endpoint_secondary_in (self) |
This function returns the usb secondary IN endpoint for the type specified. | |
str | get_revision_firmware (self) |
Reads out the firmware revision from the device's internal memory if that feature is supported. | |
str | get_revision_fpga (self) |
Reads out the FPGA revision from the device's internal memory if that feature is supported. | |
str | get_revision_system (self) |
Reads out the System revision from the device's internal memory if that feature is supported. | |
bool | ipv4_is_dhcp_enabled (self, int ifNum) |
Check to see if DHCP (client) is enabled on the specified interface. | |
bool | ipv4_is_dhcp_enabled2 (self) |
None | ipv4_set_dhcp_enable (self, int ifNum, bool enabled) |
Turn the DHCP client on or off for the device on the specified interface. | |
None | ipv4_set_dhcp_enable2 (self, bool enabled) |
int | ipv4_get_number_of_ip_addresses (self, int ifNum) |
Get the number of IP addresses available on the specified interface. | |
int | ipv4_get_number_of_ip_addresses2 (self) |
tuple[list[int], int] | ipv4_read_ip_address (self, int ifNum, int addressIndex) |
Get the assigned ip address provided by the index of a particular interface. | |
tuple[list[int], int] | ipv4_read_ip_address2 (self, int addressIndex) |
None | ipv4_add_static_ip_address (self, int ifNum, list[int] ipAddress, int netmask) |
Add a static IP address to the specified interface. | |
None | ipv4_add_static_ip_address2 (self, list[int] ipAddress, int netmask) |
None | ipv4_delete_static_ip_address (self, int ifNum, int addressIndex) |
Delete a static IP address on the specified interface. | |
None | ipv4_delete_static_ip_address2 (self, int addressIndex) |
None | ipv4_set_default_gateway_ip_address (self, int ifNum, list[int] ipAddress) |
Set the default gateway IP address to the specified interface. | |
None | ipv4_set_default_gateway_ip_address2 (self, list[int] ipAddress) |
list[int] | ipv4_get_default_gateway_ip_address (self, int ifNum) |
Get the default gateway IP address to the specified interface. | |
list[int] | ipv4_get_default_gateway_ip_address2 (self) |
int | get_gpio_pin_count (self) |
Get GPIO pin count. | |
None | gpio_set_output_enable1 (self, int bit, bool isOutput) |
Sets the GPIO bit direction to either output or input. | |
bool | gpio_get_output_enable1 (self, int bit) |
Get GPIO bit direction. | |
None | gpio_set_output_enable2 (self, int bitmask) |
Set the direction (input/output) of the GPIO pins. | |
int | gpio_get_output_enable2 (self) |
Get all GPIO bit direction. | |
None | gpio_set_value1 (self, int bit, bool isHigh) |
Sets the GPIO bit value to either high or low. | |
bool | gpio_get_value1 (self, int bit) |
Get the GPIO bit value in whether it's high(true) or low(false). | |
None | gpio_set_value2 (self, int bitmask) |
Set the logic value for all GPIO pins. | |
int | gpio_get_value2 (self) |
Get all GPIO bit values. | |
None | gpio_set_output_alternate1 (self, int bit, bool isAlternate) |
Set the alternate functionality for the specified pins (bits). | |
None | gpio_set_output_alternate2 (self, int bitmask) |
Set the alternate functionality for the specified pins (bits). | |
bool | gpio_get_output_alternate1 (self, int bit) |
Get the setting for alternate functionality on the specified bit (pin). | |
int | gpio_get_output_alternate2 (self) |
Get the settings for alternate functionality on the GPIO pins. | |
None | set_led_enable (self, bool isEnabled) |
Enable or disable device LED. | |
bool | get_led_enable (self) |
Get device LED state. | |
int | get_device_original_vid (self) |
Get the original vendor id (VID) of the device. | |
int | get_device_original_pid (self) |
Get the original product id (PID) of the device. | |
int | get_device_vid (self) |
Get the current vendor id (VID) of the device. | |
int | get_device_pid (self) |
Get the current product id (PID) of the device. | |
str | get_device_original_manufacturer_string (self) |
Get the original manufacturer string of the device. | |
str | get_device_original_model_string (self) |
Get the original model string of the device. | |
str | get_device_manufacturer_string (self) |
Get the current manufacturer string of the device. | |
str | get_device_model_string (self) |
Get the current model string of the device. | |
None | set_device_manufacturer_string (self, str manufacturer) |
Set the current manufacturer string of the device. | |
None | set_device_model_string (self, str model) |
Set the current model string of the device. | |
str | get_device_alias (self) |
Read the device alias from the device. | |
None | set_device_alias (self, str deviceAlias) |
Set a new device alias to the device. | |
None | reset_device (self) |
Restarts the device. | |
str | get_user_string (self) |
Read the user string from the device. | |
None | set_user_string (self, str userString) |
Set a new user string to the device. | |
int | get_user_string_count1 (self) |
Read the total user string count from the device. | |
str | get_user_string1 (self, int index) |
Read the user string from the device. | |
None | set_user_string1 (self, int index, str userString) |
Write the user string to the device. | |
int | get_autonull_maximum_adc_count (self) |
Read the maximum ADC counts. | |
int | get_autonull_baseline_level (self) |
Read the baseline level. | |
int | get_autonull_saturation_level (self) |
Read the saturation level. | |
int | get_autonull_fpga_digital_gain (self) |
Read the fpga digital gain value. | |
int | get_autonull_fpga_digital_offset (self) |
Read the fpga digital gain offset. | |
tuple[int, int, float, float] | get_autonull_baseline_level_constraints (self) |
Read autonulling constraints value for baseline settings. | |
tuple[int, int, float, float] | get_autonull_saturation_level_constraints (self) |
Read autonulling constraints value for saturation settings. | |
int | get_baud_rate (self) |
Read the device RS-232 baud rate. | |
None | set_baud_rate (self, int baudRate) |
Set a new baud rate for the RS-232 port. | |
None | save_settings_to_flash (self) |
Save settings to flash. | |
list[int] | get_active_pixel_range (self) |
Read the active pixel range from the sensor pixel array. | |
list[int] | get_optical_dark_pixel_range (self) |
Read the optical dark pixel range from the sensor pixel array. | |
list[int] | get_transition_pixel_range (self) |
Read the transition pixel range from the sensor pixel array. | |
list[int] | get_bad_pixel_indices (self) |
Read bad pixel indices from the sensor pixel array. | |
None | set_bad_pixel_indices (self, list[int] badPixelIndices) |
Mark the given pixel indices as bad pixels. | |
int | get_network_interface_count (self) |
Read the number of supported communication interface. | |
int | get_network_interface_type (self, int interfaceIndex) |
Return the interface type of the given interface index. | |
int | get_network_interface_type2 (self) |
bool | get_network_interface_status (self, int interfaceIndex) |
Return true if the interface is enabled otherwise it's false. | |
bool | get_network_interface_status2 (self) |
None | set_network_interface_status (self, int interfaceIndex, bool enable) |
Enable or disable the interface. | |
None | set_network_interface_status2 (self, bool enable) |
None | save_network_interface_setting (self, int interfaceIndex) |
Save the network interface settings to the device. | |
None | save_network_interface_setting2 (self) |
bool | get_ethernet_gigabit_enable_status (self, int interfaceIndex) |
Return the status on whether the gigabit ethernet is enabled or not. | |
bool | get_ethernet_gigabit_enable_status2 (self) |
None | set_ethernet_gigabit_enable_status (self, int interfaceIndex, bool enable) |
Enable or disable the gigabit ethernet the status. | |
None | set_ethernet_gigabit_enable_status2 (self, bool enable) |
int | get_network_interface_count (self) |
Read the number of supported communication interface. | |
int | get_network_interface_type (self, int interfaceIndex) |
Return the interface type of the given interface index. | |
int | get_network_interface_type2 (self) |
bool | get_network_interface_status (self, int interfaceIndex) |
Return true if the interface is enabled otherwise it's false. | |
bool | get_network_interface_status2 (self) |
None | set_network_interface_status (self, int interfaceIndex, bool enable) |
Enable or disable the interface. | |
None | set_network_interface_status2 (self, bool enable) |
None | save_network_interface_setting (self, int interfaceIndex) |
Save the network interface settings to the device. | |
None | save_network_interface_setting2 (self) |
bool | get_ethernet_gigabit_enable_status (self, int interfaceIndex) |
Return the status on whether the gigabit ethernet is enabled or not. | |
bool | get_ethernet_gigabit_enable_status2 (self) |
None | set_ethernet_gigabit_enable_status (self, int interfaceIndex, bool enable) |
Enable or disable the gigabit ethernet the status. | |
None | set_ethernet_gigabit_enable_status2 (self, bool enable) |
bool | get_multicast_group_enabled (self, int interfaceIndex) |
Return true if the multicast group message is enabled otherwise it's false. | |
bool | get_multicast_group_enabled2 (self) |
None | set_multicast_group_enabled (self, int interfaceIndex, bool enable) |
Enable or disable the multicast message group. | |
None | set_multicast_group_enabled2 (self, bool enable) |
list[int] | get_ethernet_mac_address (self, int interfaceIndex) |
Read the ethernet 6-byte mac address from the spectrometer. | |
list[int] | get_ethernet_mac_address2 (self) |
None | set_ethernet_mac_address (self, int interfaceIndex, list[int] macAddress) |
Writes a new ethernet 6-byte mac address into the spectrometer. | |
None | set_ethernet_mac_address2 (self, list[int] macAddress) |
bool | get_ip_address_assigned_mode (self) |
Read the IP address mode from the OBP2 device. | |
None | set_ip_address_assigned_mode (self, bool useDHCP) |
Set the IP address mode to the OBP2 device. | |
tuple[bool, list[int], list[int], list[int], list[int]] | get_network_configuration (self) |
Read the network configuration parameters from an OBP2 enabled device. | |
None | set_manual_network_configuration (self, list[int] ipv4Address, list[int] subnetMask, list[int] defaultGateway, list[int] dnsServer) |
Write the network configuration parameters (static ip address) on OBP2 enabled device. | |
tuple[list[int], list[int], list[int], list[int]] | get_manual_network_configuration (self) |
Read the network configuration parameters (static ip address) from an OBP2 enabled device. | |
Public Attributes | |
device = device | |
Static Public Attributes | |
lamp_on = c_ubyte(1) | |
lamp_off = c_ubyte(0) | |
int | num_nonlinearity_coeffs = 8 |
Protected Attributes | |
_temperature_count = None | |
Subclass containing advanced features that may or may not be in the spectrometer.
The spectrometer specification guide (manual) should be consulted prior to using any of these features.
Definition at line 1364 of file OceanDirectAPI.py.
Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.__init__ | ( | self, | |
'Spectrometer' | device ) |
Definition at line 1373 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.abort_acquisition | ( | self | ) |
Abort spectra acquisition and put the device into an idle state.
To resume spectra acquisition, you have to call acquire_spectra_to_buffer() first before calling the get spectra command. Very few devices supported this command.
Definition at line 2274 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.acquire_spectra_to_buffer | ( | self | ) |
Start spectra acquisition.
This would transition the device into a non-idle state. Very few devices supported this command. An exception will be thrown if the command is not supported by the device.
Definition at line 2289 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.clear_data_buffer | ( | self | ) |
Clear the data buffer.
An exception will be thrown if the command is not supported by the device.
Definition at line 2159 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.enable_light_source | ( | self, | |
int | light_source_index, | ||
bool | enable ) |
Attempts to enable or disable the indicated light source within the given feature instance.
Not all light sources have an enable/disable control, and this capability can be queried with has_light_source_enable(). Note that an enabled light source should emit light according to its last (or default) intensity setting which might be the minimum; in this case, the light source might appear to remain off.
light_source_index | Which of potentially many light sources (LEDs, lasers, light bulbs) within the indicated feature instance to query. |
enable | Whether to enable the light source. A value of False will attempt to disable the light source, and any other value will enable it. |
Definition at line 1650 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.enable_light_source | ( | self, | |
int | light_source_index, | ||
bool | enable ) |
Attempts to enable or disable the indicated light source within the given feature instance.
Not all light sources have an enable/disable control, and this capability can be queried with has_light_source_enable(). Note that an enabled light source should emit light according to its last (or default) intensity setting which might be the minimum; in this case, the light source might appear to remain off.
light_source_index | Which of potentially many light sources (LEDs, lasers, light bulbs) within the indicated feature instance to query. |
enable | Whether to enable the light source. A value of False will attempt to disable the light source, and any other value will enable it. |
Definition at line 1818 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_active_pixel_range | ( | self | ) |
Read the active pixel range from the sensor pixel array.
This command is being used in OBP-2.0 enabled devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 3361 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_baseline_level | ( | self | ) |
Read the baseline level.
Definition at line 3226 of file OceanDirectAPI.py.
tuple[int, int, float, float] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_baseline_level_constraints | ( | self | ) |
Read autonulling constraints value for baseline settings.
This command only applies to Ocean FX/HDX units.
Definition at line 3283 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_fpga_digital_gain | ( | self | ) |
Read the fpga digital gain value.
Definition at line 3252 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_fpga_digital_offset | ( | self | ) |
Read the fpga digital gain offset.
Definition at line 3267 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_maximum_adc_count | ( | self | ) |
Read the maximum ADC counts.
Definition at line 3212 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_saturation_level | ( | self | ) |
Read the saturation level.
Most devices returns 65535.
Definition at line 3239 of file OceanDirectAPI.py.
tuple[int, int, float, float] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_autonull_saturation_level_constraints | ( | self | ) |
Read autonulling constraints value for saturation settings.
This command only applies to Ocean FX/HDX units.
Definition at line 3303 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_bad_pixel_indices | ( | self | ) |
Read bad pixel indices from the sensor pixel array.
This command is being used in OBP-2.0 enabled devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 3406 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_baud_rate | ( | self | ) |
Read the device RS-232 baud rate.
Not all devices supported this command.
Definition at line 3323 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_continuous_strobe_enable | ( | self | ) |
Gets the continuous strobe state (enabled or disabled) of the device.
Definition at line 2076 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_continuous_strobe_period | ( | self | ) |
Get the continuous strobe period in microseconds.
Definition at line 2062 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_continuous_strobe_period_increment | ( | self | ) |
This function gets the current size of the strobe period increment of the device in microseconds.
The increment is dependent on the strobe period. Small strobe periods i.e. less than about 1ms will have a small increment, typically 1 microsecond. Larger strobe periods will have larger increments, typically 1ms.
Definition at line 2116 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_continuous_strobe_period_maximum | ( | self | ) |
Gets the maximum continuous strobe period of the device in microseconds.
Definition at line 2103 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_continuous_strobe_period_minimum | ( | self | ) |
Gets the minimum continuous strobe period of the device in microseconds.
Definition at line 2090 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_continuous_strobe_width | ( | self | ) |
Gets the strobe width of the device in microseconds.
Definition at line 2132 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_data_buffer_capacity | ( | self | ) |
Get the present limit of how many data elements will be retained by the buffer.
This value can be changed with set_data_buffer_capacity(). An exception will be thrown if the command is not supported by the device.
Definition at line 2184 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_data_buffer_capacity_maximum | ( | self | ) |
Get the maximum possible configurable size for the data buffer.
An exception will be thrown if the command is not supported by the device.
Definition at line 2199 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_data_buffer_capacity_minimum | ( | self | ) |
Get the minimum possible configurable size for the data buffer.
An exception will be thrown if the command is not supported by the device.
Definition at line 2213 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_data_buffer_enable | ( | self | ) |
Reads the device data buffering enable state.
An exception will be thrown if the command is not supported by the device.
Definition at line 2260 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_data_buffer_number_of_elements | ( | self | ) |
Get the number of data elements currently in the buffer.
An exception will be thrown if the command is not supported by the device.
Definition at line 2170 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_alias | ( | self | ) |
Read the device alias from the device.
If this field in the device is not yet populated then a non-zero(6) code will be returned.
Definition at line 3081 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_idle_state | ( | self | ) |
Return device idle state.
Very few devices supported this command. An exception will be thrown if the command is not supported by the device.
Definition at line 2304 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_manufacturer_string | ( | self | ) |
Get the current manufacturer string of the device.
Definition at line 2983 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_model_string | ( | self | ) |
Get the current model string of the device.
Definition at line 2998 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_original_manufacturer_string | ( | self | ) |
Get the original manufacturer string of the device.
Definition at line 2955 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_original_model_string | ( | self | ) |
Get the original model string of the device.
Definition at line 2969 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_original_pid | ( | self | ) |
Get the original product id (PID) of the device.
Definition at line 2916 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_original_vid | ( | self | ) |
Get the original vendor id (VID) of the device.
Definition at line 2903 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_pid | ( | self | ) |
Get the current product id (PID) of the device.
Definition at line 2942 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_device_vid | ( | self | ) |
Get the current vendor id (VID) of the device.
Definition at line 2929 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_enable_lamp | ( | self | ) |
Return the lamp state.
Definition at line 1394 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ethernet_gigabit_enable_status | ( | self, | |
int | interfaceIndex ) |
Return the status on whether the gigabit ethernet is enabled or not.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
Definition at line 3529 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ethernet_gigabit_enable_status | ( | self, | |
int | interfaceIndex ) |
Return the status on whether the gigabit ethernet is enabled or not.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
Definition at line 3651 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ethernet_gigabit_enable_status2 | ( | self | ) |
Definition at line 3544 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ethernet_gigabit_enable_status2 | ( | self | ) |
Definition at line 3666 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ethernet_mac_address | ( | self, | |
int | interfaceIndex ) |
Read the ethernet 6-byte mac address from the spectrometer.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
Definition at line 3729 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ethernet_mac_address2 | ( | self | ) |
Definition at line 3751 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_gpio_pin_count | ( | self | ) |
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_ip_address_assigned_mode | ( | self | ) |
Read the IP address mode from the OBP2 device.
Definition at line 3781 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_led_enable | ( | self | ) |
Get device LED state.
If the device don't have an LED then an exception will be thrown.
Definition at line 2889 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_light_source_count | ( | self | ) |
Gets the number of light sources that are represented by the given featureID.
Such light sources could be individual LEDs, light bulbs, lasers, etc. Each of these light sources may have different capabilities, such as programmable intensities and enables, which should be queried before they are used.
Definition at line 1601 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_light_source_count | ( | self | ) |
Gets the number of light sources that are represented by the given featureID.
Such light sources could be individual LEDs, light bulbs, lasers, etc. Each of these light sources may have different capabilities, such as programmable intensities and enables, which should be queried before they are used.
Definition at line 1768 of file OceanDirectAPI.py.
tuple[list[int], list[int], list[int], list[int]] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_manual_network_configuration | ( | self | ) |
Read the network configuration parameters (static ip address) from an OBP2 enabled device.
This function will return a tuple of 4 objects in this order: list[int] - the static IP address. list[int] - the subnet mask. list[int] - the default gateway IP address. list[int] - the DNS server IP address.
Definition at line 3901 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_multicast_group_enabled | ( | self, | |
int | interfaceIndex ) |
Return true if the multicast group message is enabled otherwise it's false.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
Definition at line 3690 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_multicast_group_enabled2 | ( | self | ) |
Definition at line 3705 of file OceanDirectAPI.py.
tuple[bool, list[int], list[int], list[int], list[int]] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_configuration | ( | self | ) |
Read the network configuration parameters from an OBP2 enabled device.
This function will return a tuple of 6 objects in this order: address mode - True if it's using a DHCP IP address otherwise its False. list[int] - the static IP address. list[int] - the subnet mask. list[int] - the default gateway IP address. list[int] - the DNS server IP address.
Definition at line 3814 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_count | ( | self | ) |
Read the number of supported communication interface.
This function only applies to HDX/FX devices.
Definition at line 3445 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_count | ( | self | ) |
Read the number of supported communication interface.
This function only applies to HDX/FX devices.
Definition at line 3567 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_status | ( | self, | |
int | interfaceIndex ) |
Return true if the interface is enabled otherwise it's false.
This function only applies to HDX/FX devices.
interfaceIndex | The interface to look at. |
Definition at line 3475 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_status | ( | self, | |
int | interfaceIndex ) |
Return true if the interface is enabled otherwise it's false.
This function only applies to HDX/FX devices.
interfaceIndex | The interface to look at. |
Definition at line 3597 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_status2 | ( | self | ) |
Definition at line 3490 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_status2 | ( | self | ) |
Definition at line 3612 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_type | ( | self, | |
int | interfaceIndex ) |
Return the interface type of the given interface index.
This function only applies to HDX/FX devices.
interfaceIndex | The interface to look at. |
Definition at line 3458 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_type | ( | self, | |
int | interfaceIndex ) |
Return the interface type of the given interface index.
This function only applies to HDX/FX devices.
interfaceIndex | The interface to look at. |
Definition at line 3580 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_type2 | ( | self | ) |
Definition at line 3472 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_network_interface_type2 | ( | self | ) |
Definition at line 3594 of file OceanDirectAPI.py.
list[float] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_nonlinearity_coeffs | ( | self | ) |
Read the nonlinearity coefficients stored in the device.
This command is being used in OBP-2.0 enabled devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 1449 of file OceanDirectAPI.py.
float Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_nonlinearity_coeffs1 | ( | self, | |
int | index ) |
Read the nonlinearity coefficients count of a given position from the device.
This command is being used in legacy devices. If the device don't support this command then a non-zero error code will be returned. Use the function "get_nonlinearity_coeffs_count1()" to get the correct range of the index value.
index | A zero based value referring to the coefficient position. |
Definition at line 1479 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_nonlinearity_coeffs_count1 | ( | self | ) |
Read the nonlinearity coefficients count from the device.
This command is being used in legacy devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 1465 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_number_of_backtoback_scans | ( | self | ) |
Get the number of back-to-back scans.
See device manual if data buffering is supported.
Definition at line 2319 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_optical_dark_pixel_range | ( | self | ) |
Read the optical dark pixel range from the sensor pixel array.
This command is being used in OBP-2.0 enabled devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 3376 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_raw_spectrum_with_metadata | ( | self, | |
list[list[float]] | list_raw_spectra, | ||
list[int] | list_timestamp, | ||
int | buffer_size ) |
Returns spectra with metadata information.
For older devices such as FX/HDX, read a maximum of 15 spectra from the data buffer. This function requires that both back to back scans and data buffer be enabled. See "set_data_buffer_enable()" and "set_number_of_backtoback_scans()". For newer devices such as Ocean SR2, you can call this function right away. See device manual if this command is supported.
list_raw_spectra | The spectra output buffer. |
list_timestamp | The timestamp output buffer of each spectra. |
buffer_size | The buffer array size (maximum is 15). |
Definition at line 2347 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_revision_firmware | ( | self | ) |
Reads out the firmware revision from the device's internal memory if that feature is supported.
Definition at line 2442 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_revision_fpga | ( | self | ) |
Reads out the FPGA revision from the device's internal memory if that feature is supported.
Definition at line 2464 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_revision_system | ( | self | ) |
Reads out the System revision from the device's internal memory if that feature is supported.
Definition at line 2485 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_shutter_state | ( | self | ) |
This function returns the shutter state of the spectrometer.
Definition at line 1420 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_cycle_maximum | ( | self | ) |
Gets the single strobe cycle maximum in microseconds.
Definition at line 2014 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_delay | ( | self | ) |
Get the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
Definition at line 1738 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_delay | ( | self | ) |
Get the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
Definition at line 1905 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_delay_increment | ( | self | ) |
Gets the single strobe delay increment in microseconds.
Definition at line 1962 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_delay_maximum | ( | self | ) |
Get the maximum amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
Definition at line 1948 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_delay_minimum | ( | self | ) |
Get the minimum amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
Definition at line 1934 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_enable | ( | self | ) |
Get the enable status of the single strobe signal.
Note that on some devices the enable control is shared with other signals (e.g. lamp enable and continuous strobe) so this may have some side-effects and changing those features may affect the single strobe as well.
Definition at line 1721 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_enable | ( | self | ) |
Get the enable status of the single strobe signal.
Note that on some devices the enable control is shared with other signals (e.g. lamp enable and continuous strobe) so this may have some side-effects and changing those features may affect the single strobe as well.
Definition at line 1889 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_width | ( | self | ) |
Get the amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
Definition at line 1753 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_width | ( | self | ) |
Get the amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
Definition at line 1920 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_width_increment | ( | self | ) |
Get the single strobe width increment.
Definition at line 2001 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_width_maximum | ( | self | ) |
Get the maximum amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
Definition at line 1988 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_single_strobe_width_minimum | ( | self | ) |
Get the minimum amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
Definition at line 1975 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_tec_enable | ( | self | ) |
Read the state of the thermo-electric cooler whether it's enable or disable.
If this function is not supported by the device then an exception will be thrown.
Definition at line 1542 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_tec_fan_enable | ( | self | ) |
Returns the thermo-electric cooler fan state whether it's enabled or not.
Few devices have cooler fan. If this function is not supported by the device then an exception will be thrown.
Definition at line 1587 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_tec_stable | ( | self | ) |
Returns the state of thermo-electric cooler temperature on whether it reached the stable temperature or not.
If this function is not supported by the device then an exception will be thrown.
Definition at line 1573 of file OceanDirectAPI.py.
float Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_tec_temperature_degrees_C | ( | self | ) |
Returns the temperature reading (celsius) of a detector thermistor.
This is equivalent to calling get_temperature(index) where the "index" is a detector thermistor index. If this function is not supported by the device then an exception will be thrown.
Definition at line 1497 of file OceanDirectAPI.py.
float Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_temperature_setpoint_degrees_C | ( | self | ) |
Read the set point temperature of the thermo-electric cooler.
If this function is not supported by the device then an exception will be thrown.
Definition at line 1557 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_transition_pixel_range | ( | self | ) |
Read the transition pixel range from the sensor pixel array.
This command is being used in OBP-2.0 enabled devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 3391 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_usb_endpoint_primary_in | ( | self | ) |
This function returns the usb primary IN endpoint for the type specified.
If the type is not supported by the device, a zero is returned. 0 is normally the control endpoint. That value is not valid in this context.
Definition at line 2398 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_usb_endpoint_primary_out | ( | self | ) |
This function returns the usb primary OUT endpoint for the type specified.
If the type is not supported by the device, a zero is returned. 0 is normally the control endpoint. That value is not valid in this context.
Definition at line 2383 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_usb_endpoint_secondary_in | ( | self | ) |
This function returns the usb secondary IN endpoint for the type specified.
If the type is not supported by the device, a zero is returned. 0 is normally the control endpoint. That value is not valid in this context.
Definition at line 2428 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_usb_endpoint_secondary_out | ( | self | ) |
This function returns the usb secondary OUT endpoint for the type specified.
If the type is not supported by the device, a zero is returned. 0 is normally the control endpoint. That value is not valid in this context.
Definition at line 2413 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_user_string | ( | self | ) |
Read the user string from the device.
If this field in the device is not yet populated then a non-zero(6) code will be returned. This is the command supported for the newer OBP2.0 enabled devices.
Definition at line 3125 of file OceanDirectAPI.py.
str Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_user_string1 | ( | self, | |
int | index ) |
Read the user string from the device.
If this field in the device is not yet populated then a non-zero(6) code will be returned. If the device don't support this command then a non-zero error code will be returned. This command is used by legacy devices.
Definition at line 3175 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_user_string_count1 | ( | self | ) |
Read the total user string count from the device.
If the device don't support this command then a non-zero error code will be returned. This command is used by legacy devices.
Definition at line 3160 of file OceanDirectAPI.py.
list[float] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.get_wavelength_coeffs | ( | self | ) |
Read the wavelength coefficients from the device.
This command is being used in OBP-2.0 enabled devices. If the device don't support this command then a non-zero error code will be returned.
Definition at line 1433 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_get_output_alternate1 | ( | self, | |
int | bit ) |
Get the setting for alternate functionality on the specified bit (pin).
Not all spectrometers support this functionality.
bit | The GPIO bit or pin to set. |
Definition at line 2843 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_get_output_alternate2 | ( | self | ) |
Get the settings for alternate functionality on the GPIO pins.
Not all spectrometers support this functionality.
Definition at line 2860 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_get_output_enable1 | ( | self, | |
int | bit ) |
Get GPIO bit direction.
bit | The bit position. |
Definition at line 2714 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_get_output_enable2 | ( | self | ) |
Get all GPIO bit direction.
Definition at line 2742 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_get_value1 | ( | self, | |
int | bit ) |
Get the GPIO bit value in whether it's high(true) or low(false).
bit | The bit position. |
Definition at line 2770 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_get_value2 | ( | self | ) |
Get all GPIO bit values.
Definition at line 2798 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_set_output_alternate1 | ( | self, | |
int | bit, | ||
bool | isAlternate ) |
Set the alternate functionality for the specified pins (bits).
Not all spectrometers support this functionality.
bit | The GPIO bit or pin to set. |
isAlternate | Set true to enable the alternate functionality for the pin, false otherwise (pin is a GPIO pin). |
Definition at line 2812 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_set_output_alternate2 | ( | self, | |
int | bitmask ) |
Set the alternate functionality for the specified pins (bits).
Not all spectrometers support this functionality.
bitmask | The bits set to 1 to set enable the alternate functionality, 0 otherwise (pin is a GPIO pin). |
Definition at line 2828 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_set_output_enable1 | ( | self, | |
int | bit, | ||
bool | isOutput ) |
Sets the GPIO bit direction to either output or input.
bit | The bit position. |
isOutput | The bit value which could be true(output) or false(input). |
Definition at line 2700 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_set_output_enable2 | ( | self, | |
int | bitmask ) |
Set the direction (input/output) of the GPIO pins.
bitmask | The bit mask specifying the pin directions i.e. the nth bit set to 1 sets the nth pin to output. |
Definition at line 2729 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_set_value1 | ( | self, | |
int | bit, | ||
bool | isHigh ) |
Sets the GPIO bit value to either high or low.
bit | The bit position. |
isHigh | The bit value which could be true(high) or false(low). |
Definition at line 2756 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.gpio_set_value2 | ( | self, | |
int | bitmask ) |
Set the logic value for all GPIO pins.
bitmask | The bit mask specifying the logic level of each GPIO pin. |
Definition at line 2785 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.has_light_source_enable | ( | self, | |
int | light_source_index ) |
Queries whether the indicated light source within the given feature instance has a usable enable/disable control.
If this returns False (meaning no enable available) then calling enable_light_source() or is_light_source_enabled() is likely to result in an error.
light_source_index | Which of potentially many light sources (LEDs, lasers, light bulbs) within the indicated feature instance to query |
Definition at line 1616 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.has_light_source_enable | ( | self, | |
int | light_source_index ) |
Queries whether the indicated light source within the given feature instance has a usable enable/disable control.
If this returns False (meaning no enable available) then calling enable_light_source() or is_light_source_enabled() is likely to result in an error.
light_source_index | Which of potentially many light sources (LEDs, lasers, light bulbs) within the indicated feature instance to query |
Definition at line 1784 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_add_static_ip_address | ( | self, | |
int | ifNum, | ||
list[int] | ipAddress, | ||
int | netmask ) |
Add a static IP address to the specified interface.
The IP address is specified as 4 bytes in an array. The leading part of the IP address must contain the first element of the array, followed by the remaining parts in order to the last part of the IP address in the fourth element of the array. See device manual if TCP/IP connection is supported.
ifNum | The interface number: 0 for Ethernet, 1 for wi-fi. |
ipAddress | The static IP address to be added. This is 4-byte array data. |
netmask | An 8-bit network mask specifying the subnet of the network the device is on. |
Definition at line 2592 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_add_static_ip_address2 | ( | self, | |
list[int] | ipAddress, | ||
int | netmask ) |
Definition at line 2619 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_delete_static_ip_address | ( | self, | |
int | ifNum, | ||
int | addressIndex ) |
Delete a static IP address on the specified interface.
See device manual if TCP/IP connection is supported.
ifNum | The interface number: 0 for Ethernet, 1 for wi-fi. |
addressIndex | The index of the address to be deleted. |
Definition at line 2622 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_delete_static_ip_address2 | ( | self, | |
int | addressIndex ) |
Definition at line 2635 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_get_default_gateway_ip_address | ( | self, | |
int | ifNum ) |
Get the default gateway IP address to the specified interface.
See device manual if TCP/IP connection is supported.
ifNum | The network interface. 0 for ethernet, 1 for wifi. |
Definition at line 2663 of file OceanDirectAPI.py.
list[int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_get_default_gateway_ip_address2 | ( | self | ) |
Definition at line 2684 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_get_number_of_ip_addresses | ( | self, | |
int | ifNum ) |
Get the number of IP addresses available on the specified interface.
If DHCP is enabled on the specified interface then index 0 represents the DHCP address and the following addresses will be any static IP addresses. See device manual if TCP/IP connection is supported.
ifNum | The interface number: 0 for Ethernet, 1 for wi-fi. |
Definition at line 2544 of file OceanDirectAPI.py.
int Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_get_number_of_ip_addresses2 | ( | self | ) |
Definition at line 2561 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_is_dhcp_enabled | ( | self, | |
int | ifNum ) |
Check to see if DHCP (client) is enabled on the specified interface.
If DHCP is enabled then the device will be able to receive an IP address from a DHCP server in the network it is connected to. See device manual if TCP/IP connection is supported.
ifNum | The interface number: 0 for Ethernet, 1 for wi-fi. |
Definition at line 2506 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_is_dhcp_enabled2 | ( | self | ) |
Definition at line 2523 of file OceanDirectAPI.py.
tuple[list[int], int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_read_ip_address | ( | self, | |
int | ifNum, | ||
int | addressIndex ) |
Get the assigned ip address provided by the index of a particular interface.
See device manual if TCP/IP connection is supported.
ifNum | The network interface. 0 for ethernet, 1 for wifi. |
addressIndex | The location of the ip address. Starts with 0. |
Definition at line 2564 of file OceanDirectAPI.py.
tuple[list[int], int] Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_read_ip_address2 | ( | self, | |
int | addressIndex ) |
Definition at line 2589 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_set_default_gateway_ip_address | ( | self, | |
int | ifNum, | ||
list[int] | ipAddress ) |
Set the default gateway IP address to the specified interface.
See device manual if TCP/IP connection is supported.
ifNum | The interface number: 0 for Ethernet, 1 for wi-fi. |
ipAddress | The static IP address to be added. This is 4-byte array data. |
Definition at line 2638 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_set_default_gateway_ip_address2 | ( | self, | |
list[int] | ipAddress ) |
Definition at line 2660 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_set_dhcp_enable | ( | self, | |
int | ifNum, | ||
bool | enabled ) |
Turn the DHCP client on or off for the device on the specified interface.
See device manual if TCP/IP connection is supported.
ifNum | The interface number: 0 for Ethernet, 1 for wi-fi. |
enabled | False turns the DHCP client off. True turns the DHCP client on. |
Definition at line 2526 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.ipv4_set_dhcp_enable2 | ( | self, | |
bool | enabled ) |
Definition at line 2541 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.is_light_source_enabled | ( | self, | |
int | light_source_index ) |
Queries whether the indicated light source within the given feature instance is enabled (energized).
light_source_index | Which of potentially many light sources (LEDs, lasers, light bulbs) within the indicated feature instance to query. |
Definition at line 1634 of file OceanDirectAPI.py.
bool Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.is_light_source_enabled | ( | self, | |
int | light_source_index ) |
Queries whether the indicated light source within the given feature instance is enabled (energized).
light_source_index | Which of potentially many light sources (LEDs, lasers, light bulbs) within the indicated feature instance to query. |
Definition at line 1802 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.reset_device | ( | self | ) |
Restarts the device.
Definition at line 3114 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.save_network_interface_setting | ( | self, | |
int | interfaceIndex ) |
Save the network interface settings to the device.
This function only applies to HDX/FX devices.
interfaceIndex | The interface to saved to. |
Definition at line 3514 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.save_network_interface_setting | ( | self, | |
int | interfaceIndex ) |
Save the network interface settings to the device.
This function only applies to HDX/FX devices.
interfaceIndex | The interface to saved to. |
Definition at line 3636 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.save_network_interface_setting2 | ( | self | ) |
Definition at line 3526 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.save_network_interface_setting2 | ( | self | ) |
Definition at line 3648 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.save_settings_to_flash | ( | self | ) |
Save settings to flash.
Not all devices supported this command.
Definition at line 3350 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_bad_pixel_indices | ( | self, | |
list[int] | badPixelIndices ) |
Mark the given pixel indices as bad pixels.
This command only supported OceanNR, NIRQuest256, and NIRQuest512. If the device don't support this command then a non-zero error code will be returned.
badPixelIndices | The bad pixel indices data which is an array of int. |
Definition at line 3421 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_baud_rate | ( | self, | |
int | baudRate ) |
Set a new baud rate for the RS-232 port.
Not all devices supported this command.
baudRate | The baud rate value. |
Definition at line 3337 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_continuous_strobe_enable | ( | self, | |
bool | enable ) |
Sets the continuous strobe enable state on the device.
enable | A boolean used for denoting the desired state (on/off) of the continuous strobe generator. If the value of enable is nonzero, then the continuous strobe will operate. If the value of enable is zero, then the continuous strobe will stop. Note that on some devices the continuous strobe enable is tied to other enables (such as lamp enable or single strobe enable) which may cause side effects. |
Definition at line 2040 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_continuous_strobe_period | ( | self, | |
int | period ) |
Sets the continuous strobe period in microseconds.
period | The new period of the continuous strobe measured in microseconds |
Definition at line 2027 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_continuous_strobe_width | ( | self, | |
int | widthMicrosecond ) |
Sets the continuous strobe width on the device.
widthMicrosecond | The new width of the continuous strobe measured in microseconds. |
Definition at line 2146 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_data_buffer_capacity | ( | self, | |
int | capacity ) |
Set the number of data elements that the buffer should retain.
This function must be used with "set_number_of_backtoback_scans()". An exception will be thrown if the command is not supported by the device.
capacity | Limit on the number of data elements to store. This is bounded by what is returned by get_data_buffer_capacity_minimum() and get_data_buffer_capacity_maximum(). |
Definition at line 2227 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_data_buffer_enable | ( | self, | |
bool | enable ) |
Enable or disable data buffering.
An exception will be thrown if the command is not supported by the device.
enable | True enable the buffer. False disable the buffer. |
Definition at line 2243 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_device_alias | ( | self, | |
str | deviceAlias ) |
Set a new device alias to the device.
deviceAlias | The device alias. If value is empty then an exception will be thrown. |
Definition at line 3096 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_device_manufacturer_string | ( | self, | |
str | manufacturer ) |
Set the current manufacturer string of the device.
manufacturer | The new manufacturer string. |
Definition at line 3013 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_device_model_string | ( | self, | |
str | model ) |
Set the current model string of the device.
model | The new model string. |
Definition at line 3029 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_enable_lamp | ( | self, | |
bool | enable ) |
Enable or disable the lamp.
enable | True to enable lamp, False otherwise. |
Definition at line 1377 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ethernet_gigabit_enable_status | ( | self, | |
int | interfaceIndex, | ||
bool | enable ) |
Enable or disable the gigabit ethernet the status.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
enable | True will enable gigabit ethernet. |
Definition at line 3547 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ethernet_gigabit_enable_status | ( | self, | |
int | interfaceIndex, | ||
bool | enable ) |
Enable or disable the gigabit ethernet the status.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
enable | True will enable gigabit ethernet. |
Definition at line 3669 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ethernet_gigabit_enable_status2 | ( | self, | |
bool | enable ) |
Definition at line 3564 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ethernet_gigabit_enable_status2 | ( | self, | |
bool | enable ) |
Definition at line 3686 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ethernet_mac_address | ( | self, | |
int | interfaceIndex, | ||
list[int] | macAddress ) |
Writes a new ethernet 6-byte mac address into the spectrometer.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
macAddress | The new mac address which is 6-byte long. |
Definition at line 3754 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ethernet_mac_address2 | ( | self, | |
list[int] | macAddress ) |
Definition at line 3777 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_ip_address_assigned_mode | ( | self, | |
bool | useDHCP ) |
Set the IP address mode to the OBP2 device.
useDHCP | True will use DHCP server for ip assignment. False will use statically assigned IP address. |
Definition at line 3796 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_led_enable | ( | self, | |
bool | isEnabled ) |
Enable or disable device LED.
If the device don't have an LED then an exception will be thrown.
isEnabled | True to enable LED blinking otherwise it's False. |
Definition at line 2876 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_manual_network_configuration | ( | self, | |
list[int] | ipv4Address, | ||
list[int] | subnetMask, | ||
list[int] | defaultGateway, | ||
list[int] | dnsServer ) |
Write the network configuration parameters (static ip address) on OBP2 enabled device.
ipv4Address | The static IP address. |
subnetMask | The subnet mask. |
defaultGateway | The default gateway IP address. |
dnsServer | The DNS server IP address. |
Definition at line 3860 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_multicast_group_enabled | ( | self, | |
int | interfaceIndex, | ||
bool | enable ) |
Enable or disable the multicast message group.
This function only applies to HDX/FX devices.
interfaceIndex | The ethernet interface to look at. |
enable | True will enable multicast message group. |
Definition at line 3708 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_multicast_group_enabled2 | ( | self, | |
bool | enable ) |
Definition at line 3725 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_network_interface_status | ( | self, | |
int | interfaceIndex, | ||
bool | enable ) |
Enable or disable the interface.
This function only applies to HDX/FX devices.
interfaceIndex | The interface that will be enabled or disabled. |
enable | True will enable the interface. False will disable it. |
Definition at line 3493 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_network_interface_status | ( | self, | |
int | interfaceIndex, | ||
bool | enable ) |
Enable or disable the interface.
This function only applies to HDX/FX devices.
interfaceIndex | The interface that will be enabled or disabled. |
enable | True will enable the interface. False will disable it. |
Definition at line 3615 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_network_interface_status2 | ( | self, | |
bool | enable ) |
Definition at line 3511 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_network_interface_status2 | ( | self, | |
bool | enable ) |
Definition at line 3633 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_number_of_backtoback_scans | ( | self, | |
int | numScans ) |
Set the number of spectra that the device will capture per trigger event.
This function requires data buffer to be enabled. See "set_data_buffer_enable()". See device manual if data buffering is supported.
numScans | The back-to-back scan value. |
Definition at line 2333 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_shutter_open | ( | self, | |
bool | shutterState ) |
This function will open or close the shutter on the spectrometer.
shutterState | True will open the shutter. False will then close the shutter. |
Definition at line 1408 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_single_strobe_delay | ( | self, | |
int | delayMicrosecond ) |
Set the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
delayMicrosecond | The delay, in microseconds, that the single strobe should wait before the pulse begins. |
Definition at line 1692 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_single_strobe_delay | ( | self, | |
int | delayMicrosecond ) |
Set the amount of time, in microseconds, that should elapse after a starting event before the single strobe should have a rising edge.
delayMicrosecond | The delay, in microseconds, that the single strobe should wait before the pulse begins. |
Definition at line 1859 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_single_strobe_enable | ( | self, | |
bool | enable ) |
Set the enable status of the single strobe signal.
Note that on some devices the enable control is shared with other signals (e.g. lamp enable and continuous strobe) so this may have some side-effects and changing those features may affect the single strobe as well.
enable | True to enable single strobe otherwise use False. |
Definition at line 1672 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_single_strobe_enable | ( | self, | |
bool | enable ) |
Set the enable status of the single strobe signal.
Note that on some devices the enable control is shared with other signals (e.g. lamp enable and continuous strobe) so this may have some side-effects and changing those features may affect the single strobe as well.
enable | True to enable single strobe otherwise use False. |
Definition at line 1840 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_single_strobe_width | ( | self, | |
int | widthMicrosecond ) |
Set the amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
widthMicrosecond | The duration, in microseconds, of the single strobe pulse after the rising edge occurs. Once this duration elapses, a falling edge will be generated. |
Definition at line 1706 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_single_strobe_width | ( | self, | |
int | widthMicrosecond ) |
Set the amount of time, in microseconds, that the single strobe pulse should remain high after it begins.
widthMicrosecond | The duration, in microseconds, of the single strobe pulse after the rising edge occurs. Once this duration elapses, a falling edge will be generated. |
Definition at line 1874 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_tec_enable | ( | self, | |
bool | coolerEnable ) |
Enable or disable the thermo-electric cooler attached to the detector.
If this function is not supported by the device then an exception will be thrown.
coolerEnable | True to enable the cooler, False otherwise. |
Definition at line 1528 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_temperature_setpoint_degrees_C | ( | self, | |
float | temp_C ) |
Apply the setpoint temperature (Celsius) in the thermo-electric cooler.
If this function is not supported by the device then an exception will be thrown.
temp_C | The setpoint temperature in celsius. |
Definition at line 1513 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_user_string | ( | self, | |
str | userString ) |
Set a new user string to the device.
The maximum string length is 16. This is the command supported for the newer OBP2.0 enabled devices.
userString | The user string. If value is empty then an exception will be thrown. |
Definition at line 3141 of file OceanDirectAPI.py.
None Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.set_user_string1 | ( | self, | |
int | index, | ||
str | userString ) |
Write the user string to the device.
The maximum string length is 16. If the device don't support this command then a non-zero error code will be returned. This command is used by legacy devices.
index | The user string index. If index is less than 0 then an exception will be thrown. |
userString | The user string. If value is empty then an exception will be thrown. |
Definition at line 3192 of file OceanDirectAPI.py.
|
protected |
Definition at line 1375 of file OceanDirectAPI.py.
Python.oceandirect.OceanDirectAPI.Spectrometer.Advanced.device = device |
Definition at line 1374 of file OceanDirectAPI.py.
|
static |
Definition at line 1370 of file OceanDirectAPI.py.
|
static |
Definition at line 1369 of file OceanDirectAPI.py.
|
static |
Definition at line 1371 of file OceanDirectAPI.py.