ICOtronic Package Documentation

ICOtronic is a Python library (based on python-can) for the ICOtronic system. The main purpose of the software is data collection:

• directly via the API or

• the script icon.

The software reads data from a Stationary Transceiver Unit (STU) via CAN using the MyTooliT protocol. The STU itself reads from and writes data to a sensor node via Bluetooth.

• Requirements
  • Hardware
    • Setup
  • Software
    • Python
    • PCAN Driver
      • Linux
      • macOS
      • Windows
• Install
  • Install the Package Using Windows Terminal
  • Install the Development Version of ICOtronic
• Data Collection
  • Sensor Node Identifiers
  • Collecting Data
  • Measurement Data
    • Adding Custom Metadata
• Tutorials
  • Changing Configuration Values
    • Changing the CAN Device (Channel) Name
    • Changing the CAN Interface Name
  • ICOn CLI Tool
    • Help
    • Listing Available Sensor Nodes
    • Collecting Measurement Data
      • Specifying the Sensor Hardware
      • Changing the Run Time
      • Channel Selection
      • Changing the Reference Voltage
      • Changing the Sampling Rate
    • Renaming a Sensor Node
    • Opening the User Configuration
    • STU Commands
      • Retrieve the Bluetooth STU MAC Address
      • Reset STU
      • Determining Data Loss
• Virtualization
  • Windows Subsystem for Linux 2
• Containerization
  • Docker on Linux
    • Creating a Docker Image
    • Building the Docker Image
    • Using ICOtronic in the Docker Container
• Troubleshooting
  • Import Errors
  • Insufficient Rights
  • Unable to Locate HDF5
  • HDF5 Library Not Loaded
  • Unable to open OpenBLAS library
  • Unknown Command
• API
  • Usage
    • Connection
      • Connecting to STU
      • Connecting to Sensor Node
    • Streaming
      • Reading Data
      • Collecting Multiple Values
      • Converting Data Values
      • Storing Data
      • Determining Data Loss
        • Bad Connection
        • Slow Processing of Data
    • Auxiliary Functionality
      • Reading Names
      • Changing ADC Configuration
      • Changing Channel Configuration
  • Classes & Functions
    • Connection
      • Connection
        • Connection.__aenter__()
    • Nodes
      • STU
        • STU.activate_bluetooth()
        • STU.collect_sensor_nodes()
        • STU.connect_sensor_node()
        • STU.connect_with_mac_address()
        • STU.connect_with_number()
        • STU.deactivate_bluetooth()
        • STU.get_available_nodes()
        • STU.get_mac_address()
        • STU.get_name()
        • STU.get_rssi()
        • STU.get_sensor_nodes()
        • STU.is_connected()
      • SensorNode
        • SensorNode.get_adc_configuration()
        • SensorNode.get_energy_mode_lowest()
        • SensorNode.get_energy_mode_reduced()
        • SensorNode.get_mac_address()
        • SensorNode.get_name()
        • SensorNode.get_rssi()
        • SensorNode.get_sensor_configuration()
        • SensorNode.get_streaming_data_single()
        • SensorNode.get_supply_voltage()
        • SensorNode.open_data_stream()
        • SensorNode.set_adc_configuration()
        • SensorNode.set_energy_mode_lowest()
        • SensorNode.set_energy_mode_reduced()
        • SensorNode.set_name()
        • SensorNode.set_sensor_configuration()
        • SensorNode.start_streaming_data()
        • SensorNode.stop_streaming_data()
      • STH
        • STH.activate_acceleration_self_test()
        • STH.deactivate_acceleration_self_test()
        • STH.get_acceleration_conversion_function()
        • STH.get_acceleration_sensor_range_in_g()
        • STH.get_acceleration_voltage()
    • Streaming
      • AsyncStreamBuffer
        • AsyncStreamBuffer.dataloss()
        • AsyncStreamBuffer.reset_stats()
      • StreamingConfiguration
        • StreamingConfiguration.axes()
        • StreamingConfiguration.data_length()
        • StreamingConfiguration.enabled_channels()
        • StreamingConfiguration.first
        • StreamingConfiguration.second
        • StreamingConfiguration.third
      • StreamingData
        • StreamingData.apply()
    • Measurement
      • Data
        • DataPoint
          • DataPoint.counter
          • DataPoint.timestamp
          • DataPoint.value
        • ChannelData
          • ChannelData.__add__()
          • ChannelData.append()
          • ChannelData.values()
        • MeasurementData
          • MeasurementData.append()
          • MeasurementData.apply()
          • MeasurementData.dataloss()
          • MeasurementData.extend()
          • MeasurementData.first()
          • MeasurementData.second()
          • MeasurementData.third()
          • MeasurementData.values()
        • Conversion
      • Storage
        • Storage
          • Storage.close()
          • Storage.open()
        • StorageData
          • StorageData.add_measurement_data()
          • StorageData.add_streaming_data()
          • StorageData.dataloss()
          • StorageData.dataloss_stats()
          • StorageData.measurement_time()
          • StorageData.sampling_frequency()
          • StorageData.write_sample_rate()
          • StorageData.write_sensor_range()
    • ADC
      • ADCConfiguration
        • ADCConfiguration.acquisition_time
        • ADCConfiguration.oversampling_rate
        • ADCConfiguration.prescaler
        • ADCConfiguration.reference_voltage
        • ADCConfiguration.sample_rate()
    • Sensor Configuration
      • SensorConfiguration
        • SensorConfiguration.check()
        • SensorConfiguration.disable_channel()
        • SensorConfiguration.empty()
        • SensorConfiguration.first
        • SensorConfiguration.requires_channel_configuration_support()
        • SensorConfiguration.second
        • SensorConfiguration.streaming_configuration()
        • SensorConfiguration.third
  • Examples
• Development
  • Requirements
  • Install
  • Style
  • Tests
    • Code Checks
      • Flake8
      • mypy
      • Pylint
    • Automatic Tests
      • Usage
    • Manual Tests
      • Check the Performance of the Library
    • Combined Checks & Tests
  • Release