Compare revisions

flags = -DBOARD_CARD10=1 -D_FILE_OFFSET_BITS=64 -DTARGET=32665 -DTARGET_REV=0x4131 -target thumbv7m-none-eabi -Ibuild/epicardium -Ibuild/epicardium/366573f@@api-caller@sta -Ibuild/epicardium/366573f@@api-dispatcher@sta -Ibuild/epicardium/366573f@@epicardium.elf@exe -Ibuild/epicardium/366573f@@freertos@sta -Ibuild/lib/card10 -Ibuild/lib/card10/7eaaaa5@@card10@sta -Ibuild/lib/ff13 -Ibuild/lib/ff13/a277df3@@ff13@sta -Ibuild/lib/gfx -Ibuild/lib/gfx/2308dff@@gfx@sta -Ibuild/lib/micropython -Ibuild/lib/micropython/a57cd11@@mpy-cross-wrapper@exe -Ibuild/lib/mx25lba -Ibuild/lib/mx25lba/c7b864b@@mx25lba@sta -Ibuild/lib/sdk/Libraries/Boards/card10 -Ibuild/lib/sdk/Libraries/Boards/card10/9eeeac4@@board-card10@sta -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665 -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/a500f70@@max32665-startup-core0@sta -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/a500f70@@max32665-startup-core1@sta -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/a500f70@@max32665-startup@sta -Ibuild/lib/sdk/Libraries/MAX32665PeriphDriver -Ibuild/lib/sdk/Libraries/MAX32665PeriphDriver/0d96707@@PeriphDriver@sta -Ibuild/lib/sdk/Libraries/MAXUSB -Ibuild/lib/sdk/Libraries/MAXUSB/9a51a91@@maxusb@sta -Ibuild/lib/vendor/Bosch/BHy1 -Ibuild/lib/vendor/Bosch/BHy1/6298ab9@@bhy1@sta -Ibuild/lib/vendor/Bosch/BMA400 -Ibuild/lib/vendor/Bosch/BMA400/b6b0216@@bma400@sta -Ibuild/lib/vendor/Bosch/BME680 -Ibuild/lib/vendor/Bosch/BME680/ef6f079@@bme680@sta -Ibuild/lib/vendor/Maxim/MAX77650 -Ibuild/lib/vendor/Maxim/MAX77650/cc369b8@@max77650@sta -Ibuild/lib/vendor/Maxim/MAX86150 -Ibuild/lib/vendor/Maxim/MAX86150/21e3a66@@max86150@sta -Ibuild/pycardium -Ibuild/pycardium/1f90fd2@@micropython@sta -Ibuild/pycardium/1f90fd2@@pycardium.elf@exe -Iepicardium -Ilib/card10 -Ilib/ff13 -Ilib/ff13/Source -Ilib/ff13/util -Ilib/FreeRTOS/Source/include -Ilib/FreeRTOS/Source/portable/GCC/ARM_CM4F -Ilib/gfx -Ilib/gfx/Fonts -Ilib/gfx/GUI_DEV -Ilib/gfx/LCD -Ilib/micropython -Ilib/micropython/micropython -Ilib/micropython/micropython/extmod -Ilib/micropython/micropython/lib/utils -Ilib/mx25lba -Ilib/sdk/Libraries/Boards/card10 -Ilib/sdk/Libraries/Boards/card10/Include -Ilib/sdk/Libraries/Boards/Include -Ilib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665 -Ilib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/Include -Ilib/sdk/Libraries/CMSIS/Include -Ilib/sdk/Libraries/MAX32665PeriphDriver -Ilib/sdk/Libraries/MAX32665PeriphDriver/Include -Ilib/sdk/Libraries/MAXUSB -Ilib/sdk/Libraries/MAXUSB/include/core -Ilib/sdk/Libraries/MAXUSB/include/core/musbhsfc -Ilib/sdk/Libraries/MAXUSB/include/dbg_log -Ilib/sdk/Libraries/MAXUSB/include/devclass -Ilib/sdk/Libraries/MAXUSB/include/enumerate -Ilib/sdk/Libraries/MAXUSB/include/util -Ilib/vendor/Bosch/BHy1 -Ilib/vendor/Bosch/BHy1/driver/inc -Ilib/vendor/Bosch/BHy1/examples/firmware -Ilib/vendor/Bosch/BMA400 -Ilib/vendor/Bosch/BME680 -Ilib/vendor/Maxim/MAX77650 -Ilib/vendor/Maxim/MAX86150 -Ipycardium

flags = -DBOARD_CARD10=1 -D_FILE_OFFSET_BITS=64 -DTARGET=32665 -DTARGET_REV=0x4131 -target thumbv7m-none-eabi -Ibuild/epicardium -Ibuild/epicardium/366573f@@api-caller@sta -Ibuild/epicardium/366573f@@api-dispatcher@sta -Ibuild/epicardium/366573f@@epicardium.elf@exe -Ibuild/epicardium/366573f@@freertos@sta -Ibuild/lib/card10 -Ibuild/lib/card10/7eaaaa5@@card10@sta -Ibuild/lib/ff13 -Ibuild/lib/ff13/a277df3@@ff13@sta -Ibuild/lib/gfx -Ibuild/lib/gfx/2308dff@@gfx@sta -Ibuild/lib/micropython -Ibuild/lib/micropython/a57cd11@@mpy-cross-wrapper@exe -Ibuild/lib/mx25lba -Ibuild/lib/mx25lba/c7b864b@@mx25lba@sta -Ibuild/lib/sdk/Libraries/Boards/card10 -Ibuild/lib/sdk/Libraries/Boards/card10/9eeeac4@@board-card10@sta -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665 -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/a500f70@@max32665-startup-core0@sta -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/a500f70@@max32665-startup-core1@sta -Ibuild/lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/a500f70@@max32665-startup@sta -Ibuild/lib/sdk/Libraries/MAX32665PeriphDriver -Ibuild/lib/sdk/Libraries/MAX32665PeriphDriver/0d96707@@PeriphDriver@sta -Ibuild/lib/sdk/Libraries/MAXUSB -Ibuild/lib/sdk/Libraries/MAXUSB/9a51a91@@maxusb@sta -Ibuild/lib/vendor/Bosch/BHy1 -Ibuild/lib/vendor/Bosch/BHy1/6298ab9@@bhy1@sta -Ibuild/lib/vendor/Bosch/BMA400 -Ibuild/lib/vendor/Bosch/BMA400/b6b0216@@bma400@sta -Ibuild/lib/vendor/Bosch/BME680 -Ibuild/lib/vendor/Bosch/BME680/ef6f079@@bme680@sta -Ibuild/lib/vendor/Maxim/MAX77650 -Ibuild/lib/vendor/Maxim/MAX77650/cc369b8@@max77650@sta -Ibuild/lib/vendor/Maxim/MAX86150 -Ibuild/lib/vendor/Maxim/MAX86150/21e3a66@@max86150@sta -Ibuild/pycardium -Ibuild/pycardium/1f90fd2@@micropython@sta -Ibuild/pycardium/1f90fd2@@pycardium.elf@exe -Iepicardium -Ilib/card10 -Ilib/ff13 -Ilib/ff13/Source -Ilib/ff13/util -Ilib/FreeRTOS/Source/include -Ilib/FreeRTOS/Source/portable/GCC/ARM_CM4F -Ilib/gfx -Ilib/gfx/Fonts -Ilib/gfx/GUI_DEV -Ilib/gfx/LCD -Ilib/micropython -Ilib/micropython/micropython -Ilib/micropython/micropython/extmod -Ilib/micropython/micropython/lib/utils -Ilib/mx25lba -Ilib/sdk/Libraries/Boards/card10 -Ilib/sdk/Libraries/Boards/card10/Include -Ilib/sdk/Libraries/Boards/Include -Ilib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665 -Ilib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665/Include -Ilib/sdk/Libraries/CMSIS/Include -Ilib/sdk/Libraries/MAX32665PeriphDriver -Ilib/sdk/Libraries/MAX32665PeriphDriver/Include -Ilib/sdk/Libraries/MAXUSB -Ilib/sdk/Libraries/MAXUSB/include/core -Ilib/sdk/Libraries/MAXUSB/include/core/musbhsfc -Ilib/sdk/Libraries/MAXUSB/include/dbg_log -Ilib/sdk/Libraries/MAXUSB/include/devclass -Ilib/sdk/Libraries/MAXUSB/include/enumerate -Ilib/sdk/Libraries/MAXUSB/include/util -Ilib/vendor/Bosch/BHy1 -Ilib/vendor/Bosch/BHy1/driver/inc -Ilib/vendor/Bosch/BHy1/examples/firmware -Ilib/vendor/Bosch/BMA400 -Ilib/vendor/Bosch/BME680 -Ilib/vendor/Maxim/MAX77650 -Ilib/vendor/Maxim/MAX86150 -Ipycardium -Ilib/ctx

build/

/build/

/Documentation/output/

__pycache__/

*.pyc

build:

    stage: build

    script:

        - ./bootstrap.sh

        - git submodule deinit --all -f

        - ./bootstrap.sh --werror

        - ninja -C build/

        - arm-none-eabi-size build/bootloader/bootloader.elf build/epicardium/epicardium.elf build/pycardium/pycardium.elf

        - cp build/pycardium/pycardium_epicardium.bin card10.bin

    only:

        - merge_requests

        - master

    artifacts:

        expose_as: Firmware Binaries

        expire_in: 1 week

        paths:

            - build/epicardium/epicardium.elf

            - build/pycardium/pycardium.elf

            - card10.bin

release:

    stage: build

    script:

        - ./bootstrap.sh

        - git submodule deinit --all -f

        - ./bootstrap.sh --werror

        - ninja -C build/

        - arm-none-eabi-size build/bootloader/bootloader.elf build/epicardium/epicardium.elf build/pycardium/pycardium.elf

    only:

        - tag

    artifacts:

        expire_in: never

        paths:

            - build/bootloader/bootloader.elf

            - build/epicardium/epicardium.elf

        # If this starts failing for any reason, just remove this curl ping.

        - curl --fail https://annoyatron-prod.q3k.org/ping/mr?mr=${CI_MERGE_REQUEST_IID}

        - git remote rm card10 || true # old gitlab runners might have this remote.

        - git fetch https://git.card10.badge.events.ccc.de/card10/firmware.git master:card10/master

        - git -c http.sslVerify=false fetch https://git.card10.badge.events.ccc.de/card10/firmware.git master:card10/master

        - git merge-base card10/master HEAD || ( echo "Your change needs to be rebased against current master."; exit 1; )

        - git diff --name-only --diff-filter=d card10/master...HEAD | xargs tools/code-style.sh

        - git diff --exit-code

pages:

    stage: deploy

    # maintaned by q3k, build using docker/deploy-env

    image: "derq3k/card10-deploy-env:20190806-200743Z-f95b541-dirty"

    image: "registry.k0.hswaw.net/q3k/card10-deploy-env:20210403-110003Z-4d929ee0"

    script:

        - export LD_LIBRARY_PATH=$(llvm-config --libdir)

        - echo $LD_LIBRARY_PATH

[submodule "lib/micropython/micropython-lib"]

	path = lib/micropython/micropython-lib

	url = https://github.com/micropython/micropython-lib.git

[submodule "lib/crypto/tiny-AES-c"]

	path = lib/crypto/tiny-AES-c

	url = https://github.com/kokke/tiny-AES-c

[submodule "lib/crypto/SHA256"]

	path = lib/crypto/SHA256

	url = https://github.com/ilvn/SHA256

[submodule "lib/lodepng/lodepng"]

	path = lib/lodepng/lodepng

	url = https://github.com/lvandeve/lodepng

## [Unreleased]

## [v1.18] - 2021-12-25 - [Queer Quinoa]

[Queer Quinoa]: https://card10.badge.events.ccc.de/release/card10-v1.18-Queer-Quinoa.zip

### For Users

- Much improved battery runtime, up to 160% more time without recharging!

- Integration of the [ctx.graphics] vector graphics renderer!  This

  means much smoother looking graphics as CTX comes with anti-aliasing!

  For now, CTX is only integrated as a backend (for the existing graphics API)

  but in future releases you will also be able to use CTX directly as well.

- As part of that, we have integrated a new font.  You can also use your own, by

  replacing `lib/ctx/fira-mono.ttf` with a font of your choice and then

  rebuilding the firmware.

- Automatically return from USB storage mode after the host (= your computer)

  ejects the device.

- Added ECG streaming over BLE.  The latest version of the Android companion

  app implements the other side of this.

### For Hackers

- Disable IRQs on core 1 during all Epicardium API calls.  This means API calls

  are now always safe to use from ISRs.

- Added an [`epic_sleep()`] API call which can be used as a hint to Epicardium

  that it can enter a deep-sleep mode.  [`epic_sleep()`] will only return once

  either the time is up or an interrupt to core 1 is pending.  Pycardium now

  uses this call for all delays by default.

- Update MicroPython to v1.17.

- With the MicroPython update, pycardium now supports f-strings!

- Firmware version can now be properly read out over BLE.

- Legacy app launcher scripts in the filesystem root are deleted on startup of

  new versions now.  Newer companion app releases also no longer generate this

  launcher script.

### Internals

- Restructured `epicardium/modules` into more sensible subdirectories.

- Switched the UART peripheral to use the HIRC8 clock.

- Converted the "personal state" implementation to use the workqueue.

- Switched the SysTick in Pycardium to use the 32kHz clock source.

- Made display backlight PWM robust against changes to the MCU's PCLK speed.

- During tickless idle, lower the core-clock (PCLK) to reduce power consumption.

- Rewrote the LCD driver.

- Put the display to sleep when the backlight is off to save power.

- Fixed a 32-bit overflow in Pycardium systick code.

[ctx.graphics]: https://ctx.graphics/

[`epic_sleep()`]: https://firmware.card10.badge.events.ccc.de/epicardium/api.html#c.epic_sleep

## [v1.17] - 2021-04-04 - [R2R Rocket]

[R2R Rocket]: https://card10.badge.events.ccc.de/release/card10-v1.17-R2R-Rocket.zip

### For Users

#### Added

- Added the Bosch BSEC library for the BME680 sensor.  See the [``bme680``

  module][bme680-docs] documentation for details.

- Added a [BLE Environmental Sensing Service][ess-docs].

- Added a [BLE HID Service][ble-hid-docs].

- Added the ability to use the pulse-oximeter as a proximity sensor (makes it

  usable as a button).  Additionally a demo-application was added which uses

  this for a push-to-talk button.

- Added a [blitting][blit-docs] function to the display module.  This finally

  allows to efficiently draw pixels!

- MicroPython BLE support!

- A PNG library for pycardium: [`png`][png-docs]

- Two more config options to tweak menu button behavior: `long_press_ms` and ``retrigger_ms``

- Option to disable low battery checks via `card10.cfg`.  This is meant for

  devices where the connection between the PMICs ADMUX and the CPU's ADC is broken

  in some way, leading to the device always reporting a low battery condition.

#### Changed

- Updated the BME680 demo app with BSEC support.

- Upgraded to MicroPython 1.14.

- Open the USB mass-storage when no apps are found.

- Improved the l0dables runtime; it now handles HardFaults and app-exits

  properly.

#### Fixed

- Fixed lockup when trying to load an ELF l0dable while ELFs are disabled.

- Fixed card10 not waking up from sleep when BLE is disabled (regression from 1.15 to 1.16).

- Fixed card10 not working with the Harmonic Board disconnected (regression from

  1.15 to 1.16).

#### Removed

- Removed the battery BLE service.

### Internals

#### Added

- A work-queue API in Epicardium to schedule work that needs to be done

  asynchronously.

#### Changed

- Upgraded to newer SDK version.

- Cleaned up the BHI160 driver a bit.

- Readjusted the flash layout, to give Epicardium more space.

- Upgraded the documentation to use Sphinx 3.

[bme680-docs]: https://firmware.card10.badge.events.ccc.de/pycardium/bme680.html

[ess-docs]: https://firmware.card10.badge.events.ccc.de/bluetooth/ess.html

[ble-hid-docs]: https://firmware.card10.badge.events.ccc.de/pycardium/ble_hid.html

[blit-docs]: https://firmware.card10.badge.events.ccc.de/pycardium/display.html#display.Display.blit

[png-docs]: https://firmware.card10.badge.events.ccc.de/pycardium/png.html

## [v1.16] - 2020-12-04 - [Pandemic Potato]

[Pandemic Potato]: https://card10.badge.events.ccc.de/release/card10-v1.16-Pandemic-Potato.zip

### Added

#### For Users

- A feature to allow setting the main app on-device.

- Added compatibility to BLE 5.0 capable phones (including iPhones).

- Added a pairing dialog in the BLE app. card10 is only visible when BLE app is

  active.

- G-Watch watch face.

- App for COVID-19 exposure notification statistics.

- Experimental app using the MAX86150 pulse-oximeter.

#### For Developers

- `leds.flash_rocket()` API for making rockets flash asynchronously.

- Basic API for the MAX86150 pulse-oximeter.

- CSPRNG as a replacement for the hardware TRNG which does not seem to produce

  good entropy the way we are using it right now.

- Option to write HCI layer log files for debugging.

- Feature in `simple_menu` which detects long button presses.

- _Stub_ `ubluetooth` module. Not yet functional!

### Changed

#### For Users

- The default watch face is now G-Watch.

- Improved BLE security by only allowing man-in-the-middle protected

  pairings and specifying minimum key lengths.

- Read time/date automatically from iOS devices.

- It is now configurable whether the left/right bottom buttons or the right

  top/bottom buttons scroll in the menu via the `right_scroll` option in

  `card10.cfg`.

#### For Developers

- Updated to a newer version of MicroPython (v1.12).

- All `u{module}` MicroPython modules are now also available as `{module}` which

  brings card10 more in line with upstream.

- Updated to SDK version 0.2.1-12

- The BLE pairing database was completely overhauled.

- Use the CSPRNG for all MicroPython randomness.

- Internal changes to the way interrupts are triggered.

### Fixed

- Made the `vibra` vibration motor API more stable.

- Fixed bug which triggered reboot loops.

- Fixed bug which made the USB serial connection unresponsive.

- Fixed bug which wrote the pairings file more periodically.

- Fixed invalid filesystem locking in BLE startup.

- Only print a single warning when a sensor stream overflows instead of spamming

  the console with errors.

- Fixed issues from reloading the configuration file.

- Fixed `pycard10.py` not properly resetting the device before loading a script.

- Allow to reopen BHI160 sensor from python.

- Fixed pycardium not exiting when triggering certain failure conditions.

- Made the config parser more robust.

- Fixed a possible lockup in the handling of the serial console.

## [v1.15] - 2020-02-02 - [Okra]

[Okra]: https://card10.badge.events.ccc.de/release/card10-v1.15-Okra.zip

### Added

- Show a fault screen on the display when epicardium panics

### Fixed

- Prevent MicroPython garbage collector from delting ISRs

- Fix race conditoin when reading/writing BLE MAC address at boot.

- Fix locking of LEDs.

- Fix bug which only allowed to have a single file open at any time.

- Put all chips into standby when going to sleep

- Misc BLE fixes

## [v1.14] - 2019-12-29 - [Nettle]

[Nettle]: https://card10.badge.events.ccc.de/release/card10-v1.14-Nettle.zip

### Added

- Scripts for profiling card10 (`tools/poor-profiler`)

- `tools/ecg2wav.py` script for displaying ECG logs in audio programs like

  Audacity.

### Changed

- Ported hardware-locks & bhi160 to new mutex API

- The menu now tries to display apps without a `metadata.json` as well, if

  possible.

### Fixed

- Fixed an unguarded i2c bus transaction which caused strange issues all

  around.

- Fixed copying large files freezing card10.

- Fixed BHI160 initialization interrupt behavior.

- Properly disable BHI160 if an error occurs during init.

- Fixed bhi160 app overflowing sensor queues.

- Fixed neopixel driver not properly writing the first pixel the first

  time.

- Fixed some l0dables crashing because the SysTick timer interrupt was not

  disabled.

## [v1.13] - 2019-12-09 - [Mushroom]

[Mushroom]: https://card10.badge.events.ccc.de/release/card10-v1.13-Mushroom.zip

### Added

- ECG plotter tool (for desktop machines) which can plot ECG logs taken with card10.

- The `input()` Python function.

- Enabled the MicroPython `framebuf` module for a Pycardium-only framebuffer

  implementation.

- Added the `utime.ticks_us()` and `utime.ticks_ms()` functions for very

  accurate timing of MicroPython code.

- Added an option to use the right buttons for scrolling and the left one for

  selecting.  This will be made configurable in a future release.

- Made timezone configurable with a new `timezone` option in `card10.cfg`.

- Added a setting-menu to the ECG App.

### Changed

- Changed default timezone to CET.

- Made a few library functions callable without any parameters so they are

  easier to use.

- Refactored the `card10.cfg` config parser.

### Fixed

- Fixed the Pycardium delay implementation in preparation for features like

  button-interrupts.  Should also be more accurate now.

- Fixed the filter which is used by the ECG app.

- Fixed the display staying off while printing the sleep-messages.

- Improved the USB-Storage mode in the menu app.

- Fixed GPIO module not properly configuring a pin if both IN and ADC are given.

- Added missing documentation for `os.mkdir()` and `os.rename()`.

- Fixed all `-Wextra` warnings, including a few bugs.  Warnings exist for a reason!

### Removed

- Removed unnecessary out-of-bounds checks in display module.  Drawing outside

  the display is now perfectly fine and the pixels will silently be ignored.

## [v1.12] - 2019-10-19 - [Leek]

[Leek]: https://card10.badge.events.ccc.de/release/card10-v1.12-Leek.zip

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

Initial release.

[Unreleased]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.12...master

[Unreleased]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.18...master

[v1.18]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.17...v1.18

[v1.17]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.16...v1.17

[v1.16]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.15...v1.16

[v1.15]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.14...v1.15

[v1.14]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.13...v1.14

[v1.13]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.12...v1.13

[v1.12]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.11...v1.12

[v1.11]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.10...v1.11

[v1.10]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.9...v1.10

.. _bluetooth_card10_service:

Bluetooth Card10 Service

========================

The range of this sensor is between 0 (``0x0``) and 400 (``0x9001``).

- reading of ``0x0e00`` means **14**

Access via btgatt-client

---------------------------------

Accessing services from a linux system is possible via ``btgatt-client``. The inbuilt gatt client of ``bluetoothctl`` as well as ``libgatt`` were tested, but struggled with the card10's BLE stack.

**Example**:

.. code-block::

    # pairing the card10:

    $ bluetoothctl

    [bluetooth]# power on

    [bluetooth]# scan on

    [bluetooth]# pair CA:4D:10:xx:xx:xx     #replace xx:xx:xx with scan result

    # if this query doesn't appear, remove and re-pair:

    [agent] Confirm passkey ###### (yes/no): [CHG] Device CA:4D:10:xx:xx:xx Name: card10

    [card10-xxxxxx]# disconnect CA:4D:10:xx:xx:xx

    # using a service:

    $ btgatt-client -d CA:4D:10:xx:xx:xx

    # wait until services have been discovered, may take a minute

    [GATT client]# write-value 0x0926 31 31 31

    # if this error appears remove and re-pair:

    [GATT client]# Device disconnected: Software caused connection abort

ARM Cordio Sources

------------------

The BLE stack is based on the ARM Cordio stack. This stack has been developed by a 3rd party and was bought by ARM and open-sourced.

There are many copies of it floating around on the Internet and some are more up to date than others. To keep track here is a list:

 - mbed

    - mbed has a reasonably up to date version of the stack in their GitHub repository.

    - It is scattered below the CORDIO directories in https://github.com/ARMmbed/mbed-os/tree/master/features/FEATURE_BLE/targets

    - ble-profiles are not included. mbed has written their own adaptation layer to interface with the stack and implements profiles in C++

 - Ambiq Suite SDK

    - Can be found here: https://github.com/sparkfun/AmbiqSuiteSDK/tree/master/third_party/exactle

    - Patches on top might be here: https://support.ambiqmicro.com/hc/en-us/categories/115000239012-Software

    - Reasonably up to date

    - Intersting part: has their own FreeRTOS integration (but apparently on older WSF)

    - BLE 5.1 (?)

 - Packetcraft

    - Apparently tasked with maintaining the stack in general

    - Most up to date version

    - https://github.com/packetcraft-inc/cordio

    - Apparently developing (security) fixes, distributing them to customers, but not applying them to master: https://github.com/ARMmbed/mbed-os/commit/c92777311578eb003b4546c4e5e6f2c1f8ba3c84

    - BLE 5.1

 - Maxim

    - Distributed via Maxim Toolchain Installation tool, no repository available

    - Contains software implementation of the base band

    - ble-host and ble-profiles might be compatible with the one directly from Packetcraft

    - Developing their own low-power enhancements

    - BLE 5.0

.. _bluetooth_ecg_service:

Bluetooth ECG Service

========================

.. warning::

    The service is still work in progress and subject to change

The ECG service provides access to the ECG sensor of the card10

BLE Service

-----------

The current draft uses following service specification:

- Service:

  UUID: ``42230300-2342-2342-2342-234223422342``

- ECG samples characteristic:

  UUID: ``42230301-2342-2342-2342-234223422342``

  notify

ECG samples characteristic

--------------------------

List of 16 bit samples (big endian). Enable notifications to

receive a stream of samples while the ECG app is open.

The first 16 bit are a sample counter (big endian).

.. _ESS:

Environmental Sensing Service

=============================

The Environmental Sensing Service (ESS) implements access to

the BME680 environmental sensor of the card10.

It provides:

- Temperature

- Relative humidity

- Pressure

If :ref:`bsec_api` is enabled the following additional estimates are available:

 - Indoor air quality (IAQ estimate

 - Equivalent CO2 (eCO2) estimate

Please refer to :py:mod:`bme680` for more information about BSEC.

If notifcations are enabled a measurement of all values is performed every 3 seconds. For each measurement a notification is sent for the characteristics which have notifications enabled.

A measurement can also be triggered by reading from a characteristic. A measurement takes roughly 200 ms. A notifciation will be sent to all characteristics which have notifications enabled except the one which was used to trigger the measurement.

.. note::

   If :ref:`bsec_api` is enabled, reading a characteristic will not trigger a new measurement.

.. note::

    This service will be available in version v1.17.

BLE Service

-----------

- Service

  UUID: ``181A``

- Temperature characteristic:

  UUID: ``2A6E``

  read and notify

- Humidity characteristic:

  UUID: ``2A6F``

  read and notify

- Pressure characteristic:

  UUID: ``2A6D``

  read and notify

- Indoor air quality (IAQ) characteristic:

  UUID: ``422302f1-2342-2342-2342-234223422342``

  read and notify

Temperature characteristic

--------------------------

- 16 bit little endian value representing the measured temperature.

- Unit: 0.01 deg C

Humidity characteristic

-----------------------

- 16 bit little endian value representing the measured relative humidity.

- Unit: 0.01%

Pressure characteristic

-----------------------

- 32 bit little endian value representing the measured pressure.

- Unit: 0.1 Pa (0.001 hPa)

Indoor air quality (IAQ) characteristic

---------------------------------------

Data format:

======== =========================== ===========================

Byte 0   Bytes 1-2                   Bytes 3-4

-------- --------------------------- ---------------------------

Accuracy IAQ (16-bit little endian)  eCO2 (16-bit little endian)

======== =========================== ===========================

Units:

- Accuracy and IAQ units: See :ref:`bsec_api` API description

- CO2 unit: [ppm]