Skip to content

Commit

Permalink
update changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
JW committed Sep 27, 2021
1 parent cea36a0 commit af771a1
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 34 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Added `infinite-iss-sensors-2s` `.hex` and `.data`
- Described more elegant way to change to user calliope
- Removed configuration for serial port, see issue #86
- provide result of iss sensors as csv
- increase MAX_LINE_LENGTH to 1000
- Switch display on and of with A button in iss-sensors.hex
- use compass in iss-sensors.hex without calibration
- optional calibration of compas by pressing A+B in iss-sensors.hex
- update .data files
- update testresults

## 1.2.0

Expand Down
68 changes: 34 additions & 34 deletions ProgramDescription.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,39 +128,39 @@ However, the minimum dependencies are documented in [requirements.txt](requireme

The installation, execution and de-installation process is documented in the [Readme.md](README.md)

### 5.1.6 The initial HEX file (30sec-iss-sensors.hex)
The initial HEX file provided with the upload of CalliopEO to the ISS is named `30sec-iss-sensors.hex`. The HEX file can be found in [./testcases/testfiles/](testcases/testfiles) and the source of the program can be found [here](testcases/testfiles/30sec-iss-sensors.js). The program is primarily meant to perform System Validation Tests to ensure propper functionality of hardware and software also remotely from Ground.
To execute `30sec-iss-sensors.hex` execute the following steps from the main directory (`~/calliopEO`):
```
# Copy the ZIp archive containing the 30sec-iss-sensors.hex to the main diretory
cp testcases/testfiles/30sec-iss-sensors.zip .
# Execute the Python script
./CalliopEO.py
```
The program runs for 30 seconds (programmable via the variable `runMaxSeconds`) and can be used to test the sensors as well as the buttons of the CalliopEO. The program polls the sensors and button state every second (programmable via the variable `updatePeriod`). The polling of individual sensors can be disabled via boolean variables (example: `testSCD30 = false`).
If `runMaxSeconds` is set to zero, the program runs infinite.
Due to the time needed to poll every sensor/actuator and to output the result over the serial port do not set `updatePeriod` to values below ~ 300 ms. Values for `updatePeriod` lower than 1000 ms however can be used to set the CalliopEO into a burst mode e.g. for an electromagnetic compatibility test.
To create a modified version of a HEX program derived from `30sec-iss-sensors.hex` copy/paste the content of the JavaScript source file [`30sec-iss-sensors.js`](testcases/testfiles/30sec-iss-sensors.js) to the Microsoft Mikrocode editor, apply the necessary changes and export the corresponding HEX file using the functions in Makecode. Create a ZIP archive from this HEX file, place it
in the main diretory and execute `CalliopEO.py`.
According to the current availability of drivers for the Calliope and the availability of sensors/actuators present on the CalliopEO hardware (some parts had to be removed or deactivated due to ISS safety regulations) the following sensors/actuators are supported:
* CalliopEO onboard temperature sensor
* CalliopEO onboard light sensor
* BMX055 accelerometer (x, y, z, total)
* SCD30 temperature, humidity and CO2 concentration
* SI1145 IR intensity, light intensity and UV index
* TCS34725 red, green, blue and white color values
* State of CalliopEO buttons A and B (pressed/not pressed)
* Test of the CalliopEO 5x5 LED matrix. In every cycle one more LED is set on of off.
### 5.1.6 The initial HEX file (30sec-iss-sensors.hex)

The initial HEX file provided with the upload of CalliopEO to the ISS is named `30sec-iss-sensors.hex`. The HEX file can be found in [./testcases/testfiles/](testcases/testfiles) and the source of the program can be found [here](testcases/testfiles/30sec-iss-sensors.js). The program is primarily meant to perform System Validation Tests to ensure propper functionality of hardware and software also remotely from Ground.

To execute `30sec-iss-sensors.hex` execute the following steps from the main directory (`~/calliopEO`):

```
# Copy the ZIp archive containing the 30sec-iss-sensors.hex to the main diretory
cp testcases/testfiles/30sec-iss-sensors.zip .
# Execute the Python script
./CalliopEO.py
```

The program runs for 30 seconds (programmable via the variable `runMaxSeconds`) and can be used to test the sensors as well as the buttons of the CalliopEO. The program polls the sensors and button state every second (programmable via the variable `updatePeriod`). The polling of individual sensors can be disabled via boolean variables (example: `testSCD30 = false`).

If `runMaxSeconds` is set to zero, the program runs infinite.

Due to the time needed to poll every sensor/actuator and to output the result over the serial port do not set `updatePeriod` to values below ~ 300 ms. Values for `updatePeriod` lower than 1000 ms however can be used to set the CalliopEO into a burst mode e.g. for an electromagnetic compatibility test.

To create a modified version of a HEX program derived from `30sec-iss-sensors.hex` copy/paste the content of the JavaScript source file [`30sec-iss-sensors.js`](testcases/testfiles/30sec-iss-sensors.js) to the Microsoft Mikrocode editor, apply the necessary changes and export the corresponding HEX file using the functions in Makecode. Create a ZIP archive from this HEX file, place it
in the main diretory and execute `CalliopEO.py`.

According to the current availability of drivers for the Calliope and the availability of sensors/actuators present on the CalliopEO hardware (some parts had to be removed or deactivated due to ISS safety regulations) the following sensors/actuators are supported:

* CalliopEO onboard temperature sensor
* CalliopEO onboard light sensor
* BMX055 accelerometer (x, y, z, total)
* SCD30 temperature, humidity and CO2 concentration
* SI1145 IR intensity, light intensity and UV index
* TCS34725 red, green, blue and white color values
* State of CalliopEO buttons A and B (pressed/not pressed)
* Test of the CalliopEO 5x5 LED matrix. In every cycle one more LED is set on of off.

### 5.2. Data transmission

The Calliope mini comes preinstalled with the experiments, so that it immediately can send data once connected and the CalliopEO.py script is executed, but no .zip file is directly available. However, this program is also part of the first ones to be uploaded from the Astro Pi, to check if the connectivity does work. In this case the programs for the Columbus Module Position (COL1A2/A3) and Window Position (Node 1/2 Nadir Hatch Window or any available Nadir facing Window) will run respectively in the order of the experiments. After the experiments have been run, the data files (as seen in 5.1.1) should be sent back as soon as possible.
Expand All @@ -171,4 +171,4 @@ The student experiments will be uploaded in the same way. Once programs that col
- A.1 [Dokumentation of CalliopeEO Phyton Script](README.md)
- A.2 [Example JavaScript code of the preinstalled file on the Calliope mini](testcases/testfiles/30sec-iss-sensors.js)
- A.3 [Example of saved Data file](testcases/testfiles/30sec-iss-sensors.hex.data)
- A.4 [Minimum requirements](requirements.txt)
- A.4 [Minimum requirements](requirements.txt)

0 comments on commit af771a1

Please sign in to comment.