python-seabreeze
python-seabreeze is the easy way to access your Ocean Optics spectrometers from python. It wraps the SeaBreeze library provided by Ocean Optics to communicate with the spectrometer. If SeaBreeze is not available it can fallback to a pyUSB based reimplementation.
Attention
This software is not associated with Ocean Optics. Use it at your own risk.
It’s recommended to read the Installing python-seabreeze section, the Quickstart Guide and the API documentation. Also check out the Contributing Guide if you want to learn how to contribute to the project. A changelog is available here.
python-seabreeze module structure
python-seabreeze in the wild
python-seabreeze is used in many labs around the world. One of the cool examples was
a student project measuring fluorescence spectra (#17) with a
Spark spectrometer controlled by a raspberry pi zero, which was sent to the International
Space Station on the SpaceX CRS-14 resupply mission. (space proof softwareTM)
Tip
If you use python-seabreeze in your project let me know about it and I’ll add it here :)
projects
python-seatease by @jonathanvanschenck - a software emulator of python-seabreeze. Emulates seabreeze’s behavior so for testing my code without access to a spectrometer.
python-seabreeze-server by @jonathanvanschenck - a TCP-based server to host the seabreeze.cseabreeze backend, allowing multiple clients (potentially offsite) to interact with a single spectrometer.
SeaBreeze - Ocean Optics’ SeaBreeze C library.
libseabreeze - github clone of the C library. (out-dated. has pre-built libraries if you know what you’re doing)
python-seabreeze-feedstock - anaconda feedstock for automated package deployment.
yaqd-seabreeze - A seabreeze interface for the yaq instrument control framework
SpectraSorter - Software for droplet sorting based on the analysis of high-speed spectrophotometer (OceanFX) measurements (written in C#, not using python-seabreeze)
Contents
Introduction:
Development:
- API Reference
- spectrometers
- list_devices
- Spectrometer
SpectrometerSpectrometer.__init__()Spectrometer.from_first_available()Spectrometer.from_serial_number()Spectrometer.wavelengths()Spectrometer.intensities()Spectrometer.max_intensitySpectrometer.spectrum()Spectrometer.integration_time_micros()Spectrometer.integration_time_micros_limitsSpectrometer.trigger_mode()Spectrometer.serial_numberSpectrometer.modelSpectrometer.pixelsSpectrometer.featuresSpectrometer.fSpectrometer.open()Spectrometer.close()
- SeaBreezeError
- spectrometers
- Backend API Reference
- cseabreeze
- SeaBreezeAPI
- SeaBreezeDevice
- SeaBreezeFeatures
SeaBreezeFeatureSeaBreezeRawUSBBusAccessFeatureSeaBreezeSpectrometerFeatureSeaBreezeSpectrometerFeature.get_electric_dark_pixel_indices()SeaBreezeSpectrometerFeature.get_integration_time_micros_limits()SeaBreezeSpectrometerFeature.get_intensities()SeaBreezeSpectrometerFeature.get_maximum_intensity()SeaBreezeSpectrometerFeature.get_wavelengths()SeaBreezeSpectrometerFeature.set_integration_time_micros()SeaBreezeSpectrometerFeature.set_trigger_mode()
SeaBreezePixelBinningFeatureSeaBreezePixelBinningFeature.binning_factorSeaBreezePixelBinningFeature.default_binning_factorSeaBreezePixelBinningFeature.get_binning_factor()SeaBreezePixelBinningFeature.get_default_binning_factor()SeaBreezePixelBinningFeature.get_max_binning_factor()SeaBreezePixelBinningFeature.max_binning_factorSeaBreezePixelBinningFeature.set_binning_factor()SeaBreezePixelBinningFeature.set_default_binning_factor()
SeaBreezeThermoElectricFeatureSeaBreezeIrradCalFeatureSeaBreezeEthernetConfigurationFeatureSeaBreezeMulticastFeatureSeaBreezeIPv4FeatureSeaBreezeIPv4Feature.add_ipv4_address()SeaBreezeIPv4Feature.delete_ipv4_address()SeaBreezeIPv4Feature.get_default_gateway()SeaBreezeIPv4Feature.get_dhcp_enable_state()SeaBreezeIPv4Feature.get_ipv4_address()SeaBreezeIPv4Feature.get_number_of_ipv4_addresses()SeaBreezeIPv4Feature.set_default_gateway()SeaBreezeIPv4Feature.set_dhcp_enable_state()
SeaBreezeDHCPServerFeatureSeaBreezeNetworkConfigurationFeatureSeaBreezeNetworkConfigurationFeature.get_network_interface_connection_type()SeaBreezeNetworkConfigurationFeature.get_network_interface_enable_state()SeaBreezeNetworkConfigurationFeature.get_number_of_network_interfaces()SeaBreezeNetworkConfigurationFeature.run_network_interface_self_test()SeaBreezeNetworkConfigurationFeature.save_network_interface_connection_settings()SeaBreezeNetworkConfigurationFeature.set_network_interface_enable_state()
SeaBreezeWifiConfigurationFeatureSeaBreezeWifiConfigurationFeature.get_wifi_mode()SeaBreezeWifiConfigurationFeature.get_wifi_security_type()SeaBreezeWifiConfigurationFeature.get_wifi_ssid()SeaBreezeWifiConfigurationFeature.set_wifi_mode()SeaBreezeWifiConfigurationFeature.set_wifi_pass_phrase()SeaBreezeWifiConfigurationFeature.set_wifi_security_type()SeaBreezeWifiConfigurationFeature.set_wifi_ssid()
SeaBreezeGPIOFeatureSeaBreezeGPIOFeature.get_egpio_available_modes()SeaBreezeGPIOFeature.get_egpio_current_mode()SeaBreezeGPIOFeature.get_egpio_output_vector_vector()SeaBreezeGPIOFeature.get_egpio_value()SeaBreezeGPIOFeature.get_gpio_output_enable_vector()SeaBreezeGPIOFeature.get_gpio_value_vector()SeaBreezeGPIOFeature.get_number_of_egpio_pins()SeaBreezeGPIOFeature.get_number_of_gpio_pins()SeaBreezeGPIOFeature.set_egpio_mode()SeaBreezeGPIOFeature.set_egpio_output_vector()SeaBreezeGPIOFeature.set_egpio_value()SeaBreezeGPIOFeature.set_gpio_output_enable_vector()SeaBreezeGPIOFeature.set_gpio_value_vector()
SeaBreezeEEPROMFeatureSeaBreezeLightSourceFeatureSeaBreezeLightSourceFeature.get_count()SeaBreezeLightSourceFeature.get_intensity()SeaBreezeLightSourceFeature.has_enable()SeaBreezeLightSourceFeature.has_variable_intensity()SeaBreezeLightSourceFeature.is_enabled()SeaBreezeLightSourceFeature.set_enable()SeaBreezeLightSourceFeature.set_intensity()
SeaBreezeStrobeLampFeatureSeaBreezeContinuousStrobeFeatureSeaBreezeShutterFeatureSeaBreezeNonlinearityCoefficientsFeatureSeaBreezeTemperatureFeatureSeaBreezeIntrospectionFeatureSeaBreezeSpectrumProcessingFeatureSeaBreezeRevisionFeatureSeaBreezeOpticalBenchFeatureSeaBreezeOpticalBenchFeature.get_coating()SeaBreezeOpticalBenchFeature.get_fiber_diameter_microns()SeaBreezeOpticalBenchFeature.get_filter()SeaBreezeOpticalBenchFeature.get_grating()SeaBreezeOpticalBenchFeature.get_id()SeaBreezeOpticalBenchFeature.get_serial_number()SeaBreezeOpticalBenchFeature.get_slit_width_microns()
SeaBreezeStrayLightCoefficientsFeatureSeaBreezeDataBufferFeatureSeaBreezeDataBufferFeature.clear()SeaBreezeDataBufferFeature.get_buffer_capacity()SeaBreezeDataBufferFeature.get_buffer_capacity_maximum()SeaBreezeDataBufferFeature.get_buffer_capacity_minimum()SeaBreezeDataBufferFeature.get_number_of_elements()SeaBreezeDataBufferFeature.remove_oldest_spectra()SeaBreezeDataBufferFeature.set_buffer_capacity()
SeaBreezeFastBufferFeatureSeaBreezeAcquisitionDelayFeatureSeaBreezeAcquisitionDelayFeature.delay_microsecondsSeaBreezeAcquisitionDelayFeature.get_delay_increment_microseconds()SeaBreezeAcquisitionDelayFeature.get_delay_microseconds()SeaBreezeAcquisitionDelayFeature.get_maximum_delay_microseconds()SeaBreezeAcquisitionDelayFeature.get_minimum_delay_microseconds()SeaBreezeAcquisitionDelayFeature.set_delay_microseconds()
SeaBreezeI2CMasterFeature
- pyseabreeze
- SeaBreezeAPI
- SeaBreezeDevice
- SeaBreezeFeatures
SeaBreezeFeatureSeaBreezeRawUSBBusAccessFeatureSeaBreezeSpectrometerFeatureSeaBreezePixelBinningFeatureSeaBreezeThermoElectricFeatureSeaBreezeIrradCalFeatureSeaBreezeEthernetConfigurationFeatureSeaBreezeMulticastFeatureSeaBreezeIPv4FeatureSeaBreezeDHCPServerFeatureSeaBreezeNetworkConfigurationFeatureSeaBreezeWifiConfigurationFeatureSeaBreezeGPIOFeatureSeaBreezeEEPROMFeatureSeaBreezeLightSourceFeatureSeaBreezeStrobeLampFeatureSeaBreezeContinuousStrobeFeatureSeaBreezeShutterFeatureSeaBreezeNonlinearityCoefficientsFeatureSeaBreezeTemperatureFeatureSeaBreezeIntrospectionFeatureSeaBreezeSpectrumProcessingFeatureSeaBreezeRevisionFeatureSeaBreezeOpticalBenchFeatureSeaBreezeStrayLightCoefficientsFeatureSeaBreezeDataBufferFeatureSeaBreezeFastBufferFeatureSeaBreezeAcquisitionDelayFeatureSeaBreezeI2CMasterFeature
- cseabreeze