Package: rOmniDriver 0.1.20
rOmniDriver: Omni Driver R wrapper
This package is a wrapper of the OmniDriver java driver for Ocean Optics spectrometers.
Authors:
rOmniDriver_0.1.20.tar.gz
rOmniDriver_0.1.20.zip(r-4.5)rOmniDriver_0.1.20.zip(r-4.4)rOmniDriver_0.1.20.zip(r-4.3)
rOmniDriver_0.1.20.tgz(r-4.4-any)rOmniDriver_0.1.20.tgz(r-4.3-any)
rOmniDriver_0.1.20.tar.gz(r-4.5-noble)rOmniDriver_0.1.20.tar.gz(r-4.4-noble)
rOmniDriver_0.1.20.tgz(r-4.4-emscripten)rOmniDriver_0.1.20.tgz(r-4.3-emscripten)
rOmniDriver.pdf |rOmniDriver.html✨
rOmniDriver/json (API)
NEWS
| # Install 'rOmniDriver' in R: |
| install.packages('rOmniDriver', repos = c('https://aphalo.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/aphalo/romnidriver/issues
Last updated 3 months agofrom:cc32daf307. Checks:OK: 1 NOTE: 6. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Nov 01 2024 |
| R-4.5-win | NOTE | Nov 01 2024 |
| R-4.5-linux | NOTE | Nov 01 2024 |
| R-4.4-win | NOTE | Nov 01 2024 |
| R-4.4-mac | NOTE | Nov 01 2024 |
| R-4.3-win | NOTE | Nov 01 2024 |
| R-4.3-mac | NOTE | Nov 01 2024 |
Exports:close_all_spectrometersget_api_versionget_benchget_board_temperatureget_boxcar_widthget_calibration_coefficients_from_bufferget_calibration_coefficients_from_eepromget_correct_for_detector_nonlinearyget_correct_for_electrical_darkget_correct_for_stray_lightget_detectorget_detector_temperatureget_feature_controller_board_temperatureget_feature_controller_internal_triggerget_feature_controller_saturation_thresholdget_feature_detector_temperatureget_feature_I2C_busget_feature_irradiance_calibration_factorget_feature_pixel_binningget_feature_spectrum_typeget_feature_SPI_busget_firmware_modelget_firmware_versionget_I2C_busget_integration_timeget_irradiance_calibration_factorsget_last_exceptionget_maximum_integration_timeget_maximum_intensityget_micro_time_deltaget_micro_time_delta_sinceget_milli_time_deltaget_milli_time_delta_sinceget_minimum_integration_timeget_nameget_nano_time_deltaget_nano_time_delta_sinceget_number_of_channelsget_number_of_dark_pixelsget_number_of_enabled_channelsget_number_of_pixelsget_scans_to_averageget_scans_to_avgget_seconds_time_deltaget_seconds_time_delta_sinceget_serial_numberget_spectrumget_trigger_periodget_trigger_period_valid_rangeget_trigger_sourceget_wavelengthsget_wrapper_extensionshighSpdAcq_allocate_bufferhighSpdAcq_get_number_of_spectra_acquiredhighSpdAcq_get_spectrumhighSpdAcq_get_time_stamphighSpdAcq_start_acquisitioninit_apiinit_extended_apiinit_highres_time_apiinit_srsis_api_enabledis_channel_enabledis_extended_api_enabledis_feature_supported_board_temperatureis_feature_supported_detector_temperatureis_feature_supported_I2C_busis_feature_supported_internal_triggeris_feature_supported_irradiance_calibration_factoris_feature_supported_pixel_binningis_feature_supported_saturation_thresholdis_feature_supported_spectrum_typeis_feature_supported_SPI_busis_highres_time_api_enabledis_saturatedis_spectrum_validis_timeoutis_USB_timeoutnumber_srsoo_timestamp_to_stringopen_all_spectrometersset_boxcar_widthset_correct_for_detector_nonlinearityset_correct_for_electrical_darkset_I2C_busset_integration_timeset_scans_to_averageset_scans_to_avgset_timeoutset_trigger_periodset_trigger_sourceset_USB_timeoutspectrum_flushsrs_closestop_averaging
Dependencies:rJava
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| rOmniDriver: Omni Driver R wrapper | rOmniDriver-package rOmniDriver |
| close all open connections to spectrometers | close_all_spectrometers srs_close |
| Get OmniDriver API version | get_api_version |
| Get optical properties of optical bench | get_bench |
| Get current setting of boxcar width | get_boxcar_width |
| Get calibration coefficients from buffer | get_calibration_coefficients_from_buffer |
| Get calibration coefficients from EEPROM | get_calibration_coefficients_from_eeprom |
| Get current setting of linearity correction (enabled or not) | get_correct_for_detector_nonlineary |
| Get current setting for electrical dark correction | get_correct_for_electrical_dark |
| Get current setting of stray light correction | get_correct_for_stray_light |
| Get description of detector | get_detector |
| Get feature "saturation threshold" | get_feature_controller_saturation_threshold |
| Get feature controller "I2C Bus" | get_feature_I2C_bus |
| Get feature "pixel binning" | get_feature_pixel_binning |
| Get feature "spectrum type" | get_feature_spectrum_type |
| Get feature controller "SPI Bus" | get_feature_SPI_bus |
| Get name of spectrometer | get_firmware_model |
| Get spectrometer firmware version | get_firmware_version |
| Talk to "I2C bus" | get_I2C_bus set_I2C_bus |
| Get integration time | get_integration_time |
| Get OmniDriver last exception | get_last_exception |
| Get maximum integration time | get_maximum_integration_time |
| Get maximum intensity | get_maximum_intensity |
| Get minimum integration time | get_minimum_integration_time |
| Get name of spectrometer | get_name |
| Get number of channels | get_number_of_channels |
| Get number of dark pixels | get_number_of_dark_pixels |
| Get number of enabled channels | get_number_of_enabled_channels |
| Get total number of pixels in CCD array | get_number_of_pixels |
| Get "number of scans to average" | get_scans_to_average get_scans_to_avg |
| Get time difference between time stamps | get_micro_time_delta get_milli_time_delta get_nano_time_delta get_seconds_time_delta |
| Get time difference since a time stamp | get_micro_time_delta_since get_milli_time_delta_since get_nano_time_delta_since get_seconds_time_delta_since |
| Get serial number of spectrometer | get_serial_number |
| Get a spectrum from the spectrometer | get_spectrum |
| Talk to "SPI bus" | get_SPI_bytes |
| Get wavelengths from spectrometer | get_wavelengths |
| Get OmniDriver wrapper extensions | get_wrapper_extensions |
| Allocate memory buffer for high speed acquisition | highSpdAcq_allocate_buffer |
| Get the number of spectra acquired at high speed | highSpdAcq_get_number_of_spectra_acquired |
| Get one spectrum acquired at high speed | highSpdAcq_get_spectrum |
| Get the time stamp of one spectrum acquired at high speed | highSpdAcq_get_time_stamp |
| Start high speed acquisition | highSpdAcq_start_acquisition |
| Initialize the connection to the driver | init_api init_extended_api init_highres_time_api init_srs is_api_enabled is_extended_api_enabled is_highres_time_api_enabled |
| Informs whether a channel is enbled or not | is_channel_enabled |
| Feature "Board temperature" | get_board_temperature get_feature_controller_board_temperature is_feature_supported_board_temperature |
| Feature "detector temperature" | get_detector_temperature get_feature_detector_temperature is_feature_supported_detector_temperature |
| Is feature "I2C Bus" supported? | is_feature_supported_I2C_bus |
| Feature "ìnternal trigger" | get_feature_controller_internal_trigger get_trigger_period get_trigger_period_valid_range get_trigger_source is_feature_supported_internal_trigger set_trigger_period set_trigger_source |
| Feature "Irradiance Calibration Factor" | get_feature_irradiance_calibration_factor get_irradiance_calibration_factors is_feature_supported_irradiance_calibration_factor |
| Is feature "pixel binning" supported? | is_feature_supported_pixel_binning |
| Is feature "saturation threshold" supported? | is_feature_supported_saturation_threshold |
| Is feature "spectrum type" supported? | is_feature_supported_spectrum_type |
| Is feature "SPI Bus" supported? | is_feature_supported_SPI_bus |
| Is the most recent spectrum acquired saturated? | is_saturated |
| Is the most recent spectrum acquired valid? | is_spectrum_valid |
| Did the last operation time out? | is_timeout |
| Did the last USB operation time out? | is_USB_timeout |
| Convert time stamp to string | oo_timestamp_to_string |
| Opens connections to all spectrometers | number_srs open_all_spectrometers |
| Set "boxcar width" | set_boxcar_width |
| Set "correct for detector nonlinearity" | set_correct_for_detector_nonlinearity |
| Set "correct for electrical dark signal" | set_correct_for_electrical_dark |
| Set "integration time" | set_integration_time |
| Set "number of scans to average" | set_scans_to_average set_scans_to_avg |
| Set "spectrum type" | set_spectrum_type |
| Set (trigger) "timeout" | set_timeout |
| Set USB "timeout" | set_USB_timeout |
| Flush the most recent spectrum | spectrum_flush |
| Stop averaging of scans | stop_averaging |
