Icoc

Checks

- We also check the code base with the static type checker [Mypy](https://mypy.readthedocs.io)

GitHub Actions

- We now also test ICOc on Ubuntu Linux

Package

- We now use the version number specified in the [init file of the package](https://github.com/MyTooliT/ICOc/blob/5490bce1/mytoolit/__init__.py) for the package version number.
- You can now also install the Package on Linux (and macOS)

Requirements

- The package now uses the `EUI` (Extended Unique Identifier) class of the [`netaddr`](https://netaddr.readthedocs.io) package to handle MAC addresses

Scripts

- We added a script that removes log and PDF files from the repository root. For more information please take a look at the section “Remove Log and PDF Files” of the [script documentation](https://github.com/MyTooliT/ICOc/blob/5490bce1/Documentation/Scripts.md).

STH Test

- The report of the STH test now also contains information about the used acceleration sensor (±100 g or ± 50 g)
- We added a [configuration item](https://github.com/MyTooliT/ICOc/blob/5490bce1/mytoolit/config/config.yaml) for the holder type (`STH` → `HOLDER TYPE`)
- We added the holder type and the serial number to the PDF report
- Removed extra space before and after headers in PDF report
- The PDF report now contains a list of tables with checkboxes for manual checks

Internal

Checkbox

- New `Flowable` class that can be used to add a checkbox to a PDF report

Command

- Add method `is_error` to check if the current command represents an error
- Add method `set_error` to set or unset the error bit

Identifier

- Add method `acknowledge` to retrieve expected acknowledgment identifier for id
- Add method `is_error` to check if the current identifier represents an error message
- Add method `set_error` to set or unset the error bit
- Support comparison with other identifiers (`==`)

Message

- The class now uses the class `Message` of python-can to store data instead of the class `TPCANMsg` of the PCAN-Basic API
- Add method `identifier` to receive an identifier object for the current message
- Add accessor to set and retrieve message data (`.data`)
- The method `acknowledge` now stores the data of the message in the acknowledgment message
- Fix conversion into `python-can` message for non-empty data field
- Add explanation to string representation for Bluetooth “Activate” and “Get number of available devices” [subcommand](https://mytoolit.github.io/Documentation/#value:bluetooth-subcommand)

Network (New)

- Add coroutine (`reset_node`) to reset a node in the network
- Add coroutine (`activate_bluetooth`) to activate Bluetooth on a node in the network
- Add coroutine (`get_available_devices_bluetooth`) to retrieve the number of available Bluetooth devices
- Add coroutine (`get_device_name_bluetooth`) to retrieve the Bluetooth advertisement name of a device
- Add coroutine (`connect_device_number_bluetooth`) to connect to a Bluetooth device using the device number
- Add coroutine (`deactivate_bluetooth`) to deactivate the Bluetooth connection of a node
- Add coroutine (`check_connection_device_bluetooth`) to check if a Bluetooth device is connected to a node
- Add coroutine (`get_mac_address_bluetooth`) to retrieve the MAC address of a connected Bluetooth device
- Implement context manager interface (`with … as`)
- The code now checks part of the acknowledgement data for the Bluetooth and reset commands of the `System` block

Report

- Add method `add_checkbox_list` to add a list of checkboxes at the end of the PDF report

Utility

- Add function `bytearray_to_text` to convert byte data to a string

Configuration

- We moved the [configuration file for the test scripts][config] into the `mytoolit` package.
- We moved the [configuration file for ICOc](https://github.com/MyTooliT/ICOc/blob/7035ff18/mytoolit/old/configKeys.xml) into the `mytoolit` package.
- We now use uppercase letters for all configuration keys in [`config.yaml`][config]. The reason behind this update is that we can overwrite these values using environment variables – with the prefix `DYNACONF_` – even on Windows. Unfortunately Windows [converts all environment variables to uppercase](https://www.dynaconf.com/configuration).

[config]: https://github.com/MyTooliT/ICOc/blob/7035ff18/mytoolit/config/config.yaml

Compatibility

- This version of ICOc requires at least Python `3.7`, since we use the `annotations` directive from the `__futures__` module

Package

- We added a [package description](https://github.com/MyTooliT/ICOc/blob/7035ff18/setup.py) for ICOc. You can now install the software using `pip install -e .` in the root of the repository. To uninstall the package use `pip uninstall icoc`.

Scripts

- We added a new EEPROM checking tool. For more information please take a look at the section “EEPROM Check” of the [script documentation](https://github.com/MyTooliT/ICOc/blob/7035ff18/Documentation/Scripts.md).

Internal

- We removed old hardware test code

Network (Old)

- Simplified code

Internal

Message

- Added method to convert message to python-can message object
- Renamed initialization attribute `payload` to `data`
- Added support to initialize a message object with a message object of [python-can]

[python-can]: https://python-can.readthedocs.io

Production Test

- The name of the PDF test report now reflects the tested node. The latest test data for the STH will be stored in a file called `STH Test.pdf`, while the STU test data is stored in a file called `STU Test.pdf`. Before this update both tests would use the file name `Report.pdf`.

STH Test

- We now always assume the name of the STH (`STH` → `Name`) in the [configuration][configuration file] is given as string. This improves the usability of the tests, since otherwise you might specify an integer as name (e.g. `1337`) and wonder why the test is unable to connect to the STH.
- The STH test now prints a message about a possible incorrect config value for the acceleration sensor (`STH` → `Acceleration Sensor` → `Sensor`), if [the self test of the accelerometer failed](https://github.com/MyTooliT/ICOc/issues/13).
- The STH test fails, if you use an sensor value (`STH` → `Acceleration Sensor` → `Sensor`) that is not one of the supported values

- `ADXL1001` or
- `ADXL1002`.

Tests

- We now check the code base with [flake8][].
- We use [GitHub actions](https://github.com/MyTooliT/ICOc/actions)
- to run non-hardware dependent parts of the automated tests, and
- to check the code base with [flake8][]

[flake8]: https://flake8.pycqa.org

Logging

- The [main CAN class](https://github.com/MyTooliT/ICOc/blob/d89c5a59/network.py) now logs the received CAN messages in a file called `can.log`, if you specify the level `DEBUG` in the [configuration file][].

[configuration file]: https://github.com/MyTooliT/ICOc/blob/d89c5a59/Configuration/config.yaml

STH Test

- The STH test case now skips the flash test if the status in the [configuration file](https://github.com/MyTooliT/ICOc/blob/d89c5a59/Configuration/config.yaml) (`STH` → `Status`) is set to `Epoxied`.
- The test now also supports the ±50 g digital accelerometer [ADXL1002](https://www.analog.com/media/en/technical-documentation/data-sheets/ADXL1001-1002.pdf). To choose which sensor is part of the STH (or SHA), please change the value `STH` → `Acceleration Sensor` → `Sensor` to the appropriate value in the [configuration file][].
- Removed the over the air (OTA) test, since it requires the command `ota-dfu`, which needs to be compiled first, and often does not work reliable.
- The [renaming of the STH in the EEPROM test](https://github.com/MyTooliT/ICOc/issues/10) should now work more reliable.

STU Test

- Add first version of [new test for the STU](https://github.com/MyTooliT/ICOc/blob/d89c5a59/mytoolit/test/production/stu.py). For more information, please take a look at the section “Production Tests” of the [main readme](https://github.com/MyTooliT/ICOc/blob/d89c5a59/ReadMe.md).

Documentation

- We added a [tutorial](https://github.com/MyTooliT/ICOc/blob/cdfed9f94c94cfe17ce42abc8db7a2130e4ede51/Documentation/Guidelines/Release.md) that explains the necessary steps for releasing a new version of ICOc

Configuration

- We moved the host and port configuration values of the [Matplotlib](https://matplotlib.org) GUI from the XML configuration file into the [YAML configuration](https://github.com/MyTooliT/ICOc/blob/8568893f/Configuration/config.yaml).

Documentation

- We documented how to execute the [automatic tests](https://github.com/MyTooliT/ICOc/blob/8568893f/Documentation/Guidelines/Test.md) for software.

STH Test

- The EEPROM tests now also writes the firmware release name (`STH` → `Firmware` → `Release Name` in the [configuration](https://github.com/MyTooliT/ICOc/blob/8568893f/Configuration/config.yaml)) into the EEPROM.
- The EEPROM test now sets the

- operating time,
- power on cycles,
- power off cycles,
- under voltage counter, and the
- watchdog reset counter

to `0`.