Icoc

General

- Remove support for Python 3.9

API

- Removed dependency to `pint` library. All measurement code now returns numbers instead of objects of the `pint` class `Quantity` again.

Measurement

- The method `convert_raw_to_g` now returns a float instead of a `Quantity`.

Network

- Removed the coroutines:

- `read_streaming_data_seconds` and
- `read_streaming_data_amount`

Please just use `open_data_stream` and `async for`, if you want to replace code that used these coroutines.

- Added the coroutine `shutdown` again: You can use this method, if you want to shutdown the bus manually

Storage

- The storage class now only acts as an context manager for the class that modifies the data itself (`StorageData`). You now need to provide the format of the axis data when you first open the storage class instead of later in the process, when you add data. Overall the process of storing acceleration data as HDF5 file should be simpler and less error prone due to the new design.
- You can now also use the class to work with already existing HDF5 files.

Streaming

- We **changed the interface (data structure) for accessing streaming data** to [improve the performance](https://github.com/MyTooliT/ICOc/issues/40) when working with the high frequency data of the ICOtronic system.

- Add the amount of lost messages to the data returned by the iterator over the streaming data

- Raise an exception if the amount of buffered streaming messages exceeds a certain value (currently one second worth of streaming data).

**Note:** A large buffer indicates that the application is not able to keep up
with the current rate of retrieved messages and therefore the probability of
losing messages is quite high.

- Removed the class `TimestampedValue`

Documentation

- Add basic [API documentation](https://icoc.readthedocs.io)

Scripts

ICOc

- Handle encoding in error messages (Issue [58](https://github.com/MyTooliT/ICOc/issues/58))

ICOn

Rename

- Handle timeouts properly (Issue [59](https://github.com/MyTooliT/ICOc/issues/59))

Internal

Streaming

- Fix out of bound access error for “Stop Stream” messages

Scripts

ICOc

- Handle empty channel configuration e.g. something like

sh
icoc -1 0 -2 0 -3 0 -n Test-STH


- Handle empty channel configuration in UI

ICOn

- Handle empty channel configuration e.g. something like

sh
icon measure -1 0 -2 0 -3 0 -n Test-STH


Internal

CAN

- Add support for [`python-can`](https://pypi.org/project/python-can/) version `4.4`

Streaming

- Ignore streaming messages without any data bytes

Documentation

- Remove release notes from [official (bookdown) documentation](https://mytoolit.github.io/ICOc/)

If you are interest in the updates between releases:

- please visit the [GitHub release page](https://github.com/mytoolit/ICOc/releases) or
- take a look into the directory `Documentation/Releases`

ICOn

Measure

- Add support for specifying the channel configuration for the measurement

Internal

Network

- The Network class now raises a `CANInitError` (a subclass of `NetworkError`), when it is unable to initialize the CAN connection instead of a more general `NetworkError`.
- Make sure CAN bus is shutdown properly in error scenarios. This update should get rid of warning messages, such as “PcanBus was not properly shut down”.

Sensor Configuration

- Add check for correct init arguments
- Add method to check if sensor configuration requires hardware that supports channel configuration

STU- Test

- The STU test now tries to fix CAN communication problems, after flashing a new firmware on the chip. This fix should get rid of the bus error that might occur otherwise:


Bus error: an error counter reached the 'heavy'/'warning' limit


and might cause problems in in other tests afterwards.

ICOn

- Moved code into `scripts` directory
- ICOn now handles timeout problems while streaming data ([50](https://github.com/MyTooliT/ICOc/issues/50))

Linting

- We now check the whole codebase with [Pylint](https://github.com/PyCQA/pylint)

Internal

Network

- The `network` class now handles timeout problems when streaming data. If no streaming data arrives for a specified amount of time, then a `StreamingTimeoutError` will be raised.

Documentation

- Added very basic [example code](https://mytoolit.github.io/ICOc/#code-examples)

Docker

- Removed (references to) Docker Hub images, since nobody used them anyway
- Removed `Dockerfile` for Alpine Linux
- Use virtual environment for ICOc install in `Dockerfile` for Ubuntu

ICOn

Measurement

- Add timestamp to measurement filename (Issue [48](https://github.com/MyTooliT/ICOc/issues/48))
- Use default value for acceleration sensor range (Issue [47](https://github.com/MyTooliT/ICOc/issues/47))
- Add options for ADC configuration values:
- prescaler,
- acquisition time,
- oversampling rate, and
- reference voltage
- Use `0` as value for infinite runtime (option `-t/--time`) (Issue [49](https://github.com/MyTooliT/ICOc/issues/49))

Linting

- We now check the codebase – currently only for errors – with [Pylint](https://github.com/PyCQA/pylint)

Logging

- Log files are now stored in the user log directory (of the current OS) instead of the current working directory

Internal

Package

- Merged Python modules for sensor code

- `mytoolit.can.sensor`
- `mytoolit.measurement.sensor`

into `mytoolit.measurement.sensor`

- Moved `EEPROMStatus` definition from `mytoolit.eeprom.eeprom_status` into `mytoolit.eeprom.status`

Storage

- Add method `dataloss` to determine amount of measurement data loss