CHANGELOG.md 9.33 KB
Newer Older
Rahix's avatar
Rahix committed
1 2 3 4 5
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

Rahix's avatar
Rahix committed
6
## [Unreleased]
Rahix's avatar
Rahix committed
7
### Added
Rahix's avatar
Rahix committed
8 9
- **ws2812**: Connect Neopixels to the wristband GPIOs and make your card10
  even more colorful!
Rahix's avatar
Rahix committed
10 11
- `micropython.mem_use()` function.
- High-pass filter and pulse detection in default ECG app.
Rahix's avatar
Rahix committed
12 13
- `leds.get_rgb()`: Get the current color of an LED.
- `leds.get_rocket()`: Get the current brightness of one of the rockets.
Rahix's avatar
Rahix committed
14 15
- Actually added `uuid` module - it was not built into the firmware before,
  by accident.
Rahix's avatar
Rahix committed
16 17 18 19

### Changed
- **Pycardium**: Switched from `long-long` to `mpz` integer representation.
  This should resolve any issues with large numbers which had popped up so far.
Rahix's avatar
Rahix committed
20 21
- Made OpenOCD scripts work with more debuggers out of the box.
- Refactored BME680 sensor interface.
Rahix's avatar
Rahix committed
22 23 24 25

### Fixed
- Backlight and Vibration motor were not reset when switching apps.
- Mismatch in default settings of the *Card10 Nickname* app.
Rahix's avatar
Rahix committed
26 27
- Fixed the PMIC ADC muxer not being properly reset to neutral after a
  measurement.
Rahix's avatar
Rahix committed
28 29
- Fixed wrong timezone offset calculation in `utime.time_ms()`.
- Fixed bug where `\` characters were not parsed as path separators.
Rahix's avatar
Rahix committed
30 31 32 33 34


## [v1.9] - 2019-08-28 23:23 - [IcebergLettuce]
[IcebergLettuce]: https://card10.badge.events.ccc.de/release/card10-v1.9-IcebergLettuce.zip

35
### Added
Rahix's avatar
Rahix committed
36 37 38 39 40 41 42 43 44 45 46
- `tools/pycard10.py`: Tool to interact with card10's serial connection and
  upload files directly:
  ```bash
  ./tools/pycard10.py path/to/python-script.py
  ```
- `epic_disp_print_adv` & `Display.print(font=...)`: Print with different
  fonts!  The following fonts are supported: `8px`, `12px`, `16px`, `20px`,
  and `24px`.
- **pycardium**: Support for RAW REPL mode.
- **bhi160**: Function to disable all sensors (`bhi160.disable_all_sensors()`).
- `ls_cmsis_dap`: A tool to enumerate CMSIS-DAP debuggers.
Rahix's avatar
Rahix committed
47 48 49 50
- Tons of new features to `simple_menu`: Timeout, scrolling of long texts,
  robustness against crashes, and proper exiting.
- `card10.cfg` config file which allows enabling *ELF* files.
- Analog read for wristband GPIOs.
51

Rahix's avatar
Rahix committed
52
### Changed
Rahix's avatar
Rahix committed
53
- Refactored *menu* and *personal-state* apps.
Rahix's avatar
Rahix committed
54 55 56
- `main.py` was moved into an app to allow easier reconfiguration of the
  default app.  The new `main.py` points to the "old" one so behavior is not
  changed.
Rahix's avatar
Rahix committed
57
- After a timeout, the menu will close and `main.py` will run again.
Rahix's avatar
Rahix committed
58 59 60
- BLE security updates.
- More detailed battery state display in nickname app.
- Improved ECG app.
Rahix's avatar
Rahix committed
61 62 63 64 65 66

### Removed
- Some unused font files.

### Fixed
- Fixed a regression which made the ECG app no longer work.
Rahix's avatar
Rahix committed
67 68
- Fixed card10 advertising support for AT-commands.
- Rectangles being one pixel too small.
Rahix's avatar
Rahix committed
69

Rahix's avatar
Rahix committed
70 71 72 73 74


## [v1.8] - 2019-08-27 11:38 - [HabaneroChilli]
[HabaneroChilli]: https://card10.badge.events.ccc.de/release/card10-v1.8-HabaneroChilli.zip

Rahix's avatar
Rahix committed
75
### Added
Rahix's avatar
Rahix committed
76 77 78 79 80
- API-call for direct light-sensor readout: `epic_light_sensor_read`.
- Pause mode in ECG-App.
- `bin` field in metatdata for an alternate entrypoint.
- `shell.nix`: Nix-Shell which installs patched OpenOCD and dependencies.
- Cool LED animation in default ECG app.
Rahix's avatar
Rahix committed
81 82 83

### Changed
- No longer require locking the display for setting the backlight.
Rahix's avatar
Rahix committed
84 85 86


## [v1.7] - 2019-08-24 21:48 - [Garlic]
Rahix's avatar
Rahix committed
87 88
[Garlic]: https://card10.badge.events.ccc.de/release/card10-v1.7-Garlic.zip

Rahix's avatar
Rahix committed
89
### Added
Rahix's avatar
Rahix committed
90 91
- **ESB**: Epic Serial Bus (Better than USB!), stability improvements of the
  USB module.  Preparation for mass-storage access in the Firmware.
Rahix's avatar
Rahix committed
92
- Enabled the Hardware Watchdog;  Card10 will reset itself if the firmware crashes
Rahix's avatar
Rahix committed
93
- Log messages when BLE is pairing / connected.
Rahix's avatar
Rahix committed
94 95
- The name of the offending app is printed to the serial console, if an app
  crashes the metatdata parser.
Rahix's avatar
Rahix committed
96 97 98

### Changed
- Improved log messages in cases of lock-contention.
Rahix's avatar
Rahix committed
99
- Menu will show an error message if a crash occurs.
Rahix's avatar
Rahix committed
100 101

### Fixed
Rahix's avatar
Rahix committed
102
- Fixed race-conditions in serial writes by using a queue.
Rahix's avatar
Rahix committed
103
- "Card10 Nickname" crashing if only `nickname.txt` exists.
Rahix's avatar
Rahix committed
104 105 106
- Lockup when debug prints are enabled.
- Delayed BHI160 startup a bit so the PMIC task can check the battery first.
- Relaxed the PMIC lock-timeouts so other task can take a little more time.
Rahix's avatar
Rahix committed
107 108 109 110
- Fixed off-by-one error in `gfx_line()`.
- Fixed the API interrupts sometimes getting stuck.
- Fixed binary building on MacOS.
- Fixed race-conditions in serial console prints by introducing a queue.
Rahix's avatar
Rahix committed
111
- Fixed API & MAX30001 mutexes being initialized late sometimes.
Rahix's avatar
Rahix committed
112
- Fixed wrong stripe width in bi flag.
113 114 115


## [v1.6] - 2019-08-23 20:30 - [Fennel]
Rahix's avatar
Rahix committed
116 117
[Fennel]: https://card10.badge.events.ccc.de/release/card10-v1.6-Fennel.zip

Rahix's avatar
Rahix committed
118 119
- Maxim BLE SDK update

Rahix's avatar
Rahix committed
120
### Added
Rahix's avatar
Rahix committed
121
- **BLE**: Added personal state API to card10 SVC.
122 123
- **ECG**: Support for ECG + Python app
- **BLE**: Characteristic to read the time
Rahix's avatar
Rahix committed
124 125 126 127 128 129

### Changed
- Improved performance of circle-drawing algorithm.

### Fixed
- Removed a debug print in the `bhi160` module.
Rahix's avatar
Rahix committed
130 131


Rahix's avatar
Rahix committed
132 133 134
## [v1.5] - 2019-08-23 00:18 - [Eggppppplant]
[Eggppppplant]: https://card10.badge.events.ccc.de/release/card10-v1.5-Eggppppplant.zip

Rahix's avatar
Rahix committed
135 136
### Added
- **bootloader**: Add an error message when flashing fails.
137 138
- **display**: Option to set backlight from Python
- **utime**: Function to read time in ms from Python
Rahix's avatar
Rahix committed
139 140 141

### Changed
- **gpio**: Rename constants for consistency.
142 143
- **ble**: Storing pairings outside BLE stack context
- **security**: Disable ELFs by default, prevent access to some more files
Rahix's avatar
Rahix committed
144 145 146 147 148

### Fixed
- **gpio**: Fix field-setting in `gpio_cfg_t`.


Rahix's avatar
Rahix committed
149 150 151
## [v1.4] - 2019-08-22 19:43 - [DaikonRadish]
[DaikonRadish]: https://card10.badge.events.ccc.de/release/card10-v1.4-DaikonRadish.zip

Rahix's avatar
Rahix committed
152 153 154
### Added
- Support for the `bme680` environmental sensor.
- Support for the `bhi160` sensor fusion.
Rahix's avatar
Rahix committed
155 156 157 158 159
- `simple_menu` module for creating simple menus in Python.
- `power` module to access the voltage and current measurements from the PMIC.
- Support for color themes in the default clock script:
  Color themes are read from a json file, so people can customize their clock.
  Last selected theme is saved in the `clock.json` so it is persistent.
Rahix's avatar
Rahix committed
160 161 162

### Changed
- Refactored BLE card10 service.
Rahix's avatar
Rahix committed
163
- Improved BLE file-transfer (added security).
Rahix's avatar
Rahix committed
164 165 166 167 168 169 170
- Replaced dynamic attribute creation with static attributes.

### Fixed
- Fixed menu listing files starting with `.`.
- Fixed `utime.set_time()` applying the timezone offset in the wrong direction.
- Fixed the PMIC driver not releasing some locks properly.

Rahix's avatar
Rahix committed
171

Rahix's avatar
Rahix committed
172 173 174
## [v1.3] - 2019-08-22 00:12 - [CCCauliflower]
[CCCauliflower]: https://card10.badge.events.ccc.de/release/card10-v1.3-cccauliflower.zip

Rahix's avatar
Rahix committed
175 176 177 178 179 180 181 182 183 184 185 186
### Added
- A splashscreen in Epicardium showing the version number.
- `os.urandom()` function.

### Changed
- BLE file-transfers now create missing folders.

### Fixed
- **gfx**: Add a linebreak before character, not after.  This prevent the last
  character being cut off.
- Fixed serial task overflowing because it had a too small stack size.
- Removed confusing MAXUSB messages.
Rahix's avatar
Rahix committed
187 188


Rahix's avatar
Rahix committed
189 190
## [v1.2] - 2019-08-21 18:18 - [Broccoli]
[Broccoli]: https://card10.badge.events.ccc.de/release/card10-v1.2-broccoli.zip
Rahix's avatar
Rahix committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219

```text
8e8d8614 feat(apps): Add scope to preload
e1a7684a fix(cdcacm): Disable before printing error
4c74f061 fix(utime.c): set_time should operate in local tz
e0824843 feat(pmic): Switch off if battery is low
46ef3985 feat(pmic): Add API-call to read battery voltage
79e2fb15 feat(epicardium): Periodically check the battery voltage
5da9e074 feat(pmic): Implement AMUX reading
8c59935e py: timezone workaround
c7f59d3e fix(text_reader): Convert to unix line-endings
78a7a7f4 docs: Fix underlines in ble/card10
15649293 feat(app): Add some preloads
b12e4ef9 chore(docs): Fix utime module docs
3efbab13 feat(utime.c): add python functions to set time
38f83243 chore(docs): Fix color documentation
a966e221 chore(docs): Fix python-directives with double-module
66cd10d4 docs: Document os.reset()
5fe5fe31 docs: Document pride module
338132e5 apped apps folder to search module search path
cda91555 rename Main Clock to Home
c2935c8c fixed syntax
3017591a Rename preloaded apps to make use of hatchery folder structure
842e9ad8 feat(menu.py): support scrolling for long menu entries
fbf7c8c0 fix(menu.py) Refactored menu.py based on !138
8aa8c31f feat(ble): Store bondings
5e5c7a4f fix(menu.py): Fix color-mismatch of selector background
```

Rahix's avatar
Rahix committed
220
## [v1.1] - 2019-08-21 03:14 - Asparagus
Rahix's avatar
Rahix committed
221 222 223 224 225 226 227 228 229 230 231 232
### Added
- Seed ``urandom`` PRNG with ``TRNG`` peripheral.
- Show linenumbers in MicroPython tracebacks.

### Fixed
- **buttons**: Acquire lock before accessing I2C.
- **rtc**: Fix RTC getting stuck because of improper initialization.
- Make lifecycle task more important than dispatcher.

## [v1.0] - 2019-08-21 00:50
Initial release.

Rahix's avatar
Rahix committed
233 234
[Unreleased]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.9...master
[v1.9]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.8...v1.9
Rahix's avatar
Rahix committed
235
[v1.8]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.7...v1.8
Rahix's avatar
Rahix committed
236
[v1.7]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.6...v1.7
Rahix's avatar
Rahix committed
237
[v1.6]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.5...v1.6
Rahix's avatar
Rahix committed
238
[v1.5]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.4...v1.5
Rahix's avatar
Rahix committed
239
[v1.4]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.3...v1.4
Rahix's avatar
Rahix committed
240 241 242 243
[v1.3]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.2...v1.3
[v1.2]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.1...v1.2
[v1.1]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.0...v1.1
[v1.0]: https://git.card10.badge.events.ccc.de/card10/firmware/-/tags/v1.0