Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found
Select Git revision
  • schneider/ir
  • master
  • rahix/user-space-ctx
  • schneider/iaq-python
  • schneider/ble-mini-demo
  • schneider/ble-ecg-stream-visu
  • schneider/mp-exception-print
  • schneider/sleep-display
  • schneider/deepsleep4
  • schneider/deepsleep2
  • schneider/deepsleep
  • schneider/ble-central
  • rahix/bluetooth-app-favorite
  • schneider/v1.17-changelog
  • schneider/ancs
  • schneider/png
  • schneider/freertos-list-debug
  • schneider/212-reset-hardware-when-entering-repl
  • schneider/bonding-fail-if-full
  • schneider/ble-fixes-2020-3
  • schneider/spo2-playground
  • schneider/sdk-0.2.1-11
  • schneider/default-main
  • schneider/sdk-0.2.1-7
  • dx/meh-bdf-to-stm
  • dx/flatten-config-module
  • genofire/ble-follow-py
  • schneider/ble-stability
  • schneider/ble-stability-new-phy
  • add_menu_vibration
  • plaetzchen/ios-workaround
  • blinkisync-as-preload
  • schneider/max30001-pycardium
  • schneider/max30001-epicaridum
  • schneider/max30001
  • schneider/stream-locks
  • schneider/fundamental-test
  • schneider/ble-buffers
  • schneider/maxim-sdk-update
  • ch3/splashscreen
  • koalo/bhi160-works-but-dirty
  • koalo/wip/i2c-for-python
  • renze/safe_mode
  • renze/hatchery_apps
  • koalo/factory-reset
  • msgctl/faultscreen
  • msgctl/textbuffer_api
  • schneider/bonding
  • schneider/bootloader-update-9a0d158
  • rahix/bma
  • rahix/bhi
  • schleicher-test
  • schneider/schleicher-test
  • freertos-btle
  • ch3/api-speed-eval2
  • schneider/mp-for-old-bl
  • ch3/leds-api
  • ch3/genapi-refactor
  • ch3/dual-core
  • dualcore
  • bootloader-v1
  • release-1
  • v0.0
  • v1.0
  • v1.1
  • v1.10
  • v1.11
  • v1.12
  • v1.13
  • v1.14
  • v1.15
  • v1.16
  • v1.17
  • v1.18
  • v1.2
  • v1.3
  • v1.4
  • v1.5
  • v1.6
  • v1.7
  • v1.8
  • v1.9
82 results

Target

Select target project
  • card10 / firmware
  • Anne Jan Brouwer / firmware
  • Astro / firmware
  • fpletz / firmware
  • Gerd / firmware
  • fleur / firmware
  • swym / firmware
  • Lukas / firmware
  • Adrian / firmware
  • wink / firmware
  • madonius / firmware
  • Mot / firmware
  • -mat- filid brandy / firmware
  • q3k / firmware
  • Hauke Mehrtens / firmware
  • Woazboat / firmware
  • Andreas Schildbach / firmware
  • Michael Ossmann / firmware
  • Jannis Rieger / firmware
  • zenox / firmware
20 results
Select Git revision
  • master
  • debug-queue-handling
  • issue104-UIError-update-fail
  • unique-advert-id
  • fix-issue_71
  • msgctl/gfx_rle
  • msgctl/faultscreen
  • msgctl/textbuffer_api
  • schneider/bonding
  • schneider/bootloader-update-9a0d158
  • schneider/bsec
  • rahix/bma
  • rahix/bhi
  • schleicher-test
  • schneider/schleicher-test
  • freertos-btle
  • ch3/api-speed-eval2
  • schneider/mp-for-old-bl
  • ch3/leds-api
  • ch3/genapi-refactor
  • ch3/dual-core
  • dualcore
  • v0.0
23 results
Show changes

Commits on Source 1015

915 additional commits have been omitted to prevent performance issues.
1000 files
+ 155799
− 55800
Compare changes
  • Side-by-side
  • Inline

Files

.clang

+1 −1
Original line number Original line Diff line number Diff line 
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

.gitignore

+2 −1
Original line number Original line Diff line number Diff line 
build/

/build/

/Documentation/output/

/Documentation/output/

__pycache__/

__pycache__/

*.pyc

*.pyc
@@ -6,3 +6,4 @@ __pycache__/ 
*~

*~

compile_commands.json

compile_commands.json

/tags

/tags

/release-*/

.gitlab-ci.yml

+15 −4
Original line number Original line Diff line number Diff line
@@ -4,22 +4,33 @@ image: "derq3k/card10-build-env:20190806-195837Z-f95b541-dirty" 
build:

build:

    stage: build

    stage: build

    script:

    script:

        - ./bootstrap.sh

        - git submodule deinit --all -f

        - ./bootstrap.sh --werror

        - ninja -C build/

        - ninja -C build/

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

        - 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:

    only:

        - merge_requests

        - merge_requests

        - master

        - master

    artifacts:

        expose_as: Firmware Binaries

        expire_in: 1 week

        paths:

            - build/epicardium/epicardium.elf

            - build/pycardium/pycardium.elf

            - card10.bin





release:

release:

    stage: build

    stage: build

    script:

    script:

        - ./bootstrap.sh

        - git submodule deinit --all -f

        - ./bootstrap.sh --werror

        - ninja -C build/

        - ninja -C build/

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

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

    only:

    only:

        - tag

        - tag

    artifacts:

    artifacts:

        expire_in: never

        paths:

        paths:

            - build/bootloader/bootloader.elf

            - build/bootloader/bootloader.elf

            - build/epicardium/epicardium.elf

            - build/epicardium/epicardium.elf
@@ -36,7 +47,7 @@ lint: 
        # If this starts failing for any reason, just remove this curl ping.

        # 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}

        - 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 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 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 --name-only --diff-filter=d card10/master...HEAD | xargs tools/code-style.sh

        - git diff --exit-code

        - git diff --exit-code
@@ -46,7 +57,7 @@ lint: 
pages:

pages:

    stage: deploy

    stage: deploy

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

    # 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:

    script:

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

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

        - echo $LD_LIBRARY_PATH

        - echo $LD_LIBRARY_PATH

.gitmodules

+9 −0
Original line number Original line Diff line number Diff line
@@ -4,3 +4,12 @@ 
[submodule "lib/micropython/micropython-lib"]

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

	path = lib/micropython/micropython-lib

	path = lib/micropython/micropython-lib

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

	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

CHANGELOG.md

+418 −4
Original line number Original line Diff line number Diff line
@@ -4,18 +4,420 @@ 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/).

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





## [Unreleased]

## [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



### Added

- **USB Storage mode**!  You can now select 'USB Storage' in the menu and

  access card10's filesystem via USB.  No more rebooting into bootloader!

- LED feedback on boot.  If your display is broken, you can still see it doing

  something now.

- `./tools/pycard10.py --set-time` to set card10's system time from your host.

- 4 new functions in `utime` modules:

  * `set_time_ms()`

  * `set_unix_time_ms()`

  * `unix_time()`

  * `unix_time_ms()`



### Changed

- Updated BLE stack

- Refactored gfx API for drawing images (internal).

- Draw partially clipped primitives in all cases (Fixes menu scrolling

  animation).

- Fatal errors are now handled in a central 'panic' module.



### Fixed

- Make BLE interrupts higher priority than anything else to hopefully increase

  stability.

- Turn off BLE encryption after closing a connection.

- Fixed mainline bootloader being broken.

- Fixed menu entries being ordered by path instead of name.

- Fixed menu crashing without a message.

- Fixed QSTR build-system.





## [v1.11] - 2019-09-24 - [Karotte]

[Karotte]: https://card10.badge.events.ccc.de/release/card10-v1.11-Karotte.zip



### Added

- **Support for sleep-mode instead of full power-off.  This means the RTC now

  retains its state!**

- For debugger users: A GDB macro `task_backtrace` which allows to view

  backtraces of tasks which are currently swapped out.  Use like

  ```text

  (gdb) task_backtrace serial_task_id

  ...

  (gdb) task_backtrace dispatcher_task_id

  ...

  (gdb) task_backtrace ble_task_id

  ```

- BHI160 magnetometer sensor

- ESB API in Pycardium.

- Monotonic clock API

- New FOSS font ...



### Changed

- `Display.print()` uses a transparent background when printing with `bg == fg`.

- Try different crc16 module during build because different environments might

  have different ones installed.

- Improved ECG app, it can now blink on pulse and more!

- Improved BHI160 and BME680 apps.



### Fixed

- Fixed a regression which made it impossible to turn off the flashlight.

- Fixed CRT for l0dables not allowing to overwrite interrupt handlers.

- Fixed ECG App not closing the sensor on `KeyboardInterrupt`.

- Fixed a bug which made the power-button unresponsive when pressed during boot

  (Interrupts were getting ignored).

- Fixed `simple_menu.Menu.exit()` not actually working.

- Added a few missing locks in `leds` module.

- Added a workaround for BHI160 axis mapping not being applied in some cases.

- Added a critical-section in BLE stack initialization to prevent weird lock-ups.

- Fixed vibra module crashing when calling `vibra.vibrate()` while already running.

- Fixed sensor-sample overflow leading to I2C bus lockup.





## [v1.10] - 2019-09-05 21:42 - [JerusalemArtichoke]

[JerusalemArtichoke]: https://card10.badge.events.ccc.de/release/card10-v1.10-JerusalemArtichoke.zip



### Added

- **ws2812**: Connect Neopixels to the wristband GPIOs and make your card10

  even more colorful!

- DigiClk is now in the default prelude!

- High-pass filter and pulse detection in default ECG app.

- Actually added `uuid` module - it was not built into the firmware before,

  by accident.

- `leds.get_rgb()`: Get the current color of an LED.

- `leds.get_rocket()`: Get the current brightness of one of the rockets.

- `micropython.mem_use()` function.

- The analog-clock can now also set the time using the buttons.



### Changed

- **Pycardium**: Switched from `long-long` to `mpz` integer representation.

  This should resolve any issues with large numbers which had popped up so far.

- Refactored BME680 sensor interface.

- Made OpenOCD scripts work with more debuggers out of the box.

- Internal changes in preparation for button-interrupts.



### Fixed

- Backlight and Vibration motor were not reset when switching apps.

- Mismatch in default settings of the *Card10 Nickname* app.

- Fixed the PMIC ADC muxer not being properly reset to neutral after a

  measurement.

- Fixed wrong timezone offset calculation in `utime.time_ms()`.

- Fixed bug where `\` characters were not parsed as path separators.

- Fixed the alignment request check in our ELF l0der.

- Fixed a buffer-overflow in the config-parser.





## [v1.9] - 2019-08-28 23:23 - [IcebergLettuce]

[IcebergLettuce]: https://card10.badge.events.ccc.de/release/card10-v1.9-IcebergLettuce.zip



### Added

- `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.

- 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.



### Changed

- Refactored *menu* and *personal-state* apps.

- `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.

- After a timeout, the menu will close and `main.py` will run again.

- BLE security updates.

- More detailed battery state display in nickname app.

- Improved ECG app.



### Removed

- Some unused font files.



### Fixed

- Fixed a regression which made the ECG app no longer work.

- Fixed card10 advertising support for AT-commands.

- Rectangles being one pixel too small.







## [v1.8] - 2019-08-27 11:38 - [HabaneroChilli]

[HabaneroChilli]: https://card10.badge.events.ccc.de/release/card10-v1.8-HabaneroChilli.zip



### Added

### Added

- 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.



### Changed

- No longer require locking the display for setting the backlight.





## [v1.7] - 2019-08-24 21:48 - [Garlic]

[Garlic]: https://card10.badge.events.ccc.de/release/card10-v1.7-Garlic.zip



### Added

- **ESB**: Epic Serial Bus (Better than USB!), stability improvements of the

  USB module.  Preparation for mass-storage access in the Firmware.

- Enabled the Hardware Watchdog;  Card10 will reset itself if the firmware crashes

- Enabled the Hardware Watchdog;  Card10 will reset itself if the firmware crashes

- Log messages when BLE is pairing / connected.

- The name of the offending app is printed to the serial console, if an app

- The name of the offending app is printed to the serial console, if an app

  crashes the metatdata parser.

  crashes the metatdata parser.

- **ESB**: Epic Serial Bus (Better than USB!), stability improvements of the

  USB module.  Preparation for mass-storage access in the Firmware.





### Changed

### Changed

- Improved log messages in cases of lock-contention.

- Improved log messages in cases of lock-contention.

- Menu will show an error message if a crash occurs.

- Menu will show an error message if a crash occurs.





### Fixed

### Fixed

- Fixed race-conditions in serial writes by using a queue.

- "Card10 Nickname" crashing if only `nickname.txt` exists.

- "Card10 Nickname" crashing if only `nickname.txt` exists.

- Lockup when debug prints are enabled.

- Lockup when debug prints are enabled.

- Delayed BHI160 startup a bit so the PMIC task can check the battery first.

- Delayed BHI160 startup a bit so the PMIC task can check the battery first.
@@ -24,7 +426,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). 
- Fixed the API interrupts sometimes getting stuck.

- Fixed the API interrupts sometimes getting stuck.

- Fixed binary building on MacOS.

- Fixed binary building on MacOS.

- Fixed race-conditions in serial console prints by introducing a queue.

- Fixed race-conditions in serial console prints by introducing a queue.

- Fixed API mutex being disabled late sometimes.

- Fixed API & MAX30001 mutexes being initialized late sometimes.

- Fixed wrong stripe width in bi flag.

- Fixed wrong stripe width in bi flag.
@@ -146,7 +548,19 @@ fbf7c8c0 fix(menu.py) Refactored menu.py based on !138 
## [v1.0] - 2019-08-21 00:50

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

Initial release.

Initial release.





[Unreleased]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.6...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

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

[v1.8]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.7...v1.8

[v1.7]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.6...v1.7

[v1.6]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.5...v1.6

[v1.6]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.5...v1.6

[v1.5]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.4...v1.5

[v1.5]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.4...v1.5

[v1.4]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.3...v1.4

[v1.4]: https://git.card10.badge.events.ccc.de/card10/firmware/compare/v1.3...v1.4

Documentation/bluetooth/card10.rst

+73 −10
Original line number Original line Diff line number Diff line 
.. _bluetooth_card10_service:



Bluetooth Card10 Service

Bluetooth Card10 Service

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

========================
@@ -28,27 +30,27 @@ The current draft uses following service specification: 
- Rockets characteristic:

- Rockets characteristic:





  UUID: ``42230210-2342-2342-2342-234223422342``

  UUID: ``42230210-2342-2342-2342-234223422342``

  write no response

  read and write no response





- Background LED Bottom Left characteristic:

- Background LED Bottom Left characteristic:





  UUID: ``42230211-2342-2342-2342-234223422342``

  UUID: ``42230211-2342-2342-2342-234223422342``

  write no response

  read and write no response





- Background LED Bottom Right characteristic:

- Background LED Bottom Right characteristic:





  UUID: ``42230212-2342-2342-2342-234223422342``

  UUID: ``42230212-2342-2342-2342-234223422342``

  write no response

  read and write no response





- Background LED Top Right characteristic:

- Background LED Top Right characteristic:





  UUID: ``42230213-2342-2342-2342-234223422342``

  UUID: ``42230213-2342-2342-2342-234223422342``

  write no response

  read and write no response





- Background LED Top Left characteristic:

- Background LED Top Left characteristic:





  UUID: ``42230214-2342-2342-2342-234223422342``

  UUID: ``42230214-2342-2342-2342-234223422342``

  write no reponse

  read and write no reponse





- LEDS dim bottom characteristic:

- LEDS dim bottom characteristic:
@@ -78,7 +80,7 @@ The current draft uses following service specification: 
- LEDs above characteristic:

- LEDs above characteristic:





  UUID: ``42230220-2342-2342-2342-234223422342``

  UUID: ``42230220-2342-2342-2342-234223422342``

  write no reponse

  read and write no reponse





- Light sensor characteristic:

- Light sensor characteristic:
@@ -104,6 +106,9 @@ Rockets characteristic 




The Rockets characteristic makes it possible to address every three rockets.

The Rockets characteristic makes it possible to address every three rockets.

Just write there three byte array, one for evey rocket.

Just write there three byte array, one for evey rocket.

On read you get the current value of all three rockets.

Range is between 0 and 31 (``0x1f``) if send higher value it will set to max of 31.







Dataformat:

Dataformat:
@@ -113,14 +118,14 @@ Dataformat: 
Rocket0 Rocket1 Rocket2

Rocket0 Rocket1 Rocket2

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

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





- Enable only Rocket0:  ``0xff0000``

- Enable only Rocket0:  ``0x1f0000``

- Enable all rockets with 50% brightness: ``0x7f7f7f``

- Enable all rockets with 50% brightness: ``0x0f0f0f``





Background LED <Position> characteristic

Background LED <Position> characteristic

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

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





The Background LEDs <Position> characteristic makes it possible to address the bottom LEDs by position.

The Background LEDs <Position> characteristic makes it possible to address the bottom LEDs by position.

Just write there three ``uint8`` for the rgb color.

Just write there three ``uint8`` for the rgb color or read the current value.





Dataformat:

Dataformat:
@@ -170,7 +175,7 @@ It writes always as persistant and it gives feedback if the value is in range an 




LEDs above characteristic

LEDs above characteristic

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

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

This characteristic set every 11 leds on the top module at once.

This characteristic set or read the current value of every 11 leds on the top module at once.

By defining 11x rgb from left to right. You need also to set exchange a bigger MTU to use this feature.

By defining 11x rgb from left to right. You need also to set exchange a bigger MTU to use this feature.





- set a rainbow beginnig with red on the right edge: ``0xff0000ff8b00e8ff005dff0000ff2e00ffb900b9ff002eff5d00ffe800ffff008b``

- set a rainbow beginnig with red on the right edge: ``0xff0000ff8b00e8ff005dff0000ff2e00ffb900b9ff002eff5d00ffe800ffff008b``
@@ -182,3 +187,61 @@ The light sensor characteristic makes it possible to read the current value of t 
The range of this sensor is between 0 (``0x0``) and 400 (``0x9001``).

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





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

- 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

Documentation/bluetooth/ecg.rst

0 → 100644
+31 −0
Original line number Original line Diff line number Diff line 
.. _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).

Documentation/bluetooth/ess.rst

0 → 100644
+99 −0
Original line number Original line Diff line number Diff line 
.. _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]

Documentation/bluetooth/file-transfer.rst

+2 −0
Original line number Original line Diff line number Diff line 
.. _bluetooth_file_transfer:



Bluetooth File Transfer

Bluetooth File Transfer

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

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

Documentation/bluetooth/nimble.rst

0 → 100644
+115 −0
Original line number Original line Diff line number Diff line 
NimBLE

======



On the card10 the ARM Cordio-B50 stack is used, which is in a very early experimental state and has some incompatibilities with some smartphones.

Therefore some alternative stacks are evaluated, which meight be used as a replacement in the long term.





Here a stack called NimBLE is presented, which claims to be feature complete. Originally it has been developed for Mynewt, an open source embedded operating system by Apache (https://mynewt.apache.org/).





There is a working port for the ESP32 espressif ESP-IDF framework.

Like Epicardium, ESP-IDF is based on FreeRTOS. Therefore it can be used for evaluation purposes.



Getting NimBLE run on the ESP32

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



Install required packages:



Ubuntu:



.. code-block:: shell-session



  sudo apt install git virtualenv python2.7 cmake



Arch:



.. code-block:: shell-session



  sudo pacman -S git python2 python2-virtualenv cmake



Download and extract xtensa ESP32 compiler:



.. code-block:: shell-session



  wget https://dl.espressif.com/dl/xtensa-esp32-elf-gcc8_2_0-esp32-2018r1-linux-amd64.tar.xz

  tar -xf xtensa-esp32-elf-gcc8_2_0-esp32-2018r1-linux-amd64.tar.xz





Clone esp-idf:



.. code-block:: shell-session



    git clone https://github.com/espressif/esp-idf.git



Add xtensa and ESP-IDF path to $PATH:



bash shell:



.. code-block:: shell-session



  export IDF_PATH=$PWD/esp-idf

  export PATH=${PATH}:$PWD/xtensa-esp32-elf/bin:$PWD/esp-idf/tools



fish shell:



.. code-block:: shell-session



  set -gx IDF_PATH $PWD/esp-idf

  set -gx PATH $PWD/xtensa-esp32-elf/bin/ $PWD/esp-idf/tools $PATH



Create a python2.7 virtualenv:



.. code-block:: shell-session



  cd esp-idf

  virtualenv -p /usr/bin/python2.7 venv



Enter the virtualenv:



bash shell:



.. code-block:: shell-session



  . venv/bin/activate



fish shell:



.. code-block:: shell-session



  . venv/bin/activate.fish



Init git submodules and install all required Python packages:



.. code-block:: shell-session



  git submodule update --init --recursive

  pip install -r requirements.txt





Now you are ready to build!



The following steps assume that your ESP32 is connected via USB and

is accessible via /dev/ttyUSB0. This meight be different on your system.



There are a few NimbLE examples which can be used for playing around:



Build a BLE server example (host mode):

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

.. code-block:: shell-session



  cd examples/bluetooth/nimble/bleprph

  idf.py -p /dev/ttyUSB0 flash monitor



This will build and flash the example to the ESP32 and instantly listens on /dev/ttyUSB0 serial port.

After the flashing process the ESP32 will anounce itself as **nimble-bleprph** device via BLE.



Build a BLE client example (central mode):

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

.. code-block:: shell-session



  cd examples/bluetooth/nimble/blecent

  idf.py -p /dev/ttyUSB0 flash monitor



This will build and flash the example to the ESP32 and instantly listens on /dev/ttyUSB0 serial port.

After the flashing process the ESP32 creates a GATT client and performs passive scan, it then connects to peripheral device if the device advertises connectability and the device advertises support for the Alert Notification service (0x1811) as primary service UUID.

Documentation/bluetooth/overview.rst

0 → 100644
+43 −0
Original line number Original line Diff line number Diff line 
.. _bluetooth_overview:



Overview

========



UUIDs

-----

Bluetooth uses UUIDs to identify almost everything. The Bluetooth SIG specifies

a number of "short" 16-bit UUIDs for general use. A device is free to define

other "long" 128-bit UUIDs if it wants to express non-standard functionality.



The card10 defines a few non-standard UUIDs. They are prefixed with ``4232``:





+--------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------+

| UUID                                 | Usage                                                 | Comment                                                            |

+======================================+=======================================================+====================================================================+

| 422301XX-2342-2342-2342-234223422342 | :ref:`File Transfer Service<bluetooth_file_transfer>` | Used by the Companion App to install apps on the card10            |

+--------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------+

| 422302XX-2342-2342-2342-234223422342 | :ref:`card10 Service<bluetooth_card10_service>`       | Controls general card10 functionality like LEDs and personal state |

+--------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------+

| 422303XX-2342-2342-2342-234223422342 | :ref:`ECG Service<bluetooth_ecg_service>`             | Allows to stream ECG measurements via BLE                          |

+--------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------+

| 422380XX-2342-2342-2342-234223422342 | Experimental usage                                    | To be used for development and experiments                         |

+--------------------------------------+-------------------------------------------------------+--------------------------------------------------------------------+



The first byte after the prefix identifies the service (e.g. ``03`` for ECG).

The next byte is reserved for UUIDs used by the service itself. The service

uses ``00`` at this position. The first attribute inside the service uses

``01`` at this position. See the documentation of any service for an example.



You can use the UUID range 422380XX-2342-2342-2342-234223422342 for your own

experiments / demos/ development. For example the demos under `demos/` in the

repository use this range of UUIDs.



BLE with MicroPython

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



MicroPython docs: https://docs.micropython.org/en/latest/library/bluetooth.html



Basic example: https://git.card10.badge.events.ccc.de/card10/firmware/-/blob/master/demos/ble-ws2812-card10.py and https://git.card10.badge.events.ccc.de/card10/firmware/-/blob/master/demos/ble-ws2812-host.py



MicroPython examples: https://github.com/micropython/micropython/tree/7c54b6428058a236b8a48c93c255948ece7e718b/examples/bluetooth

Documentation/build-docs.sh

+4 −0
Original line number Original line Diff line number Diff line
@@ -4,3 +4,7 @@ set -e 
cd "$(dirname "$0")"

cd "$(dirname "$0")"





sphinx-build -b html . ./output

sphinx-build -b html . ./output



if [ "$1" = "--open" ]; then

   xdg-open ./output/index.html

fi

Documentation/card10-cfg.rst

0 → 100644
+69 −0
Original line number Original line Diff line number Diff line 
.. _card10_cfg:



card10.cfg

==========



Certain high-level settings can be configured using a filed named ``card10.cfg``.  It is accessed from the :ref:`usb_file_transfer` of the bootloader.  Once you are in this mode and have mounted the badge's flash device, you can either create or update a file named ``card10.cfg``.



The file is in the well-known INI-style format, with one setting per line. For instance, if there were an option called ``answer_to_life``, you could set it by writing the following line in the ``card10.cfg`` file:



.. code-block:: text



   answer_to_life = 42



Don't forget to unmount the filesystem before rebooting your badge after changing any setting.



Syntax and Types

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



Lines that start with a ``#`` character are ignored.



Any other line will have the overall syntax of ``option_name = option_value``, with spaces around the ``=`` character optional.



Option names are internal to card10 and described below. Each option has a defined type.



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

Type name Description

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

Boolean   A true/false value. ``1`` or ``true`` is true, ``0`` or ``false`` is false. Example: ``foo = true``.

String    An unquoted string value of maximum 20 bytes. Values longer than 20 bytes are trimmed. Example: ``foo = bar``.

Integer   A signed 32-bit integer in base 10. Example: ``foo = 42`` or ``bar = -1337``.

Float     A single-precision (32-bit) floating-point number in base 10. Example: ``foo = 13.37``.

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



Supported options

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



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

Option name        Type       Description

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

``execute_elf``    Boolean    Allow running of binary :ref:`l0dables`. These files can be nefarious, so this option is off by default.

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

``timezone``       String     Timezone for card10; must be of format ``[+-]HHMM``.  Examples: ``+0800``, ``-0200``

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

``default_app``    String     Full path to the exectutable file of the default application. If this option is not set,``apps/analog_clock/__init__.py`` is used.

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

``ble_enable``     Boolean    Activate the BLE interface. Turn off for more privacy or to conserve energy.

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

``ble_mac``        Boolean    MAC address used for BLE. Format: ``ca:4d:10:xx:xx:xx``.

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

``ble_hid_enable`` Boolean    Enable the Human Interface Device (HID) characteristics on BLE.

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

``ble_log_enable`` Boolean    Activate HCI level logging of BLE data. Creates a new btsnoop compatible log file named ``ble.log`` in the ``logs`` folder after each boot if BLE is activated. Keeps the last 10 files.

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

``right_scroll``   Boolean    Use both right buttons to scroll up and down. Lower left button is SELECT.

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

``long_press_ms``  Integer    Defines the timespan for a long key press in milliseconds.

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

``retrigger_ms``   Integer    Defines the timespan for repeating key presses when a key is hold in milliseconds.

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

``bsec_enable``    Boolean    Activate the Bosch :ref:`bsec_api` binary blob to compute an Indoor Air Quality indication.

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

``bsec_debug``     Boolean    Turn on debug output of the BSEC system. Prints each meaurement on the console.

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

``bsec_offset``    Integer    Temperature offset in .1 K. Example: Set to `-14` if temperature reads 1.4 "C" to high. Default: -2.2 K (appropriate for a card10 without a case, connected to USB and with BLE active in vertical orientation).

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

``battery_check``  Boolean    Whether the low battery check should be enabled (default ``true``).  **Warning**: Do not use this unless you know what you're doing.  This option is only meant to be used on devices with a broken PMIC ADMUX connection.

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

``has_flashlight`` Boolean    Whether the flashlight LED was soldered onto the harmonic board.  Can be used by apps to optionally enable flashlight features.

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

Documentation/conf.py

+59 −1
Original line number Original line Diff line number Diff line
@@ -3,6 +3,8 @@ import subprocess 
import sys

import sys

import time

import time

import sphinx.util.logging

import sphinx.util.logging

from docutils import nodes

from docutils.parsers import rst





# If extensions (or modules to document with autodoc) are in another directory,

# If extensions (or modules to document with autodoc) are in another directory,

# add these directories to sys.path here. If the directory is relative to the

# add these directories to sys.path here. If the directory is relative to the
@@ -13,7 +15,6 @@ sys.path.insert(0, os.path.abspath("./")) 




logger = sphinx.util.logging.getLogger("card10/conf.py")

logger = sphinx.util.logging.getLogger("card10/conf.py")







# -- Project information -----------------------------------------------------

# -- Project information -----------------------------------------------------





project = "card10-firmware"

project = "card10-firmware"
@@ -47,6 +48,23 @@ todo_include_todos = True 
# This pattern also affects html_static_path and html_extra_path.

# This pattern also affects html_static_path and html_extra_path.

exclude_patterns = ["output", "Thumbs.db", ".DS_Store", "hawkmoth"]

exclude_patterns = ["output", "Thumbs.db", ".DS_Store", "hawkmoth"]





# -- Extensions -------------------------------------------------------------- {{{





class ColorExample(rst.Directive):

    has_content = False

    required_arguments = 1

    optional_arguments = 0

    option_spec = {}



    def run(self):

        color = self.arguments[0]

        html_text = '<div style="width: 30px;height: 30px;background: {};border: black 1px solid;border-radius: 15px;"></div>'

        return [nodes.raw("", html_text.format(color), format="html")]





# }}}



# -- Options for HTML output ------------------------------------------------- {{{

# -- Options for HTML output ------------------------------------------------- {{{





# The Read the Docs theme is available from

# The Read the Docs theme is available from
@@ -90,10 +108,17 @@ html_context = { 
autodoc_mock_imports = [

autodoc_mock_imports = [

    "buttons",

    "buttons",

    "interrupt",

    "interrupt",

    "sys_ble_hid",

    "sys_bme680",

    "sys_bhi160",

    "sys_display",

    "sys_display",

    "sys_leds",

    "sys_leds",

    "sys_max30001",

    "sys_max30001",

    "sys_max86150",

    "sys_png",

    "sys_config",

    "ucollections",

    "ucollections",

    "uerrno",

    "urandom",

    "urandom",

    "utime",

    "utime",

]

]
@@ -123,3 +148,36 @@ except ImportError as e: 
# -- Sphinx Setup ------------------------------------------------------------

# -- Sphinx Setup ------------------------------------------------------------

def setup(app):

def setup(app):

    app.add_config_value("has_hawkmoth", has_hawkmoth, "")

    app.add_config_value("has_hawkmoth", has_hawkmoth, "")

    app.add_directive("color-example", ColorExample)

    fix_issue_8945()





def fix_issue_8945():

    c_domain = __import__("sphinx.domains.c").domains.c



    for kw in [

        "char",

        "float",

        "int",

        "long",

        "short",

        "void",

        "_Bool",

        "bool",

        "_Complex",

        "complex",

    ]:

        if kw in c_domain._keywords:

            c_domain._keywords.remove(kw)

        if hasattr(c_domain, "_macroKeywords") and kw in c_domain._macroKeywords:

            c_domain._macroKeywords.remove(kw)



    def parse_xref_object(self):

        name = self._parse_nested_name()

        self.skip_ws()

        self.skip_string("()")

        # Removing this line as a hacky workaround:

        # self.assert_end()

        return name



    c_domain.DefinitionParser.parse_xref_object = parse_xref_object

Documentation/debugger.rst

+7 −1
Original line number Original line Diff line number Diff line
@@ -115,6 +115,12 @@ command to soft-reset card10. 
   ...

   ...

   (gdb)

   (gdb)





.. note::

   You will also find the following self-describing gdb files in the firmware

   root directory, which do not require additional arguments:

   ``flash-all.gdb,  flash-bootloader.gdb,

   flash-both.gdb,  flash-epicardium.gdb,  flash-pycardium.gdb``



.. warning::

.. warning::

   If you are used to use ``mon reset halt``, be aware that the card10 prototypes

   If you are used to use ``mon reset halt``, be aware that the card10 prototypes

   do not connect the reset line to the debugger. OpenOCD is configured to only do

   do not connect the reset line to the debugger. OpenOCD is configured to only do

Documentation/epicardium/internal.rst

0 → 100644
+8 −0
Original line number Original line Diff line number Diff line 
.. _epicardium_internal_apis:



Epicardium Internal APIs

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



Core OS APIs

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

.. c:autodoc:: epicardium/os/core.h

Documentation/epicardium/mutex.rst

0 → 100644
+136 −0
Original line number Original line Diff line number Diff line 
Mutex

=====

Ontop of FreeRTOS, we have our own mutex implementation.  **Never use the

FreeRTOS mutexes directly!  Always use this abstraction layer instead**.  This

mutex implementation tries to make reasoning about program flow and locking

behavior easier.  And most importantly tries to help with debugging possible

dead-locks.



Design

------

There are a few guiding design principles:



- Mutexes can only be used from tasks, **never** from interrupts!

- Timers can use mutexes, but only with :c:func:`mutex_trylock`, **never** with

  :c:func:`mutex_lock` (Because they are not allowed to block).

- Locking can *never* fail (if it does, we consider this a fatal error ⇒ panic).

- No recursive locking.

- An unlock can only occur from the task which previously acquired the mutex.

- An unlock is only allowed if the mutex was previously acquired.



For a more elaborate explanation of the rationale behind these rules take a

look at the :ref:`mutex-design-reasons`.



Definitions

-----------

.. c:autodoc:: epicardium/os/mutex.h



.. _mutex-design-reasons:



Reasons for this Design

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



Locking can *never* fail

^^^^^^^^^^^^^^^^^^^^^^^^

This might seem like a bold claim at first but in the end, it is just a matter

of definition and shifting responsibilities.  Instead of requiring all code to

be robust against a locking attempt failing, we require all code to properly

lock and unlock their mutexes and thus never producing a situation where

locking would fail.



Because all code using any of the mutexes is contained in the Epicardium

code-base, we can - *hopefully* - audit it properly behaving ahead of time and

thus don't need to add code to ensure correctness at runtime.  This makes

downstream code easier to read and easier to reason about.



History of this project has shown that most code does not properly deal with

locking failures anyway: There was code simply skipping the mutexed action on

failure, code blocking a module entirely until reboot, and worst of all: Code

exposing the locking failure to 'user-space' (Pycardium) instead of retrying.

This has lead to spurious errors where technically there would not need to be

any.



Only from tasks

^^^^^^^^^^^^^^^

Locking a mutex from an ISR, a FreeRTOS software timer or any other context

which does not allow blocking is complicated to do right.  The biggest

difficulty is that a task might be holding the mutex during execution of such a

context and there is no way to wait for it to release the mutex.  This requires

careful design of the program flow to choose an alternative option in such a

case.  A common approach is to 'outsource' the relevant parts of the code into

an 'IRQ worker' which is essentially just a task waiting for the IRQ to wake it

up and then attempts to lock the mutex.



If you absolutely do need it (and for legacy reasons), software timers *can*

lock a mutex using :c:func:`mutex_trylock` (which never blocks).  I strongly

recommend **not** doing that, though.  As shown above, you will have to deal

with the case of the mutex being held by another task and it is very well

possible that your timer will get starved of the mutex because the scheduler

has no knowledge of its intentions.  In most cases, it is a better idea to use

a task and attempt locking using :c:func:`mutex_lock`.



.. todo::



   We might introduce a generic IRQ worker queue system at some point.



No recursive locking

^^^^^^^^^^^^^^^^^^^^

Recursive locking refers to the ability to 'reacquire' a mutex already held by

the current task, deeper down in the call-chain.  Only the outermost unlock

will actually release the mutex.  This feature is sometimes implemented to

allow more elegant abstractions where downstream code does not need to know

about the mutexes upstream code uses and can still also create a larger region

where the same mutex is held.



But exactly by hiding the locking done by a function, these abstractions make

it hard to trace locking chains and in some cases even make it impossible to

create provably correct behavior.  As an alternative, I would suggest using

different mutexes for the different levels of abstraction.  This also helps

keeping each mutex separated and 'local' to its purpose.



Only unlock from the acquiring task

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Because of the above mentioned mutex locking semantics, there should never be a

need to force-unlock a forgein mutex.  Even in cases of failures, all code

should still properly release all mutexes it holds.  One notable exceptions is

``panic()``\s which will abort all ongoing operations anyway.



Only unlock once after acquisition

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Justified with an argument of robustness, sometimes the :c:func:`mutex_unlock`

call is written in a way that allows unlocking an already unlocked mutex.  But

robustness of downstream code will not really be improved by the upstream API

dealing with arguably invalid usage.  For example, this could encourage

practices like unlocking everything again at the end of a function "just to be

sure".



Instead, code should be written in a way where the lock/unlock pair is

immediately recognizable as belonging together and is thus easily auditable to

have correct locking behavior.  A common pattern to help with readability in

this regard is the *Single Function Exit* which looks like this:



.. code-block:: cpp



   int function()

   {

           int ret;

           mutex_lock(&some_mutex);



           ret = foo();

           if (ret) {

                   /* Return with an error code */

                   ret = -ENODEV;

                   goto out_unlock;

           }



           ret = bar();

           if (ret) {

                   /* Return the return value from foo */

                   goto out_unlock;

           }



           ret = 0;

   out_unlock:

           mutex_unlock(&some_mutex);

           return ret;

   }

Documentation/hawkmoth/README.rst

0 → 100644
+118 −0
Original line number Original line Diff line number Diff line 
Hawkmoth - Sphinx Autodoc for C

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



Hawkmoth is a minimalistic Sphinx_ `C Domain`_ autodoc directive extension to

incorporate formatted C source code comments written in reStructuredText_ into

Sphinx based documentation. It uses Clang Python Bindings for parsing, and

generates C Domain directives for C API documentation, and more. In short,

Hawkmoth is Sphinx Autodoc for C.



Hawkmoth aims to be a compelling alternative for documenting C projects using

Sphinx, mainly through its simplicity of design, implementation and use.



.. _Sphinx: http://www.sphinx-doc.org



.. _C Domain: http://www.sphinx-doc.org/en/stable/domains.html



.. _reStructuredText: http://docutils.sourceforge.net/rst.html



Example

-------



Given C source code with rather familiar looking documentation comments::



  /**

   * Get foo out of bar.

   */

  void foobar();



and a directive in the Sphinx project::



  .. c:autodoc:: filename.c



you can incorporate code documentation into Sphinx. It's as simple as that.



You can document functions, their parameters and return values, structs, unions,

their members, macros, function-like macros, enums, enumeration constants,

typedefs, variables, as well as have generic documentation comments not attached

to any symbols.



Documentation

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



Documentation on how to install and configure Hawkmoth, and write documentation

comments, with examples, is available in the ``doc`` directory in the source

tree, obviously in Sphinx format and using the directive extension. Pre-built

documentation `showcasing what Hawkmoth can do`_ is available at `Read the

Docs`_.



.. _showcasing what Hawkmoth can do: https://hawkmoth.readthedocs.io/en/latest/examples.html



.. _Read the Docs: https://hawkmoth.readthedocs.io/



Installation

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



You can install Hawkmoth from PyPI_ with::



  pip install hawkmoth



You'll additionally need to install Clang and Python 3 bindings for it through

your distro's package manager; they are not available via PyPI. For further

details, see the documentation.



Alternatively, installation packages are available for:



* `Arch Linux`_



In Sphinx ``conf.py``, add ``hawkmoth`` to ``extensions``, and point

``cautodoc_root`` at the source tree. See the extension documentation for

details.



.. _PyPI: https://pypi.org/project/hawkmoth/



.. _Arch Linux: https://aur.archlinux.org/packages/?K=hawkmoth



Development and Contributing

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



Hawkmoth source code is available on GitHub_. The development version can be

checked out via ``git`` using this command::



  git clone https://github.com/jnikula/hawkmoth.git



Please file bugs and feature requests as GitHub issues. Contributions are

welcome both as emailed patches to the mailing list and as pull requests.



.. _GitHub: https://github.com/jnikula/hawkmoth



Dependencies

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



- Python 3.4

- Sphinx 3

- Clang 6.0

- Python 3 Bindings for Clang 6.0

- sphinx-testing 1.0.0 (for development)



These are the versions Hawkmoth is currently being developed and tested

against. Other versions might work, but no guarantees.



License

-------



Hawkmoth is free software, released under the `2-Clause BSD License`_.



.. _2-Clause BSD License: https://opensource.org/licenses/BSD-2-Clause



Contact

-------



IRC channel ``#hawkmoth`` on freenode_.



Mailing list hawkmoth@freelists.org. Subscription information at the `list home

page`_.



.. _freenode: https://freenode.net/



.. _list home page: https://www.freelists.org/list/hawkmoth

Documentation/hawkmoth/README.txt

deleted100644 → 0
+0 −121
Original line number Original line Diff line number Diff line 
Hawkmoth - Sphinx Autodoc for C

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



Hawkmoth is a minimalistic Sphinx_ `C Domain`_ autodoc directive extension to

incorporate formatted C source code comments written in reStructuredText_ into

Sphinx based documentation. It uses Clang Python Bindings for parsing, and

generates C Domain directives for C API documentation, and more. In short,

Hawkmoth is Sphinx Autodoc for C.



Hawkmoth aims to be a compelling alternative for documenting C projects using

Sphinx, mainly through its simplicity of design, implementation and use.



.. _Sphinx: http://www.sphinx-doc.org



.. _C Domain: http://www.sphinx-doc.org/en/stable/domains.html



.. _reStructuredText: http://docutils.sourceforge.net/rst.html



Example

-------



Given C source code with rather familiar looking documentation comments::



  /**

   * Get foo out of bar.

   */

  void foobar();



and a directive in the Sphinx project::



  .. c:autodoc:: filename.c



you can incorporate code documentation into Sphinx. It's as simple as that.



You can document functions, their parameters and return values, structs, unions,

their members, macros, function-like macros, enums, enumeration constants,

typedefs, variables, as well as have generic documentation comments not attached

to any symbols.



Documentation

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



Documentation on how to configure Hawkmoth and write documentation comments,

with examples, is available in the ``doc`` directory in the source tree,

obviously in Sphinx format and using the directive extension. Pre-built

documentation `showcasing what Hawkmoth can do`_ is available at `Read the

Docs`_.



.. _showcasing what Hawkmoth can do: https://hawkmoth.readthedocs.io/en/latest/examples.html



.. _Read the Docs: https://hawkmoth.readthedocs.io/



Installation

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



You can install Hawkmoth from PyPI_ with::



  pip install hawkmoth



You'll additionally need to install Clang and Python 3 bindings for it through

your distro's package manager; they are not available via PyPI. You may also

need to set ``LD_LIBRARY_PATH`` so that the Clang library can be found. For

example::



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



Alternatively, installation packages are available for:



* `Arch Linux`_



In Sphinx ``conf.py``, add ``hawkmoth`` to ``extensions``, and point

``cautodoc_root`` at the source tree. See the extension documentation for

details.



.. _PyPI: https://pypi.org/project/hawkmoth/



.. _Arch Linux: https://aur.archlinux.org/packages/?K=hawkmoth



Development and Contributing

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



Hawkmoth source code is available on GitHub_. The development version can be

checked out via ``git`` using this command::



  git clone https://github.com/jnikula/hawkmoth.git



Please file bugs and feature requests as GitHub issues. Contributions are

welcome both as emailed patches to the mailing list and as pull requests.



.. _GitHub: https://github.com/jnikula/hawkmoth



Dependencies

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



- Python 3.4

- Sphinx 1.8

- Clang 6.0

- Python 3 Bindings for Clang 6.0

- sphinx-testing 1.0.0 (for development)



These are the versions Hawkmoth is currently being developed and tested

against. Other versions might work, but no guarantees.



License

-------



Hawkmoth is free software, released under the `2-Clause BSD License`_.



.. _2-Clause BSD License: https://opensource.org/licenses/BSD-2-Clause



Contact

-------



IRC channel ``#hawkmoth`` on freenode_.



Mailing list hawkmoth@freelists.org. Subscription information at the `list home

page`_.



.. _freenode: https://freenode.net/



.. _list home page: https://www.freelists.org/list/hawkmoth

Documentation/hawkmoth/VERSION

+1 −1
Original line number Original line Diff line number Diff line 
0.4
 
0.7.0

Documentation/hawkmoth/__init__.py

+5 −2
Original line number Original line Diff line number Diff line
@@ -52,7 +52,10 @@ class CAutoDocDirective(Directive): 
        env = self.state.document.settings.env

        env = self.state.document.settings.env





        for (severity, filename, lineno, msg) in errors:

        for (severity, filename, lineno, msg) in errors:

            if filename:

                toprint = '{}:{}: {}'.format(filename, lineno, msg)

                toprint = '{}:{}: {}'.format(filename, lineno, msg)

            else:

                toprint = '{}'.format(msg)





            if severity.value <= env.app.verbosity:

            if severity.value <= env.app.verbosity:

                self.logger.log(self._log_lvl[severity], toprint,

                self.logger.log(self._log_lvl[severity], toprint,
@@ -109,7 +112,7 @@ class CAutoDocDirective(Directive): 
        return node.children

        return node.children





def setup(app):

def setup(app):

    app.require_sphinx('1.8')

    app.require_sphinx('3.0')

    app.add_config_value('cautodoc_root', app.confdir, 'env')

    app.add_config_value('cautodoc_root', app.confdir, 'env')

    app.add_config_value('cautodoc_compat', None, 'env')

    app.add_config_value('cautodoc_compat', None, 'env')

    app.add_config_value('cautodoc_clang', None, 'env')

    app.add_config_value('cautodoc_clang', None, 'env')

Documentation/hawkmoth/__main__.py

+5 −2
Original line number Original line Diff line number Diff line
@@ -39,7 +39,10 @@ def main(): 
        print(doc)

        print(doc)





    for (severity, filename, lineno, msg) in errors:

    for (severity, filename, lineno, msg) in errors:

        if filename:

            print('{}: {}:{}: {}'.format(severity.name,

            print('{}: {}:{}: {}'.format(severity.name,

                                         filename, lineno, msg), file=sys.stderr)

                                         filename, lineno, msg), file=sys.stderr)

        else:

            print('{}: {}'.format(severity.name, msg), file=sys.stderr)





main()
 
main()

Documentation/hawkmoth/parser.py

+48 −23
Original line number Original line Diff line number Diff line 
# Copyright (c) 2016-2017 Jani Nikula <jani@nikula.org>

# Copyright (c) 2016-2017 Jani Nikula <jani@nikula.org>

# Copyright (c) 2018-2019 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>

# Copyright (c) 2018-2020 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>

# Licensed under the terms of BSD 2-Clause, see LICENSE for details.

# Licensed under the terms of BSD 2-Clause, see LICENSE for details.

"""

"""

Documentation comment extractor

Documentation comment extractor
@@ -34,7 +34,7 @@ Otherwise, documentation comments are passed through verbatim. 
"""

"""





import enum

import enum

import itertools

import re

import sys

import sys





from clang.cindex import CursorKind, TypeKind

from clang.cindex import CursorKind, TypeKind
@@ -75,18 +75,22 @@ def comment_extract(tu): 
            current_comment = token

            current_comment = token

            continue

            continue





        # Store off the token's cursor for a slight performance improvement

        # instead of accessing the `cursor` property multiple times.

        token_cursor = token.cursor



        # cursors that are 1) never documented themselves, and 2) allowed

        # cursors that are 1) never documented themselves, and 2) allowed

        # between comment and the actual cursor being documented

        # between comment and the actual cursor being documented

        if (token.cursor.kind == CursorKind.INVALID_FILE or

        if (token_cursor.kind == CursorKind.INVALID_FILE or

            token.cursor.kind == CursorKind.TYPE_REF or

            token_cursor.kind == CursorKind.TYPE_REF or

            token.cursor.kind == CursorKind.PREPROCESSING_DIRECTIVE or

            token_cursor.kind == CursorKind.PREPROCESSING_DIRECTIVE or

            token.cursor.kind == CursorKind.MACRO_INSTANTIATION):

            token_cursor.kind == CursorKind.MACRO_INSTANTIATION):

            continue

            continue





        if cursor is not None and token.cursor == cursor:

        if cursor is not None and token_cursor == cursor:

            continue

            continue





        cursor = token.cursor

        cursor = token_cursor





        # Note: current_comment may be None

        # Note: current_comment may be None

        if current_comment != None and docstr.is_doc(current_comment.spelling):

        if current_comment != None and docstr.is_doc(current_comment.spelling):
@@ -125,16 +129,18 @@ def _get_macro_args(cursor): 
    if cursor.kind != CursorKind.MACRO_DEFINITION:

    if cursor.kind != CursorKind.MACRO_DEFINITION:

        return None

        return None





    tokens = cursor.get_tokens()



    # Use the first two tokens to make sure this starts with 'IDENTIFIER('

    # Use the first two tokens to make sure this starts with 'IDENTIFIER('

    x = [token for token in itertools.islice(cursor.get_tokens(), 2)]

    one = next(tokens)

    if (len(x) != 2 or x[0].spelling != cursor.spelling or

    two = next(tokens, None)

        x[1].spelling != '(' or x[0].extent.end != x[1].extent.start):

    if two is None or one.extent.end != two.extent.start or two.spelling != '(':

        return None

        return None





    # Naïve parsing of macro arguments

    # Naïve parsing of macro arguments

    # FIXME: This doesn't handle GCC named vararg extension FOO(vararg...)

    # FIXME: This doesn't handle GCC named vararg extension FOO(vararg...)

    args = []

    args = []

    for token in itertools.islice(cursor.get_tokens(), 2, None):

    for token in tokens:

        if token.spelling == ')':

        if token.spelling == ')':

            return args

            return args

        elif token.spelling == ',':

        elif token.spelling == ',':
@@ -161,8 +167,26 @@ def _recursive_parse(comments, cursor, nest, compat): 
        return _result(comment, cursor=cursor, fmt=fmt,

        return _result(comment, cursor=cursor, fmt=fmt,

                       nest=nest, name=name, args=args, compat=compat)

                       nest=nest, name=name, args=args, compat=compat)





    elif cursor.kind == CursorKind.VAR_DECL:

    elif cursor.kind in [CursorKind.VAR_DECL, CursorKind.FIELD_DECL]:

        if cursor.kind == CursorKind.VAR_DECL:

            fmt = docstr.Type.VAR

            fmt = docstr.Type.VAR

        else:

            fmt = docstr.Type.MEMBER



        # If this is an array, the dimensions should be applied to the name, not

        # the type.

        dims = ttype.rsplit(' ', 1)[-1]

        if dims.startswith('[') and dims.endswith(']'):

            ttype = ttype.rsplit(' ', 1)[0]

            name = name + dims



        # If this is a function pointer, or an array of function pointers, the

        # name should be within the parenthesis as in (*name) or (*name[N]).

        fptr_type = re.sub(r'\((\*+)(\[[^]]*\])?\)', r'(\1{}\2)'.format(name),

                           ttype, count=1)

        if fptr_type != ttype:

            name = fptr_type

            ttype = ''





        return _result(comment, cursor=cursor, fmt=fmt,

        return _result(comment, cursor=cursor, fmt=fmt,

                       nest=nest, name=name, ttype=ttype, compat=compat)

                       nest=nest, name=name, ttype=ttype, compat=compat)
@@ -188,9 +212,15 @@ def _recursive_parse(comments, cursor, nest, compat): 




        # FIXME: Handle anonymous enumerators.

        # FIXME: Handle anonymous enumerators.





        fmt = docstr.Type.TYPE

        fmts = {CursorKind.STRUCT_DECL: docstr.Type.STRUCT,

                CursorKind.UNION_DECL: docstr.Type.UNION,

                CursorKind.ENUM_DECL: docstr.Type.ENUM}



        fmt = fmts[cursor.kind]



        # name may be empty for typedefs

        result = _result(comment, cursor=cursor, fmt=fmt,

        result = _result(comment, cursor=cursor, fmt=fmt,

                         nest=nest, name=ttype, compat=compat)

                         nest=nest, name=name if name else ttype, compat=compat)





        nest += 1

        nest += 1

        for c in cursor.get_children():

        for c in cursor.get_children():
@@ -205,12 +235,6 @@ def _recursive_parse(comments, cursor, nest, compat): 
        return _result(comment, cursor=cursor, fmt=fmt,

        return _result(comment, cursor=cursor, fmt=fmt,

                       nest=nest, name=name, compat=compat)

                       nest=nest, name=name, compat=compat)





    elif cursor.kind == CursorKind.FIELD_DECL:

        fmt = docstr.Type.MEMBER



        return _result(comment, cursor=cursor, fmt=fmt,

                       nest=nest, name=name, ttype=ttype, compat=compat)



    elif cursor.kind == CursorKind.FUNCTION_DECL:

    elif cursor.kind == CursorKind.FUNCTION_DECL:

        # FIXME: check args against comment

        # FIXME: check args against comment

        # FIXME: children may contain extra stuff if the return type is a

        # FIXME: children may contain extra stuff if the return type is a
@@ -261,7 +285,8 @@ def clang_diagnostics(errors, diagnostics): 
           4: ErrorLevel.ERROR}

           4: ErrorLevel.ERROR}





    for diag in diagnostics:

    for diag in diagnostics:

        errors.extend([(sev[diag.severity], diag.location.file.name,

        filename = diag.location.file.name if diag.location.file else None

        errors.extend([(sev[diag.severity], filename,

                        diag.location.line, diag.spelling)])

                        diag.location.line, diag.spelling)])





# return a list of (comment, metadata) tuples

# return a list of (comment, metadata) tuples

Documentation/hawkmoth/util/docstr.py

+10 −4
Original line number Original line Diff line number Diff line 
# Copyright (c) 2016-2017 Jani Nikula <jani@nikula.org>

# Copyright (c) 2016-2020 Jani Nikula <jani@nikula.org>

# Copyright (c) 2018-2019 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>

# Copyright (c) 2018-2020 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>

# Licensed under the terms of BSD 2-Clause, see LICENSE for details.

# Licensed under the terms of BSD 2-Clause, see LICENSE for details.

"""

"""

Documentation strings manipulation library

Documentation strings manipulation library
@@ -17,6 +17,9 @@ class Type(Enum): 
    TEXT = auto()

    TEXT = auto()

    VAR = auto()

    VAR = auto()

    TYPE = auto()

    TYPE = auto()

    STRUCT = auto()

    UNION = auto()

    ENUM = auto()

    ENUM_VAL = auto()

    ENUM_VAL = auto()

    MEMBER = auto()

    MEMBER = auto()

    MACRO = auto()

    MACRO = auto()
@@ -31,10 +34,13 @@ _doc_fmt = { 
    Type.TEXT:       (0, '\n{text}\n'),

    Type.TEXT:       (0, '\n{text}\n'),

    Type.VAR:        (1, '\n.. c:var:: {ttype} {name}\n\n{text}\n'),

    Type.VAR:        (1, '\n.. c:var:: {ttype} {name}\n\n{text}\n'),

    Type.TYPE:       (1, '\n.. c:type:: {name}\n\n{text}\n'),

    Type.TYPE:       (1, '\n.. c:type:: {name}\n\n{text}\n'),

    Type.ENUM_VAL:   (1, '\n.. c:macro:: {name}\n\n{text}\n'),

    Type.STRUCT:     (1, '\n.. c:struct:: {name}\n\n{text}\n'),

    Type.UNION:      (1, '\n.. c:union:: {name}\n\n{text}\n'),

    Type.ENUM:       (1, '\n.. c:enum:: {name}\n\n{text}\n'),

    Type.ENUM_VAL:   (1, '\n.. c:enumerator:: {name}\n\n{text}\n'),

    Type.MEMBER:     (1, '\n.. c:member:: {ttype} {name}\n\n{text}\n'),

    Type.MEMBER:     (1, '\n.. c:member:: {ttype} {name}\n\n{text}\n'),

    Type.MACRO:      (1, '\n.. c:macro:: {name}\n\n{text}\n'),

    Type.MACRO:      (1, '\n.. c:macro:: {name}\n\n{text}\n'),

    Type.MACRO_FUNC: (1, '\n.. c:function:: {name}({args})\n\n{text}\n'),

    Type.MACRO_FUNC: (1, '\n.. c:macro:: {name}({args})\n\n{text}\n'),

    Type.FUNC:       (1, '\n.. c:function:: {ttype} {name}({args})\n\n{text}\n')

    Type.FUNC:       (1, '\n.. c:function:: {ttype} {name}({args})\n\n{text}\n')

}

}

Documentation/hawkmoth/util/readthedocs.py

0 → 100644
+25 −0
Original line number Original line Diff line number Diff line 
# Copyright (c) 2021, Jani Nikula <jani@nikula.org>

# Licensed under the terms of BSD 2-Clause, see LICENSE for details.

"""

Read the Docs Helpers

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



Helpers for setting up and using Hawkmoth on Read the Docs.

"""



import os

import subprocess



def clang_setup(force=False):

    """Try to find and configure libclang location on RTD."""

    if 'READTHEDOCS' in os.environ or force:

        try:

            result = subprocess.run(['llvm-config', '--libdir'],

                                    check=True, capture_output=True, encoding='utf-8')

            libdir = result.stdout.strip()



            # For some reason there is no plain libclang.so symlink on RTD.

            from clang.cindex import Config

            Config.set_library_file(os.path.join(libdir, 'libclang.so.1'))

        except Exception as e:

            print(e)

Documentation/how-to-build.rst

+73 −15
Original line number Original line Diff line number Diff line
@@ -71,14 +71,42 @@ Dependencies 
        brew install ninja

        brew install ninja

        pip3 install --user meson  # see https://mesonbuild.com/Getting-meson.html - you will have to add ~/.local/bin to your PATH.

        pip3 install --user meson  # see https://mesonbuild.com/Getting-meson.html - you will have to add ~/.local/bin to your PATH.





* **python3-crc16**: Install with ``pip3 install --user crc16``.

* One of two CRC packages is required. Pick one:

* **python3-pillow**: Python Image Library ``pip3 install --user pillow``.



  - Ubuntu / Debian / macOS



    .. code-block:: shell-session



        pip3 install --user crc16



or



    .. code-block:: shell-session



        apt install python3-crcmod



or



    .. code-block:: shell-session



        pip3 install --user crcmod



  - Arch



    .. code-block:: shell-session



       pacman -S python-crc16



* **python3-pillow**: Python Image Library

       .. code-block:: shell-session



            pip3 install --user pillow





  - Arch

  - Arch





    .. code-block:: shell-session

    .. code-block:: shell-session





       pacman -S python-crc16 python-pillow

       pacman -S python-pillow





.. _ARM's GNU toolchain: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads

.. _ARM's GNU toolchain: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads
@@ -107,7 +135,6 @@ firmware features: 
  info related to BLE.

  info related to BLE.

- ``-Ddebug_core1=true``: Enable the core 1 SWD lines which are exposed on the

- ``-Ddebug_core1=true``: Enable the core 1 SWD lines which are exposed on the

  SAO connector.  Only use this if you have a debugger which is modified for core 1.

  SAO connector.  Only use this if you have a debugger which is modified for core 1.

- ``-Djailbreak_card10=true``: Enable execution of .elf l0dables on core 1.





.. warning::

.. warning::
@@ -144,6 +171,15 @@ In order to do a rebuild you can issue a clean command to ninja via 




Otherwise, rerunning ``./bootstrap.sh`` will also clean the build-directory.

Otherwise, rerunning ``./bootstrap.sh`` will also clean the build-directory.





.. note::



   **macOS**: If ``strip`` fails to work on the freshly compiled ``mpy-cross``:

   "strip: object: (...)/lib/micropython/micropython/mpy-cross/mpy-cross

   malformed object (unknown load command 9)", you a likely not using the

   `strip` that matches to your ``clang``. Do ``which strip && which clang``,

   and if the paths don't match, clean up your PATHs, or as a quick hack,

   create a symlink for strip.



.. note::

.. note::





   If you try to flash pycardium_epicardium.bin (renamed to card10.bin)

   If you try to flash pycardium_epicardium.bin (renamed to card10.bin)
@@ -153,3 +189,25 @@ Otherwise, rerunning ``./bootstrap.sh`` will also clean the build-directory. 
   (it's supposed to create a large file with 0xff in it) - this requires the

   (it's supposed to create a large file with 0xff in it) - this requires the

   LC_ALL environment variable to be not set, or set to "C"

   LC_ALL environment variable to be not set, or set to "C"

   (but not UTF8 or similar).

   (but not UTF8 or similar).



Docker

======

Alternatively, clone the ``master`` branch of the firmware repository and enter it:



.. code-block:: shell-session



   $ git clone https://git.card10.badge.events.ccc.de/card10/firmware.git

   $ cd firmware



Afterwards, build a docker-container which will build the firmware via:



.. code-block:: shell-session



   $ docker build -f docker/Dockerfile_fwbuild -t card10-firmware-builder .



Now, you can start the container with the firmware directory mounted, which will build the

firmware into the firmware/build directory:



.. code-block:: shell-session



   $ docker run -v $(pwd):/firmware card10-firmware-builder

Documentation/how-to-flash.rst

+6 −19
Original line number Original line Diff line number Diff line
@@ -5,27 +5,14 @@ method of flashing: 




Flash Without Debugger

Flash Without Debugger

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

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

If you do not have a debugger, you have to update the firmware using our

bootloader.  To do so, you need to reboot card10 while keeping the buttom on

the bottom right pressed.  Rebooting is done by either short pressing the power

button (top left) while you have a working firmware, or turning the card10 off

completely (by pressing the power button for 8 seconds) and then starting it again.



.. image:: static/bootloader-buttons.png



If you did everything correctly, the bootloader will display:





.. code-block:: text

If you do not have a debugger, you have to update the firmware using our



bootloader by going into :ref:`usb_file_transfer`.

   Bootloader

   Jul 28 2019

   USB activated.

   Ready.





On your host, you should now see an 8MB flash-device appear.  You can now drop

After you get your badge into :ref:`usb_file_transfer`, you can drop the firmware's

the firmware's ``.bin`` (from ``build/pycardium/pycardium_epicardium.bin`` in

``.bin`` (from ``build/pycardium/pycardium_epicardium.bin`` in most cases) into

most cases) into this flash-storage.  You **must** call the file ``card10.bin``

this flash-storage.  You **must** call the file ``card10.bin`` for the

for the bootloader to use it.

bootloader to use it.





The bootloader will then display ``Writing.`` in red while it is actually

The bootloader will then display ``Writing.`` in red while it is actually

writing the file to external flash.  Please wait until it displays ``Ready.``

writing the file to external flash.  Please wait until it displays ``Ready.``

Documentation/index.rst

+13 −0
Original line number Original line Diff line number Diff line
@@ -23,32 +23,40 @@ Last but not least, if you want to start hacking the lower-level firmware, the 
   pycardium/overview

   pycardium/overview

   pycardium/stdlib

   pycardium/stdlib

   pycardium/bhi160

   pycardium/bhi160

   pycardium/ble_hid

   pycardium/bme680

   pycardium/bme680

   pycardium/max30001

   pycardium/max30001

   pycardium/max86150

   pycardium/buttons

   pycardium/buttons

   pycardium/color

   pycardium/color

   pycardium/config

   pycardium/display

   pycardium/display

   pycardium/gpio

   pycardium/gpio

   pycardium/leds

   pycardium/leds

   pycardium/light-sensor

   pycardium/light-sensor

   pycardium/os

   pycardium/os

   pycardium/personal_state

   pycardium/personal_state

   pycardium/png

   pycardium/power

   pycardium/power

   pycardium/pride

   pycardium/pride

   pycardium/simple_menu

   pycardium/simple_menu

   pycardium/utime

   pycardium/utime

   pycardium/vibra

   pycardium/vibra

   pycardium/ws2812





.. toctree::

.. toctree::

   :maxdepth: 1

   :maxdepth: 1

   :caption: Firmware

   :caption: Firmware





   overview

   overview

   card10-cfg

   usb-file-transfer

   how-to-build

   how-to-build

   how-to-flash

   how-to-flash

   debugger

   debugger

   pycardium-guide

   pycardium-guide

   memorymap

   memorymap

   epicardium/mutex

   epicardium/sensor-streams

   epicardium/sensor-streams





.. toctree::

.. toctree::
@@ -58,13 +66,18 @@ Last but not least, if you want to start hacking the lower-level firmware, the 
   epicardium/overview

   epicardium/overview

   epicardium/api

   epicardium/api

   epicardium-guide

   epicardium-guide

   epicardium/internal





.. toctree::

.. toctree::

   :maxdepth: 1

   :maxdepth: 1

   :caption: Bluetooth

   :caption: Bluetooth





   bluetooth/overview

   bluetooth/ess

   bluetooth/file-transfer

   bluetooth/file-transfer

   bluetooth/card10

   bluetooth/card10

   bluetooth/ecg

   bluetooth/nimble





Indices and tables

Indices and tables

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

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

Documentation/overview.rst

+45 −23
Original line number Original line Diff line number Diff line
@@ -14,24 +14,39 @@ Epicardium 
Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_.  There are a

Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_.  There are a

number of tasks that will have been keeping card10 running.  These are:

number of tasks that will have been keeping card10 running.  These are:





* **Dispatcher**:  The dispatcher task handles API calls from core 1.

+--------------------+-------------------------------+----------+-------------------------------------------+

* **PMIC**:  The power manager task checks the battery level and other interesting

| Name               | ID Global                     | Priority | Description                               |

  statistics that can be gathered from our power manager IC (MAX77650).

+====================+===============================+==========+===========================================+

* **Serial**:  Handles serial communication via *UART*, *CDC ACM* and possibly

| `vPmicTask`_       | ``pmic_task_id`` (static)     | +4       | Power Management (and Reset Button)       |

  Bluetooth.

+--------------------+-------------------------------+----------+-------------------------------------------+

* **BHI160**: Housekeeping task for interaction with the `BHI160`_.

| `vLifecycleTask`_  | ``lifecycle_task`` (static)   | +3       | Control of the payload running on core 1. |



+--------------------+-------------------------------+----------+-------------------------------------------+

| `vBleTask`_        | ``ble_task_id`` (static)      | +3       | Bluetooth Low Energy Stack                |

+--------------------+-------------------------------+----------+-------------------------------------------+

| `vSerialTask`_     | ``serial_task_id``            | +3       | Serial Output via UART/CDC-ACM/BLE        |

+--------------------+-------------------------------+----------+-------------------------------------------+

| `vApiDispatcher`_  | ``dispatcher_task_id``        | +2       | Epicardium API dispatcher                 |

+--------------------+-------------------------------+----------+-------------------------------------------+

| `vInterruptsTask`_ | ``interrupts_task`` (static)  | +2       | Interrupt dispatcher worker               |

+--------------------+-------------------------------+----------+-------------------------------------------+

| `vMAX30001Task`_   | ``max30001_task_id`` (static) | +1       | `MAX30001`_ ECG driver                    |

+--------------------+-------------------------------+----------+-------------------------------------------+

| `vBhi160Task`_     | ``bhi160_task_id`` (static)   | +1       | `BHI160`_ sensor fusion driver            |

+--------------------+-------------------------------+----------+-------------------------------------------+



.. _vPmicTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/pmic.c#L281

.. _vLifecycleTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/lifecycle.c#L361

.. _vBleTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/ble/ble.c#L237

.. _vSerialTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/serial.c#L289

.. _vApiDispatcher: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/dispatcher.c#L25

.. _vInterruptsTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/interrupts.c#L119

.. _vLedTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/personal_state.c#L58

.. _vMAX30001Task: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/max30001.c#L378

.. _vBhi160Task: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/bhi.c#L419



.. _MAX30001: https://www.maximintegrated.com/en/products/analog/data-converters/analog-front-end-ics/MAX30001.html

.. _BHI160: https://www.bosch-sensortec.com/bst/products/all_products/bhi160

.. _BHI160: https://www.bosch-sensortec.com/bst/products/all_products/bhi160





.. todo::



   The following tasks have not yet been implemented/are currently in the works:



   - **Bluetooth**: The bluetooth stack (`#23`_)

   - **Payload Controller**: Control what is running on core 1



   .. _#23: https://git.card10.badge.events.ccc.de/card10/firmware/issues/23



Epicardium API

Epicardium API

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

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

Epicardium exposes lots of functionality via the *Epicardium API*.  The

Epicardium exposes lots of functionality via the *Epicardium API*.  The
@@ -41,23 +56,30 @@ you should probably read the :ref:`epicardium_api_guide` guide. 




Pycardium

Pycardium

---------

---------



Pycardium is our MicroPython fork.  Its purpose is to make it as easy as

Pycardium is our MicroPython fork.  Its purpose is to make it as easy as

possible to interact with card10.  If you are interested in working on

possible to interact with card10.  If you are interested in working on

Pycardium, take a look at the :ref:`pycardium_guide` guide.

Pycardium, take a look at the :ref:`pycardium_guide` guide.





L0dables

.. _l0dables:



l0dables

--------

--------



Next to Pycardium, other bare-metal code can also run on core 1.  For example,

Next to Pycardium, other bare-metal code can also run on core 1.  For example,

a Rustcardium or C-cardium.  These l0dables must be compiled using our special

a `Rustcardium`_ or C-cardium.  These l0dables must be compiled using our special

linker script and should link against the api-caller library so they can

linker script and should link against the api-caller library so they can

interface with the :ref:`epicardium_api`.

interface with the :ref:`epicardium_api`.

Note: this feature is disabled by default and has to be enabled at build time.

To do this, run ``bootstrap.sh`` with the option ``-Djailbreak_card10=true``

and rebuild the firmware as described in :ref:`how_to_build`.





.. todo::

Note: this feature is disabled by default and has to be enabled in :ref:`card10_cfg`. A :ref:`card10_cfg` file dropped into the :ref:`usb_file_transfer` of the badge containing ``execute_elf = true`` is enough.



l0dables are currently built within the source tree of the main repository. See |l0dables_blinky|_ for an example of a hello-world-like program. Within those programs, you can access the :ref:`epicardium_api` to control the hardware and behaviour of the badge.



Once you have a built ELF file, you can drop it into the FAT filesystem of the flash (eg. via :ref:`usb_file_transfer`) and it will be available from the menu program of the badge.





   Provide more details how this works

.. _Rustcardium: https://git.card10.badge.events.ccc.de/astro/rust-card10

.. |l0dables_blinky| replace:: ``l0dables/blinky``

.. _l0dables_blinky: https://git.card10.badge.events.ccc.de/card10/firmware/-/tree/master/l0dables





Program Flow Diagram

Program Flow Diagram

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

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

Documentation/pycardium/bhi160.rst

+51 −86
Original line number Original line Diff line number Diff line
@@ -2,101 +2,66 @@ 




``bhi160`` - Sensor Fusion

``bhi160`` - Sensor Fusion

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

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



.. versionadded:: 1.4

.. versionadded:: 1.4





Supports the BHI160 sensor on the card10 for accelerometer, gyroscope...

Supports the BHI160 sensor on the card10 for accelerometer, gyroscope,

magnetometer and orientation.



The coordinate system of the BHI160 sensor data looks like this:



.. image:: ../static/bhi160-coordinates.png



* The **accelerometer** axes are just the ones shown in the picture.

* The **gyroscope**'s angular velocities rotate counter clockwise around

  their respective axis.

* The **orientation** sensor uses the following mapping:



  +---------------------+----------------------+-------------------+

  | X                   | Y                    | Z                 |

  +=====================+======================+===================+

  | Azimuth (0° - 360°) | Pitch (-180° - 180°) | Roll (-90° - 90°) |

  +---------------------+----------------------+-------------------+





**Example**:

**Example**:





.. code-block:: python

.. code-block:: python





   import bhi160

   import bhi160

   import utime

   import time





   bhi = bhi160.BHI160Orientation()

   bhi = bhi160.BHI160Orientation()





    while True:

    while True:

        samples = bhi.read()

        samples = bhi.read()

        print(samples)

        if len(samples) == 0:

        utime.sleep(0.5)

            time.sleep(0.25)



            continue



        # print the latest sample

.. class:: bhi160.BHI160Orientation(sample_rate,dynamic_range,callback,sample_buffer_len)

        print(samples[-1])



        time.sleep(0.25)

    Orientation of the BHI160







    Parameters:

Orientation

        sample_rate: int, optional

-----------

            Sample rate (default is 4)

.. autoclass:: bhi160.BHI160Orientation

        dynamic_range: int, optional

   :members:

            Dynamic range (default is 2)

   :inherited-members:

        callback: callable, optional



            Call this callback when enough data is collected (default is None)

Accelerometer



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

            .. todo:: The callback functionality is untested, so do not be confused if it does not work.

.. autoclass:: bhi160.BHI160Accelerometer

        sample_buffer_len: int, optional

  :members:

            Length of sample buffer (default is 200)

  :inherited-members:





   .. py:method:: read():

Gyroscope



---------

   Read sensor values

.. autoclass:: bhi160.BHI160Gyroscope



  :members:

   :returns: Collected sensor values as list

  :inherited-members:





   .. py:method:: close():

Magnetometer



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

   Close the connection to the sensor

.. autoclass:: bhi160.BHI160Magnetometer



  :members:

   

  :inherited-members:
 
.. class:: bhi160.BHI160Accelerometer



    Accelerometer of the BHI160



    Parameters:

        sample_rate: int, optional

            Sample rate (default is 4)

        dynamic_range: int, optional

            Dynamic range (default is 2)

        callback: callable, optional

            Call this callback when enough data is collected (default is None)



            .. todo:: The callback functionality is untested, so do not be confused if it does not work.

        sample_buffer_len: int, optional

            Length of sample buffer (default is 200)



   .. py:method:: read():



   Read sensor values



   :returns: Collected sensor values as list



   .. py:method:: close():



   Close the connection to the sensor



.. class:: bhi160.BHI160Gyroscope



    Gyroscope of the BHI160



    Parameters:

        sample_rate: int, optional

            Sample rate (default is 4)

        dynamic_range: int, optional

            Dynamic range (default is 2)

        callback: callable, optional

            Call this callback when enough data is collected (default is None)



            .. todo:: The callback functionality is untested, so do not be confused if it does not work.

        sample_buffer_len: int, optional

            Length of sample buffer (default is 200)



   .. py:method:: read():



   Read sensor values



   :returns: Collected sensor values as list



   .. py:method:: close():



   Close the connection to the sensor

Documentation/pycardium/ble_hid.rst

0 → 100644
+88 −0
Original line number Original line Diff line number Diff line 
``ble_hid`` - BLE HID

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

The ``ble_hid`` module provides access to the BLE Human Interface Device functionality.



.. note::

    Make sure to enable the BLE HID functionality in :ref:`card10_cfg` and reboot your card10

    if you want to use BLE HID.



    Also make sure that the ``adafruit_hid`` folder from the card10 release archive is placed

    on the file system of your card10.





.. warning::

    At least Ubuntu Linux will keep auto connecting to BLE HID devices once they are

    paired to the host computer. If you want to connect your card10 to a phone again,

    you might have to temporarily turn off Bluetooth on your computer.



An example application can be found in the preload directory (named ``HID Demo``). It provides

examples how to use the card10 as keyboard, mouse or volume control.



Please refer to the Adafruit CircuitPython HID library for examples how to use the HID service.

The card10 implements the same HID descriptors as the Adafruit CircuitPython BLE library and

should be compatible with all uses of the Adafruit CircuitPython HID library.



**Example emulating a keyboard**:



Adapted from https://github.com/adafruit/Adafruit_Learning_System_Guides/blob/master/CPB_Keybutton_BLE/cpb_keybutton_ble.py



A more complete version of this example can be found in the HID Demo app on your card10.



.. code-block:: python



    import ble_hid

    from adafruit_hid.keyboard import Keyboard

    from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS

    from adafruit_hid.keycode import Keycode



    k = Keyboard(ble_hid.devices)

    kl = KeyboardLayoutUS(k)



    k.send(Keycode.BACKSPACE)



    # use keyboard_layout for words

    kl.write("Demo with a long text to show how fast a card10 can type!")



    # add shift modifier

    k.send(Keycode.SHIFT, Keycode.F19)





**Example emulating a mouse**:



.. code-block:: python



    import ble_hid

    import bhi160

    import buttons

    from adafruit_hid.mouse import Mouse



    m = Mouse(ble_hid.devices)



    def send_report(samples):

        if len(samples) > 0:

            x = -int(samples[0].z)

            y = -int(samples[0].y)

            m.move(x, y)



    sensor = bhi160.BHI160Orientation(sample_rate=10, callback=send_report)



    b_old = buttons.read()

    while True:

        b_new = buttons.read()

        if not b_old == b_new:

            print(b_new)

            b_old = b_new

            if b_new == buttons.TOP_RIGHT:

                m.click(Mouse.MIDDLE_BUTTON)

            elif b_new == buttons.BOTTOM_RIGHT:

                m.click(Mouse.RIGHT_BUTTON)

            elif b_new == buttons.BOTTOM_LEFT:

                m.click(Mouse.LEFT_BUTTON)



.. note::

    Make sure to catch ``OSError`` exceptions in real applications. The exception will be thrown if

    there is connection to the host (or if it is lost) and you want to send an event.





.. automodule:: ble_hid

   :members:

Documentation/pycardium/bme680.rst

+74 −9
Original line number Original line Diff line number Diff line
@@ -2,24 +2,83 @@ 




``bme680`` - Environmental Sensor

``bme680`` - Environmental Sensor

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

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

Allows access to environmental data of card10's surroundings.



If ``bsec_enable`` is set in :ref:`card10_cfg`, the proprietary Bosch BSEC

library will be activated which offers the following extra functionality:



 - Manual temperature offset compensation

    The ``bsec_offset`` configuration allows to configure a static temperature

    offset. Please use a reference thermometer to determine the offset of your

    card10. If no offset is provided a default offset for a card10 which is

    connected to USB, has BLE active and is without a case is used.

 - A fixed measurement interval of 3 seconds

    This helps to stabilize the temperature of the card10.

 - An indoor air quality (IAQ)  and equivalent CO2 estimation algorithm

    Please refer to the :ref:`bsec_api` API documentation to get more information

    about how to interpret these estimates.



.. note::

   Please keep in mind that the BME680 can not directly measure CO2. It measures

   Volatile Organic Compounds (VOCs). The BSEC library uses this measurement

   to compute an Indoor Air Quality (IAQ) indication. It also assumes that all VOCs

   in the air are from human breath and computes an equivalent CO2 (eCO2)

   value from this. Please be aware of these facts when judging the accuracy

   of the IAQ and eCO2 values. Some more information can be found in the

   :ref:`bsec_api` API documentation.



.. warning::

   For the BSEC library to properly work the card10 should be kept running

   for at least 10 hours at least once. This is needed as the BSEC library

   periodically writes calibration information about the sensor to the

   card10's file system.



   Please make sure to observe the IAQ accuracy field. It will tell you if the

   IAQ and eCO2 measurements are deemed "accurate" by the BSEC library. Your

   application should either inform the user about the current accuracy (e.g.

   by color coding) or simply not show any values if the accuracy is below 2.





.. note::

   See also the BLE :ref:`ESS`.







**Example**:

**Example**:





.. code-block:: python

.. code-block:: python





   import bme680, utime

   import bme680, time



   bme680.init()





   with bme680.Bme680() as environment:

       while True:

       while True:

       temperature, humidity, pressure, resistance = bme680.get_data()

           d = environment.get_data()



           print("Temperature:    {:10.2f} °C".format(d.temperature))

           print("Humidity:       {:10.2f} % r.h.".format(d.humidity))

           print("Pressure:       {:10.2f} hPa".format(d.pressure))

           print("Gas Resistance: {:10.2f} Ω".format(d.resistance))



           time.sleep(1)



You can use the return type of :py:meth:`~bme680.Bme680.get_data` to decide

if you want to use/display the additonal fields returned if BSEC is enabled.



.. code-block:: python



    if isinstance(d, bme680.BSECData):

        print("Air quality:    {:7d}".format(d.iaq))



Sensor Class

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





       print("Temperature:    {:10.2f} °C".format(temperature))

.. autoclass:: bme680.Bme680

       print("Humidity:       {:10.2f} % r.h.".format(humidity))

   :members:

       print("Pressure:       {:10.2f} hPa".format(pressure))

       print("Gas Resistance: {:10.2f} Ω".format(resistance))





       utime.sleep(1)

Deprecated Interface

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

The following functions should no longer be used directly.  The only exist for

compatibility as they were the old BME680 interface in previous firmware

versions.





.. py:function:: init()

.. py:function:: init()
@@ -29,6 +88,8 @@ 
   :py:func:`bme680.init`.

   :py:func:`bme680.init`.





   .. versionadded:: 1.4

   .. versionadded:: 1.4

   .. deprecated:: 1.10

      Use the :py:class:`bme680.Bme680` class instead.





.. py:function:: get_data()

.. py:function:: get_data()
@@ -38,9 +99,13 @@ 
      ``pressure`` (hPa) and ``gas resistance`` (Ohm).

      ``pressure`` (hPa) and ``gas resistance`` (Ohm).





   .. versionadded:: 1.4

   .. versionadded:: 1.4

   .. deprecated:: 1.10

      Use the :py:class:`bme680.Bme680` class instead.





.. py:function:: deinit()

.. py:function:: deinit()





   Deinitialize the sensor.

   Deinitialize the sensor.





   .. versionadded:: 1.4

   .. versionadded:: 1.4

   .. deprecated:: 1.10

      Use the :py:class:`bme680.Bme680` class instead.

Documentation/pycardium/color.rst

+461 −0
Original line number Original line Diff line number Diff line
@@ -14,23 +14,65 @@ The color module also contains a few constanst for commonly used colors: 
Camp Colors

Camp Colors

~~~~~~~~~~~

~~~~~~~~~~~

.. py:data:: CHAOSBLUE

.. py:data:: CHAOSBLUE



   .. color-example:: #0076BA



.. py:data:: CHAOSBLUE_DARK

.. py:data:: CHAOSBLUE_DARK



   .. color-example:: #005383



.. py:data:: COMMYELLOW

.. py:data:: COMMYELLOW



   .. color-example:: #FFC600



.. py:data:: COMMYELLOW_DARK

.. py:data:: COMMYELLOW_DARK



   .. color-example:: #D39A00



.. py:data:: CAMPGREEN

.. py:data:: CAMPGREEN



   .. color-example:: #99BA00



.. py:data:: CAMPGREEN_DARK

.. py:data:: CAMPGREEN_DARK





   .. color-example:: #6F8700





General

General

~~~~~~~

~~~~~~~

.. py:data:: BLACK

.. py:data:: BLACK



   .. color-example:: #000



.. py:data:: WHITE

.. py:data:: WHITE



   .. color-example:: #fff



.. py:data:: RED

.. py:data:: RED



   .. color-example:: #f00



.. py:data:: GREEN

.. py:data:: GREEN



   .. color-example:: #0f0



.. py:data:: YELLOW

.. py:data:: YELLOW



   .. color-example:: #ff0



.. py:data:: BLUE

.. py:data:: BLUE



   .. color-example:: #00f



.. py:data:: MAGENTA

.. py:data:: MAGENTA



   .. color-example:: #f0f



.. py:data:: CYAN

.. py:data:: CYAN





   .. color-example:: #0ff





.. py:module:: htmlcolor

.. py:module:: htmlcolor





``htmlcolor`` - Color Constants

``htmlcolor`` - Color Constants
@@ -39,142 +81,561 @@ The ``htmlcolor`` module contains even more color constants. Note 
that loading the ``htmlcolor`` module will require ~12K of RAM.

that loading the ``htmlcolor`` module will require ~12K of RAM.





.. py:data:: ALICEBLUE

.. py:data:: ALICEBLUE



   .. color-example:: aliceblue



.. py:data:: ANTIQUEWHITE

.. py:data:: ANTIQUEWHITE



   .. color-example:: antiquewhite



.. py:data:: AQUA

.. py:data:: AQUA



   .. color-example:: aqua



.. py:data:: AQUAMARINE

.. py:data:: AQUAMARINE



   .. color-example:: aquamarine



.. py:data:: AZURE

.. py:data:: AZURE



   .. color-example:: azure



.. py:data:: BEIGE

.. py:data:: BEIGE



   .. color-example:: beige



.. py:data:: BISQUE

.. py:data:: BISQUE



   .. color-example:: bisque



.. py:data:: BLACK

.. py:data:: BLACK



   .. color-example:: black



.. py:data:: BLANCHEDALMOND

.. py:data:: BLANCHEDALMOND



   .. color-example:: blanchedalmond



.. py:data:: BLUE

.. py:data:: BLUE



   .. color-example:: blue



.. py:data:: BLUEVIOLET

.. py:data:: BLUEVIOLET



   .. color-example:: blueviolet



.. py:data:: BROWN

.. py:data:: BROWN



   .. color-example:: brown



.. py:data:: BURLYWOOD

.. py:data:: BURLYWOOD



   .. color-example:: burlywood



.. py:data:: CADETBLUE

.. py:data:: CADETBLUE



   .. color-example:: cadetblue



.. py:data:: CHARTREUSE

.. py:data:: CHARTREUSE



   .. color-example:: chartreuse



.. py:data:: CHOCOLATE

.. py:data:: CHOCOLATE



   .. color-example:: chocolate



.. py:data:: CORAL

.. py:data:: CORAL



   .. color-example:: coral



.. py:data:: CORNFLOWERBLUE

.. py:data:: CORNFLOWERBLUE



   .. color-example:: cornflowerblue



.. py:data:: CORNSILK

.. py:data:: CORNSILK



   .. color-example:: cornsilk



.. py:data:: CRIMSON

.. py:data:: CRIMSON



   .. color-example:: crimson



.. py:data:: CYAN

.. py:data:: CYAN



   .. color-example:: cyan



.. py:data:: DARKBLUE

.. py:data:: DARKBLUE



   .. color-example:: darkblue



.. py:data:: DARKCYAN

.. py:data:: DARKCYAN



   .. color-example:: darkcyan



.. py:data:: DARKGOLDENROD

.. py:data:: DARKGOLDENROD



   .. color-example:: darkgoldenrod



.. py:data:: DARKGRAY

.. py:data:: DARKGRAY



   .. color-example:: darkgray



.. py:data:: DARKGREEN

.. py:data:: DARKGREEN



   .. color-example:: darkgreen



.. py:data:: DARKKHAKI

.. py:data:: DARKKHAKI



   .. color-example:: darkkhaki



.. py:data:: DARKMAGENTA

.. py:data:: DARKMAGENTA



   .. color-example:: darkmagenta



.. py:data:: DARKOLIVEGREEN

.. py:data:: DARKOLIVEGREEN



   .. color-example:: darkolivegreen



.. py:data:: DARKORANGE

.. py:data:: DARKORANGE



   .. color-example:: darkorange



.. py:data:: DARKORCHID

.. py:data:: DARKORCHID



   .. color-example:: darkorchid



.. py:data:: DARKRED

.. py:data:: DARKRED



   .. color-example:: darkred



.. py:data:: DARKSALMON

.. py:data:: DARKSALMON



   .. color-example:: darksalmon



.. py:data:: DARKSEAGREEN

.. py:data:: DARKSEAGREEN



   .. color-example:: darkseagreen



.. py:data:: DARKSLATEBLUE

.. py:data:: DARKSLATEBLUE



   .. color-example:: darkslateblue



.. py:data:: DARKSLATEGRAY

.. py:data:: DARKSLATEGRAY



   .. color-example:: darkslategray



.. py:data:: DARKTURQUOISE

.. py:data:: DARKTURQUOISE



   .. color-example:: darkturquoise



.. py:data:: DARKVIOLET

.. py:data:: DARKVIOLET



   .. color-example:: darkviolet



.. py:data:: DEEPPINK

.. py:data:: DEEPPINK



   .. color-example:: deeppink



.. py:data:: DEEPSKYBLUE

.. py:data:: DEEPSKYBLUE



   .. color-example:: deepskyblue



.. py:data:: DIMGRAY

.. py:data:: DIMGRAY



   .. color-example:: dimgray



.. py:data:: DODGERBLUE

.. py:data:: DODGERBLUE



   .. color-example:: dodgerblue



.. py:data:: FIREBRICK

.. py:data:: FIREBRICK



   .. color-example:: firebrick



.. py:data:: FLORALWHITE

.. py:data:: FLORALWHITE



   .. color-example:: floralwhite



.. py:data:: FORESTGREEN

.. py:data:: FORESTGREEN



   .. color-example:: forestgreen



.. py:data:: FUCHSIA

.. py:data:: FUCHSIA



   .. color-example:: fuchsia



.. py:data:: GAINSBORO

.. py:data:: GAINSBORO



   .. color-example:: gainsboro



.. py:data:: GHOSTWHITE

.. py:data:: GHOSTWHITE



   .. color-example:: ghostwhite



.. py:data:: GOLD

.. py:data:: GOLD



   .. color-example:: gold



.. py:data:: GOLDENROD

.. py:data:: GOLDENROD



   .. color-example:: goldenrod



.. py:data:: GRAY

.. py:data:: GRAY



   .. color-example:: gray



.. py:data:: GREEN

.. py:data:: GREEN



   .. color-example:: green



.. py:data:: GREENYELLOW

.. py:data:: GREENYELLOW



   .. color-example:: greenyellow



.. py:data:: HONEYDEW

.. py:data:: HONEYDEW



   .. color-example:: honeydew



.. py:data:: HOTPINK

.. py:data:: HOTPINK



   .. color-example:: hotpink



.. py:data:: INDIANRED

.. py:data:: INDIANRED



   .. color-example:: indianred



.. py:data:: INDIGO

.. py:data:: INDIGO



   .. color-example:: indigo



.. py:data:: IVORY

.. py:data:: IVORY



   .. color-example:: ivory



.. py:data:: KHAKI

.. py:data:: KHAKI



   .. color-example:: khaki



.. py:data:: LAVENDER

.. py:data:: LAVENDER



   .. color-example:: lavender



.. py:data:: LAVENDERBLUSH

.. py:data:: LAVENDERBLUSH



   .. color-example:: lavenderblush



.. py:data:: LAWNGREEN

.. py:data:: LAWNGREEN



   .. color-example:: lawngreen



.. py:data:: LEMONCHIFFON

.. py:data:: LEMONCHIFFON



   .. color-example:: lemonchiffon



.. py:data:: LIGHTBLUE

.. py:data:: LIGHTBLUE



   .. color-example:: lightblue



.. py:data:: LIGHTCORAL

.. py:data:: LIGHTCORAL



   .. color-example:: lightcoral



.. py:data:: LIGHTCYAN

.. py:data:: LIGHTCYAN



   .. color-example:: lightcyan



.. py:data:: LIGHTGOLDENRODYELLOW

.. py:data:: LIGHTGOLDENRODYELLOW



   .. color-example:: lightgoldenrodyellow



.. py:data:: LIGHTGRAY

.. py:data:: LIGHTGRAY



   .. color-example:: lightgray



.. py:data:: LIGHTGREEN

.. py:data:: LIGHTGREEN



   .. color-example:: lightgreen



.. py:data:: LIGHTPINK

.. py:data:: LIGHTPINK



   .. color-example:: lightpink



.. py:data:: LIGHTSALMON

.. py:data:: LIGHTSALMON



   .. color-example:: lightsalmon



.. py:data:: LIGHTSEAGREEN

.. py:data:: LIGHTSEAGREEN



   .. color-example:: lightseagreen



.. py:data:: LIGHTSKYBLUE

.. py:data:: LIGHTSKYBLUE



   .. color-example:: lightskyblue



.. py:data:: LIGHTSLATEGRAY

.. py:data:: LIGHTSLATEGRAY



   .. color-example:: lightslategray



.. py:data:: LIGHTSTEELBLUE

.. py:data:: LIGHTSTEELBLUE



   .. color-example:: lightsteelblue



.. py:data:: LIGHTYELLOW

.. py:data:: LIGHTYELLOW



   .. color-example:: lightyellow



.. py:data:: LIME

.. py:data:: LIME



   .. color-example:: lime



.. py:data:: LIMEGREEN

.. py:data:: LIMEGREEN



   .. color-example:: limegreen



.. py:data:: LINEN

.. py:data:: LINEN



   .. color-example:: linen



.. py:data:: MAGENTA

.. py:data:: MAGENTA



   .. color-example:: magenta



.. py:data:: MAROON

.. py:data:: MAROON



   .. color-example:: maroon



.. py:data:: MEDIUMAQUAMARINE

.. py:data:: MEDIUMAQUAMARINE



   .. color-example:: mediumaquamarine



.. py:data:: MEDIUMBLUE

.. py:data:: MEDIUMBLUE



   .. color-example:: mediumblue



.. py:data:: MEDIUMORCHID

.. py:data:: MEDIUMORCHID



   .. color-example:: mediumorchid



.. py:data:: MEDIUMPURPLE

.. py:data:: MEDIUMPURPLE



   .. color-example:: mediumpurple



.. py:data:: MEDIUMSEAGREEN

.. py:data:: MEDIUMSEAGREEN



   .. color-example:: mediumseagreen



.. py:data:: MEDIUMSLATEBLUE

.. py:data:: MEDIUMSLATEBLUE



   .. color-example:: mediumslateblue



.. py:data:: MEDIUMSPRINGGREEN

.. py:data:: MEDIUMSPRINGGREEN



   .. color-example:: mediumspringgreen



.. py:data:: MEDIUMTURQUOISE

.. py:data:: MEDIUMTURQUOISE



   .. color-example:: mediumturquoise



.. py:data:: MEDIUMVIOLETRED

.. py:data:: MEDIUMVIOLETRED



   .. color-example:: mediumvioletred



.. py:data:: MIDNIGHTBLUE

.. py:data:: MIDNIGHTBLUE



   .. color-example:: midnightblue



.. py:data:: MINTCREAM

.. py:data:: MINTCREAM



   .. color-example:: mintcream



.. py:data:: MISTYROSE

.. py:data:: MISTYROSE



   .. color-example:: mistyrose



.. py:data:: MOCCASIN

.. py:data:: MOCCASIN



   .. color-example:: moccasin



.. py:data:: NAVAJOWHITE

.. py:data:: NAVAJOWHITE



   .. color-example:: navajowhite



.. py:data:: NAVY

.. py:data:: NAVY



   .. color-example:: navy



.. py:data:: OLDLACE

.. py:data:: OLDLACE



   .. color-example:: oldlace



.. py:data:: OLIVE

.. py:data:: OLIVE



   .. color-example:: olive



.. py:data:: OLIVEDRAB

.. py:data:: OLIVEDRAB



   .. color-example:: olivedrab



.. py:data:: ORANGE

.. py:data:: ORANGE



   .. color-example:: orange



.. py:data:: ORANGERED

.. py:data:: ORANGERED



   .. color-example:: orangered



.. py:data:: ORCHID

.. py:data:: ORCHID



   .. color-example:: orchid



.. py:data:: PALEGOLDENROD

.. py:data:: PALEGOLDENROD



   .. color-example:: palegoldenrod



.. py:data:: PALEGREEN

.. py:data:: PALEGREEN



   .. color-example:: palegreen



.. py:data:: PALETURQUOISE

.. py:data:: PALETURQUOISE



   .. color-example:: paleturquoise



.. py:data:: PALEVIOLETRED

.. py:data:: PALEVIOLETRED



   .. color-example:: palevioletred



.. py:data:: PAPAYAWHIP

.. py:data:: PAPAYAWHIP



   .. color-example:: papayawhip



.. py:data:: PEACHPUFF

.. py:data:: PEACHPUFF



   .. color-example:: peachpuff



.. py:data:: PERU

.. py:data:: PERU



   .. color-example:: peru



.. py:data:: PINK

.. py:data:: PINK



   .. color-example:: pink



.. py:data:: PLUM

.. py:data:: PLUM



   .. color-example:: plum



.. py:data:: POWDERBLUE

.. py:data:: POWDERBLUE



   .. color-example:: powderblue



.. py:data:: PURPLE

.. py:data:: PURPLE



   .. color-example:: purple



.. py:data:: RED

.. py:data:: RED



   .. color-example:: red



.. py:data:: ROSYBROWN

.. py:data:: ROSYBROWN



   .. color-example:: rosybrown



.. py:data:: ROYALBLUE

.. py:data:: ROYALBLUE



   .. color-example:: royalblue



.. py:data:: SADDLEBROWN

.. py:data:: SADDLEBROWN



   .. color-example:: saddlebrown



.. py:data:: SALMON

.. py:data:: SALMON



   .. color-example:: salmon



.. py:data:: SANDYBROWN

.. py:data:: SANDYBROWN



   .. color-example:: sandybrown



.. py:data:: SEAGREEN

.. py:data:: SEAGREEN



   .. color-example:: seagreen



.. py:data:: SEASHELL

.. py:data:: SEASHELL



   .. color-example:: seashell



.. py:data:: SIENNA

.. py:data:: SIENNA



   .. color-example:: sienna



.. py:data:: SILVER

.. py:data:: SILVER



   .. color-example:: silver



.. py:data:: SKYBLUE

.. py:data:: SKYBLUE



   .. color-example:: skyblue



.. py:data:: SLATEBLUE

.. py:data:: SLATEBLUE



   .. color-example:: slateblue



.. py:data:: SLATEGRAY

.. py:data:: SLATEGRAY



   .. color-example:: slategray



.. py:data:: SNOW

.. py:data:: SNOW



   .. color-example:: snow



.. py:data:: SPRINGGREEN

.. py:data:: SPRINGGREEN



   .. color-example:: springgreen



.. py:data:: STEELBLUE

.. py:data:: STEELBLUE



   .. color-example:: steelblue



.. py:data:: TAN

.. py:data:: TAN



   .. color-example:: tan



.. py:data:: TEAL

.. py:data:: TEAL



   .. color-example:: teal



.. py:data:: THISTLE

.. py:data:: THISTLE



   .. color-example:: thistle



.. py:data:: TOMATO

.. py:data:: TOMATO



   .. color-example:: tomato



.. py:data:: TURQUOISE

.. py:data:: TURQUOISE



   .. color-example:: turquoise



.. py:data:: VIOLET

.. py:data:: VIOLET



   .. color-example:: violet



.. py:data:: WHEAT

.. py:data:: WHEAT



   .. color-example:: wheat



.. py:data:: WHITE

.. py:data:: WHITE



   .. color-example:: white



.. py:data:: WHITESMOKE

.. py:data:: WHITESMOKE



   .. color-example:: whitesmoke



.. py:data:: YELLOW

.. py:data:: YELLOW



   .. color-example:: yellow



.. py:data:: YELLOWGREEN

.. py:data:: YELLOWGREEN



   .. color-example:: yellowgreen

Documentation/pycardium/config.rst

0 → 100644
+9 −0
Original line number Original line Diff line number Diff line 
``config`` - Configuration

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

The ``config`` module provides functions to interact with card10's

configuration file (:ref:`card10_cfg`).



.. automodule:: config

   :members:

Documentation/pycardium/display.rst

+16 −0
Original line number Original line Diff line number Diff line 
``display`` - Display

``display`` - Display

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

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





The display module let's you draw on the card10's display.

Pixels are addressed from top left to bottom right with a range of x: 0 to 159 and y: 0 to 79.



.. code-block:: text



   0,0

      +---------------------+

      |                     |

      |                     |

      |                     |

      |                     |

      +---------------------+

                           159,79



Drawing operations are clipped, pixels outside of the screen will be ignored.



.. automodule:: display

.. automodule:: display

   :members:
 
   :members:

Documentation/pycardium/gpio.rst

+13 −1
Original line number Original line Diff line number Diff line
@@ -25,7 +25,10 @@ output in your scripts. 
   :param int pin: ID of the pin to be configured.

   :param int pin: ID of the pin to be configured.

   :param int mode: An integer with the bits for the wanted mode set. Create your

   :param int mode: An integer with the bits for the wanted mode set. Create your

      integer by ORing :py:data:`gpio.mode.OUTPUT`, :py:data:`gpio.mode.INPUT`,

      integer by ORing :py:data:`gpio.mode.OUTPUT`, :py:data:`gpio.mode.INPUT`,

      :py:data:`gpio.mode.PULL_UP`, :py:data:`gpio.mode.PULL_DOWN`.

      :py:data:`gpio.mode.ADC`, :py:data:`gpio.mode.PULL_UP`,

      :py:data:`gpio.mode.PULL_DOWN`.



   .. note:: On WRISTBAND_3, there is no ADC functionality available





.. py:function:: get_mode(pin)

.. py:function:: get_mode(pin)
@@ -47,6 +50,9 @@ output in your scripts. 




   :param int pin: ID of the pin of to get the mode of.

   :param int pin: ID of the pin of to get the mode of.

   :returns: Current value of the GPIO pin.

   :returns: Current value of the GPIO pin.

      If the pin is configured as ADC, the value returned

      will be between 0 and 1000, representing voltages from

      0V to 3.3V (:py:data:`gpio.ADC` is only available in 1.9+).





.. py:data:: WRISTBAND_1

.. py:data:: WRISTBAND_1
@@ -75,6 +81,12 @@ output in your scripts. 




   Configures a pin as input.

   Configures a pin as input.





.. py:data:: ADC



   Configure pin as ADC input.



   .. versionadded: 1.9



.. py:data:: PULL_UP

.. py:data:: PULL_UP





   Enables the internal pull-up resistor of a pin.

   Enables the internal pull-up resistor of a pin.

Documentation/pycardium/light-sensor.rst

+10 −0
Original line number Original line Diff line number Diff line
@@ -25,3 +25,13 @@ be fairly stable. 
.. py:function:: stop()

.. py:function:: stop()





   Stop the ADC.

   Stop the ADC.



.. py:function:: read()



   Direct readout of the light-sensor.



   Use this function for low latency readout.  The time between polls can have

   an effect on the values measures.  If you do not need low latency, prefer

   :py:func:`light_sensor.get_reading`.



   .. versionadded:: 1.8

Documentation/pycardium/max86150.rst

0 → 100644
+5 −0
Original line number Original line Diff line number Diff line 
``max86150`` - MAX86150

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



.. automodule:: max86150

   :members:

Documentation/pycardium/os.rst

+63 −6
Original line number Original line Diff line number Diff line
@@ -8,12 +8,6 @@ functions found in CPythons ``os`` module. 
CPython-Like

CPython-Like

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

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





.. py:function:: unlink(path)



   Unlink (remove) a file.



   :param str path: The file to remove.



.. py:function:: listdir(dir)

.. py:function:: listdir(dir)





   List contents of a directory.

   List contents of a directory.
@@ -22,6 +16,28 @@ CPython-Like 
   :returns: A list of entities (files or subdirectories) in the directory

   :returns: A list of entities (files or subdirectories) in the directory

      ``dir``.

      ``dir``.





.. py:function:: mkdir(path)



   Create a directory named *path*.



   :param str path: Path to the directory to create.  Only the last component

      of this path will be created.



.. py:function:: rename(src, dst)



   Rename the file or directory *src* to *dst*. If *dst* exists, the operation

   will fail.



   :param str src: Path to source file to rename.

   :param str dst: Destination path to rename to.  Must not exist before

      calling :py:func:`os.rename`.



.. py:function:: unlink(path)



   Unlink (remove) a file.



   :param str path: The file to remove.



.. py:function:: urandom(n)

.. py:function:: urandom(n)





   Return ``n`` random bytes.

   Return ``n`` random bytes.
@@ -72,3 +88,44 @@ Card10-Specific 




      Please only call this function if absolutely necessary.  In most cases

      Please only call this function if absolutely necessary.  In most cases

      you'll want to just :py:func:`os.exit` instead.

      you'll want to just :py:func:`os.exit` instead.



.. py:function:: usbconfig(config_type)



   Change active USB configuration. By default, card10 boots with

   :py:data:`os.USB_SERIAL` active.



   This will deactivate the currently active USB configuration. This means

   that, if you activate :py:data:`os.USB_FLASH` while :py:data:`os.USB_SERIAL`

   was active, the USB serial will be disconnected.



   :param config_type: Selects which config to activate. Possible

      values are :py:data:`os.USB_SERIAL`, :py:data:`os.USB_FLASH`,

      or :py:data:`os.USB_NONE`.



   .. versionadded:: 1.11



.. py:data:: USB_NONE



   No USB device active.



.. py:data:: USB_SERIAL



   CDC-ACM serial device active.



.. py:data:: USB_FLASH



   Mass-Storage device active.



.. py:function:: fs_is_attached()



   Check whether the filesystem is currently attached to card10 (or whether a connected

   USB host is currently holding control over it and possibly writing to it).



   :returns:



      - ``True`` if the filesystem is attached to card10 and an app can read and

        write files.

      - ``False`` if the filesystem is not available to card10 because a USB

        host is currently controlling it.



   .. versionadded: 1.18

Documentation/pycardium/overview.rst

+48 −3
Original line number Original line Diff line number Diff line
@@ -36,8 +36,53 @@ Baud-rate is 115200. Some options are: 
* **screen**: ``sudo screen /dev/ttyACM0 115200``

* **screen**: ``sudo screen /dev/ttyACM0 115200``

* **picocom**: ``sudo picocom -b 115200 /dev/ttyACM0``

* **picocom**: ``sudo picocom -b 115200 /dev/ttyACM0``





After connecting, reboot card10 and you should see the MicroPython REPL pop up.

After connecting, reboot reset the card10 via the power button (left upper

corner) and you should see the output of **menu.py** script (it's located in

*preload/menu.py*). You can press CTRL-C to interrupt the script and jump into

the MicroPython prompt.





.. todo::

To switch on the blue fairy dust you must import the led python module::





   Getting Started Guide for people interested in writing Python code.
 
   import leds



and power it on::



   leds.set_rocket(0, 31)



.. note::



   If you're using iOS/Mac then you can connect to your serial console using:



   .. code-block:: shell-session



      screen /dev/tty.usbmodem* 115200



   You can now see in your console what buttons you have pressed and your

   console outputs/logs.  With ``CTRL+C`` you exit the console.



REPL modes

^^^^^^^^^^

MicroPython supports a different REPL modes over the serial console. The modes

can be changed on every new line.



Normal mode

"""""""""""

This is the mode you will first see. You can switch to it by pressing CTRL-B.

If you are in a other mode you can return to this mode by pressing CTRL-B too.



Paste mode

""""""""""

You can enter the paste mode by pressing CTRL-E and you can simple copy 'n'

paste your source code into the console and it will be interpreted and executed

line by line. Every new line will be reply by the prompt with **===**.



RAW mode

""""""""

The RAW mode to be intendend for the usage with tools. By pressing CTRL-A you

will enter the RAW REPL mode. The type in code will not printed. By pressing

CTRL-D the whole entered code will be evaluated and executed. The board will

reply with **OK** and print after that the output (print commands) of the code

or give you tracebacks if an error occured.



You can use **pycard10** (tools/pycard10.py) to execute python files from your

PC directly on the card10.

Documentation/pycardium/png.rst

0 → 100644
+7 −0
Original line number Original line Diff line number Diff line 
``png`` - PNG Decoder

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

The ``png`` module provides functions to decode PNG files into raw pixel data

which can be displayed using the card10's display or its LEDs.



.. automodule:: png

   :members:

Documentation/pycardium/simple_menu.rst

+2 −0
Original line number Original line Diff line number Diff line
@@ -25,4 +25,6 @@ displaying menus. You can use it like this: 
.. autoclass:: simple_menu.Menu

.. autoclass:: simple_menu.Menu

   :members:

   :members:





.. autodata:: simple_menu.TIMEOUT



.. autofunction:: simple_menu.button_events
 
.. autofunction:: simple_menu.button_events

Documentation/pycardium/stdlib.rst

+24 −7
Original line number Original line Diff line number Diff line 
MicroPython Standard Library

MicroPython Standard Library

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

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

Pycardium contains some modules from the MicroPython standard library.  These

Pycardium contains some modules from the MicroPython standard library.

are:



Some modules below use a standard Python name, but prefixed with “u”,

e.g. ujson instead of json. This is to signify that such a module is a

micro-library, i.e. implements only a subset of CPython module

functionality. Please refer to the official `MicroPython docs`_ for an

explanation why.



All u-name modules can also be imported using their non-u-name. E.g.

``import utime`` and import ``import time`` will both work.



.. _MicroPython docs: http://docs.micropython.org/en/latest/library/index.html#python-standard-libraries-and-micro-libraries



.. py:module:: framebuf



``framebuf``

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

Refer to the official `MicroPython docs for framebuf`_.



.. _MicroPython docs for framebuf: https://docs.micropython.org/en/latest/library/framebuf.html





.. py:module:: ubinascii

.. py:module:: ubinascii
@@ -201,6 +219,8 @@ Struct module. 
      UUID(bytes='\x12\x34\x56\x78' * 4)

      UUID(bytes='\x12\x34\x56\x78' * 4)

      UUID(int=0x12345678123456781234567812345678)

      UUID(int=0x12345678123456781234567812345678)





   .. versionadded:: 1.10



   .. py:attribute:: bytes

   .. py:attribute:: bytes





      UUID as ``bytes()`` object

      UUID as ``bytes()`` object
@@ -217,11 +237,8 @@ Struct module. 




      UUID version accordiung to RFC 4122

      UUID version accordiung to RFC 4122





.. py:function:: uuid4():

.. py:function:: uuid4()





   Generate a new UUID version 4 (random UUID).

   Generate a new UUID version 4 (random UUID).





   .. todo::

   .. versionadded:: 1.10
 


      This function is not yet usable because we don't have

      :py:func:`os.urandom` yet.

Documentation/pycardium/utime.rst

+64 −6
Original line number Original line Diff line number Diff line
@@ -8,6 +8,9 @@ CPython but wouldn't fit anywhere else in our implementation. Most 
prominently,  this is the :py:func:`utime.alarm` function for setting an RTC

prominently,  this is the :py:func:`utime.alarm` function for setting an RTC

alarm.

alarm.





Like all other u-name modules, ``utime`` can also imported using the standard

``import time`` statement.



.. |time| replace:: ``time``

.. |time| replace:: ``time``

.. _time: https://docs.python.org/3/library/time.html

.. _time: https://docs.python.org/3/library/time.html
@@ -33,6 +36,48 @@ alarm. 
   Return the current timestamp in milliseconds since 2000-01-01 00:00 in

   Return the current timestamp in milliseconds since 2000-01-01 00:00 in

   the local timezone.

   the local timezone.





.. py:function:: monotonic()



   Return a monotonically increasing timestamp.



   .. versionadded:: 1.11



.. py:function:: monotonic_ms()



   Return a monotonically increasing timestamp in milliseconds.



   .. versionadded:: 1.11



.. py:function:: ticks_ms()



   Return processor ticks (converted to milliseconds) since Pycardium startup.



   This function should be the preferred method for timing and profiling

   because it does not need an API call and thus is very fast.



   .. versionadded:: 1.13



.. py:function:: ticks_us()



   Return processor ticks (converted to microseconds) since Pycardium startup.



   This function should be the preferred method for timing and profiling

   because it does not need an API call and thus is very fast.



   .. versionadded:: 1.13



.. py:function:: unix_time()



   Return the current unix time as seconds since the epoch.



   .. versionadded:: 1.12



.. py:function:: unix_time_ms()



   Return the current unix time as milliseconds since the epoch.



   .. versionadded:: 1.12



.. py:function:: set_time(secs)

.. py:function:: set_time(secs)





   Sets the time to ``secs`` seconds since 2000-01-01 00:00 in the local

   Sets the time to ``secs`` seconds since 2000-01-01 00:00 in the local
@@ -42,6 +87,13 @@ alarm. 
      :py:func:`utime.set_time` previously applied a wrong timezone offset,

      :py:func:`utime.set_time` previously applied a wrong timezone offset,

      thus leading to wrong results.

      thus leading to wrong results.





.. py:function:: set_time_ms(msecs)



   Set the time to ``msecs`` seconds since 2000-01-01 00:00 in the local

   timezone.



   .. versionadded:: 1.12



.. py:function:: set_unix_time(secs)

.. py:function:: set_unix_time(secs)





   Sets the time to ``secs`` seconds since 1970-01-01 00:00 UTC.

   Sets the time to ``secs`` seconds since 1970-01-01 00:00 UTC.
@@ -49,6 +101,12 @@ alarm. 
   by running ``date +%s`` in a command line or ``int(time.time())``

   by running ``date +%s`` in a command line or ``int(time.time())``

   in Python.

   in Python.





.. py:function:: set_unix_time_ms(msecs)



   Set the time to ``msecs`` milliseconds since the unix epoch.



   .. versionadded:: 1.12



.. py:function:: localtime([secs])

.. py:function:: localtime([secs])





   Return the current time as a timestruct tuple.  If ``secs`` is given, return

   Return the current time as a timestruct tuple.  If ``secs`` is given, return
@@ -80,13 +138,13 @@ alarm. 




   .. code-block:: python

   .. code-block:: python





      import utime

      import time





      def minute_timer(x):

      def minute_timer(x):

         current = utime.time()

         current = time.time()

         print("Current: " + str(current))

         print("Current: " + str(current))

         alarm = (current // 60 + 1) * 60

         alarm = (current // 60 + 1) * 60

         utime.alarm(alarm, minute_timer)

         time.alarm(alarm, minute_timer)





      minute_timer(None)

      minute_timer(None)
@@ -95,13 +153,13 @@ alarm. 




   .. code-block:: python

   .. code-block:: python





      import interrupt, utime

      import interrupt, time





      def 5_second_timer(x):

      def 5_second_timer(x):

         current = utime.time()

         current = time.time()

         print("Current: " + str(current))

         print("Current: " + str(current))

         alarm = (current // 10) * 10 + 5

         alarm = (current // 10) * 10 + 5

         utime.alarm(alarm)

         time.alarm(alarm)





      # This time, we need to register and enable the callback manually

      # This time, we need to register and enable the callback manually

      interrupt.set_callback(interrupt.RTC_ALARM, 5_second_timer)

      interrupt.set_callback(interrupt.RTC_ALARM, 5_second_timer)

Documentation/pycardium/ws2812.rst

0 → 100644
+35 −0
Original line number Original line Diff line number Diff line 
.. py:module:: ws2812



``ws2812`` - Neopixel LEDs

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

The ``ws2812`` module controls LEDs of the WS2812 type. Just as the ``leds`` module, it exposes a function :py:func:`ws2812.set_all`, which works a similar fashion.



.. versionadded:: 1.10



.. py:function:: set_all(pin, colors)



   Set multiple of the LEDs to RGB values.



   Filling starts at the LED connected to the specified gpio pin.



   :param int pin: ID of the pin to use for sending the data.

   :param colors: List of RGB triplets.



   **Example**



   .. code-block:: python



      import color, time, ws2812, gpio



      gpio.set_mode(gpio.WRISTBAND_2, gpio.mode.OUTPUT)



      i = 0

      while True:

          col1 = color.from_hsv(i % 360, 1.0, 0.1)

          col2 = color.from_hsv((i + 20) % 360, 1.0, 0.1)

          col3 = color.from_hsv((i + 40) % 360, 1.0, 0.1)

          ws2812.set_all(gpio.WRISTBAND_2, [col1, col2, col3])

          i += 1

          time.sleep_ms(10)



   .. versionadded:: 1.10

Documentation/static/bhi160-coordinates.png

0 → 100644
+324 KiB

323.55 KiB

Documentation/usb-file-transfer.rst

0 → 100644
+40 −0
Original line number Original line Diff line number Diff line 
.. _usb_file_transfer:



USB File Transfer

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



The card10 badge bootloader offers a USB Mass Storage mode to access its 8MB external flash.



This flash contains a FAT32 filesystem and files on it will be visible to software running on the badge.



Getting to the USB mode

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



To get to the USB mode, you will need to boot the badge while keeping the bottom-right button pressed.



.. image:: static/bootloader-buttons.png



1. If the badge is on, hold the top-left (power) button until the sleep screen appears, then release.

2. Start holding the bottom-right button.

3. Quickly press and release the top-left (power) button to turn the badge on.

4. Your badge should now be in file transfer mode, and you can then release the bottom-right button.



If you succesfully got into USB File Transfer mode, the screen will display its version and notify about the USB mode by displaying ``USB activated. Ready.``. If you connect the badge via USB to your computer, it should now detect 8MB of flash storage that you can mount in the same way as a pendrive.



This pendrive can contain multiple files with different functions, some of them outlined here:



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

File name      Function

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

``card10.bin`` Firmware update file for the badge. If this file is present, the bootloader will perform an internal update to boot from this firmware file, then it will be deleted.

``main.py``    This file contains the default `application` to be run on power on.

``menu.py``    This file contains the default `menu` to be run when the power button is short-pressed.

``*.py``       These are application files written in (Micro)Python that can be run from the menu.

``*.elf``      These are :ref:`l0dables` that can be run from the menu.

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



Updating files and rebooting

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



No matter which file you are writing, the bootloader will display a red ``Writing`` status message while write operations are pending. Please wait until it displays ``Ready`` again before resetting the badge by pressing the power button again.

bootloader/bootloader-display.c

+9 −23
Original line number Original line Diff line number Diff line
@@ -6,31 +6,17 @@ 
#include "gfx.h"

#include "gfx.h"

#include "display.h"

#include "display.h"





/*

 * "Decompress" splash-screen image.  The algorithm works as follows:

 *

 * Each byte encodes up to 127 pixels in either white or black.  The most

 * significant bit determines the color, the remaining 7 bits determine the

 * amount.

 */

static void bootloader_display_splash(void)

static void bootloader_display_splash(void)

{

{

	int idx = 0;

	gfx_copy_region_rle_mono(



		&display_screen,

	Color white = gfx_color(&display_screen, WHITE);

		0,

	Color black = gfx_color(&display_screen, BLACK);

		0,

	for (int i = 0; i < sizeof(splash); i++) {

		160,

		Color color    = (splash[i] & 0x80) ? white : black;

		80,

		uint8_t length = splash[i] & 0x7f;

		sizeof(splash),



		(const void *)(splash)

		for (int j = 0; j < length; j++) {

	);

			uint16_t x = idx % 160;

			uint16_t y = idx / 160;

			gfx_setpixel(&display_screen, x, y, color);

			idx++;

		}

	}



	gfx_update(&display_screen);

	gfx_update(&display_screen);

}

}

bootloader/build_multi_image.sh

+7 −3
Original line number Original line Diff line number Diff line
@@ -6,8 +6,12 @@ BIN1="$2" 
BIN2="$3"

BIN2="$3"

BINOUT="$4"

BINOUT="$4"





dd if=/dev/zero ibs=1k count=448 2>/dev/null | LANG=C LC_CTYPE=C LC_ALL=C LC_COLLATE=C tr "\000" "\377" > "$BINOUT"

if [ "$(stat -c "%s" "${BIN1}")" -gt 589824 ]; then

dd if="$BIN1" of="$BINOUT" conv=notrunc 2>/dev/null

    echo "$0: ${BIN1} is too big to fit!" >&2

dd if="$BIN2" >> "$BINOUT" 2>/dev/null

    exit 1

fi



objcopy -I binary -O binary --pad-to=589824 --gap-fill=255 "${BIN1}" "$BINOUT"

cat "$BIN2" >>"$BINOUT"





"$PYTHON" "$(dirname "$0")/crc_patch.py" "$BINOUT"
 
"$PYTHON" "$(dirname "$0")/crc_patch.py" "$BINOUT"

bootloader/crc_patch.py

+26 −5
Original line number Original line Diff line number Diff line 
#!/usr/bin/env python3

#!/usr/bin/env python3

import sys

import sys

import warnings



warnings.simplefilter("ignore")



try:

    import crc16

    import crc16





    crcfun = crc16.crc16xmodem

except ImportError:

    try:

        import crcmod



        crcfun = crcmod.predefined.mkCrcFun("xmodem")

    except ImportError:

        try:

            import crcelk



            crcfun = crcelk.CRC_XMODEM.calc_bytes

        except ImportError:

            raise Exception(

                "Could not find a CRC implementation. Tried: crc16, crcmod, crcelk."

            )







def main():

def main():

    data = open(sys.argv[1], 'rb').read()

    data = open(sys.argv[1], "rb").read()

    crc = crc16.crc16xmodem(data)

    crc = crcfun(data)

    # print(crc)

    # print(crc)





    padded = data + bytes([crc >> 8, crc & 0xFF])

    padded = data + bytes([crc >> 8, crc & 0xFF])





    crc = crc16.crc16xmodem(padded)

    crc = crcfun(padded)

    # print(crc)

    # print(crc)





    open(sys.argv[1], 'wb').write(padded)

    open(sys.argv[1], "wb").write(padded)









if __name__ == "__main__":

if __name__ == "__main__":

bootstrap.sh

+3 −1
Original line number Original line Diff line number Diff line
@@ -4,7 +4,9 @@ set -xe 
cd "$(dirname "$0")"

cd "$(dirname "$0")"

test -d build/ && rm -r build/

test -d build/ && rm -r build/





git submodule update --init ./lib/micropython

# Get external libs (MicroPython, tiny-AES-c, SHA256)

git submodule deinit --all

git submodule update --init ./lib

meson --cross-file card10-cross.ini build/ "$@"

meson --cross-file card10-cross.ini build/ "$@"





set +x

set +x

card10-cross.ini

+1 −1
Original line number Original line Diff line number Diff line
@@ -6,7 +6,7 @@ strip = 'arm-none-eabi-strip' 
[properties]

[properties]

c_args      = ['-mthumb', '-mcpu=cortex-m4', '-mfloat-abi=softfp', '-mfpu=fpv4-sp-d16', '-Wa,-mimplicit-it=thumb', '-ffunction-sections', '-fdata-sections', '-fsingle-precision-constant', '-fno-isolate-erroneous-paths-dereference']

c_args      = ['-mthumb', '-mcpu=cortex-m4', '-mfloat-abi=softfp', '-mfpu=fpv4-sp-d16', '-Wa,-mimplicit-it=thumb', '-ffunction-sections', '-fdata-sections', '-fsingle-precision-constant', '-fno-isolate-erroneous-paths-dereference']





c_link_args = ['-mthumb', '-mcpu=cortex-m4', '-mfloat-abi=softfp', '-mfpu=fpv4-sp-d16', '-Wl,--start-group', '-lc', '-lnosys', '-Wl,--end-group', '--specs=nano.specs']

c_link_args = ['-mthumb', '-mcpu=cortex-m4', '-mfloat-abi=softfp', '-mfpu=fpv4-sp-d16', '-Wl,--start-group', '-lc', '-lnosys', '-Wl,--end-group', '--specs=nano.specs', '-Wl,-wrap,BbBleDrvRand']





target_defs = ['-DTARGET=32665', '-DTARGET_REV=0x4131', '-DBOARD_CARD10=1']

target_defs = ['-DTARGET=32665', '-DTARGET_REV=0x4131', '-DBOARD_CARD10=1']

default.nix

+1 −0
Original line number Original line Diff line number Diff line
@@ -18,6 +18,7 @@ in stdenv.mkDerivation rec { 
    bash

    bash

    crc16

    crc16

    gcc-arm-embedded

    gcc-arm-embedded

    git

    meson

    meson

    ninja

    ninja

    py

    py

demos/ble-ws2812-card10.py

0 → 100644
+35 −0
Original line number Original line Diff line number Diff line 
import ws2812, gpio, bluetooth, time, display

from micropython import const



_IRQ_GATTS_WRITE = const(3)



WS2812_SERVICE_UUID = \

    bluetooth.UUID("23238000-2342-2342-2342-234223422342")

SET_ALL = (

    bluetooth.UUID("23238001-2342-2342-2342-234223422342"),

    bluetooth.FLAG_WRITE

)

WS2812_SERVICE = (

    WS2812_SERVICE_UUID,

    (SET_ALL,)

)



def irq(event, data):

    if event == _IRQ_GATTS_WRITE:

        conn_handle, value_handle = data

        value = ble.gatts_read(value_handle)

        ws2812.set_all(gpio.WRISTBAND_3, [value] * 3)



if __name__ == "__main__":

    display.open().backlight(0)

    gpio.set_mode(gpio.WRISTBAND_3, gpio.mode.OUTPUT)



    ble = bluetooth.BLE()

    ble.active(True)

    ble.irq(irq)

    ble.gatts_register_services((WS2812_SERVICE,))



    print("Waiting for connection!")



    while True:

        time.sleep(1)

demos/ble-ws2812-host.py

0 → 100644
+19 −0
Original line number Original line Diff line number Diff line 
#!/usr/bin/env python3

import bluepy

import time

import colorsys





# Change this to the MAC of your card10

p = bluepy.btle.Peripheral("CA:4D:10:01:ff:64")

c = p.getCharacteristics(

    uuid='23238001-2342-2342-2342-234223422342')[0]



hue = 0

while 1:

    r,g,b = colorsys.hsv_to_rgb(hue, 1, 0.1)

    c.write(b"%c%c%c" %

        (int(r*255), int(g*255), int(b*255)), True)

    time.sleep(.1)

    hue += 0.1

docker/Dockerfile_fwbuild

0 → 100644
+10 −0
Original line number Original line Diff line number Diff line 
FROM ubuntu



RUN apt-get update && apt-get -y install gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi python3 python3-pip ninja-build git



RUN pip3 install meson crc16 pillow



VOLUME /firmware

WORKDIR /firmware



CMD ./bootstrap.sh && ninja -C build && chown -R --reference=/firmware build

docker/deploy-env/Dockerfile

+2 −2
Original line number Original line Diff line number Diff line 
FROM ubuntu:bionic

FROM ubuntu:focal





RUN set -e -x ;\

RUN set -e -x ;\

    export DEBIAN_FRONTEND=noninteractive ;\

    export DEBIAN_FRONTEND=noninteractive ;\
@@ -10,7 +10,7 @@ RUN set -e -x ;\ 
        llvm \

        llvm \

        python3-pip ;\

        python3-pip ;\

    pip3 install \

    pip3 install \

        clang \

        clang==10.0.1 \

        sphinx \

        sphinx \

        sphinx_rtd_theme ;\

        sphinx_rtd_theme ;\

    rm -rf /var/lib/apt/lists

    rm -rf /var/lib/apt/lists

epicardium/FreeRTOSConfig.h

+6 −4
Original line number Original line Diff line number Diff line 
#ifndef FREERTOS_CONFIG_H

#ifndef FREERTOS_CONFIG_H

#define FREERTOS_CONFIG_H

#define FREERTOS_CONFIG_H





#define  MXC_ASSERT_ENABLE

#include "mxc_assert.h"



#include "max32665.h"

#include "max32665.h"





#include <assert.h>



/* CMSIS keeps a global updated with current system clock in Hz */

/* CMSIS keeps a global updated with current system clock in Hz */

#define configCPU_CLOCK_HZ          ((unsigned long)96000000)

#define configCPU_CLOCK_HZ          ((unsigned long)96000000)
@@ -51,8 +50,11 @@ 




#define INCLUDE_vTaskSuspend        1

#define INCLUDE_vTaskSuspend        1

#define INCLUDE_vTaskDelay          1

#define INCLUDE_vTaskDelay          1

#define INCLUDE_vTaskDelete         1

#define INCLUDE_uxTaskGetStackHighWaterMark 1

#define INCLUDE_uxTaskGetStackHighWaterMark 1

#define INCLUDE_xTimerPendFunctionCall 1

#define INCLUDE_xTimerPendFunctionCall 1

#define INCLUDE_xSemaphoreGetMutexHolder 1



/* Allow static allocation of data structures */

/* Allow static allocation of data structures */

#define configSUPPORT_STATIC_ALLOCATION 1

#define configSUPPORT_STATIC_ALLOCATION 1
@@ -69,7 +71,7 @@ 
#define xPortSysTickHandler   SysTick_Handler

#define xPortSysTickHandler   SysTick_Handler





/* Assert */

/* Assert */

#define configASSERT(x)       MXC_ASSERT(x)

#define configASSERT(x)       assert(x)





/* Tickless idle hooks */

/* Tickless idle hooks */

typedef uint32_t TickType_t;

typedef uint32_t TickType_t;

epicardium/api/caller.c

+16 −1
Original line number Original line Diff line number Diff line
@@ -5,8 +5,17 @@ 
#define MXC_ASSERT_ENABLE

#define MXC_ASSERT_ENABLE

#include "mxc_assert.h"

#include "mxc_assert.h"





static uint32_t irq_save = 0;



void *_api_call_start(api_id_t id, uintptr_t size)

void *_api_call_start(api_id_t id, uintptr_t size)

{

{

	/*

	 * Disable all maskable interrupts here, to be turned on again at the

	 * end of _api_call_transact().

	 */

	irq_save = __get_PRIMASK();

	__set_PRIMASK(1);



	while (SEMA_GetSema(_API_SEMAPHORE) == E_BUSY) {

	while (SEMA_GetSema(_API_SEMAPHORE) == E_BUSY) {

	}

	}
@@ -51,6 +60,12 @@ void *_api_call_transact(void *buffer) 
	API_CALL_MEM->call_flag = _API_FLAG_IDLE;

	API_CALL_MEM->call_flag = _API_FLAG_IDLE;

	SEMA_FreeSema(_API_SEMAPHORE);

	SEMA_FreeSema(_API_SEMAPHORE);





	/*

	 * Re-enable interrupts (if previously enabled) after completing the API

	 * call.

	 */

	__set_PRIMASK(irq_save);



	return API_CALL_MEM->buffer;

	return API_CALL_MEM->buffer;

}

}
@@ -109,7 +124,7 @@ int api_fetch_args(char *buf, size_t cnt) 
		return 0;

		return 0;

	}

	}





	int i;

	size_t i;

	for (i = 0; i < cnt && API_CALL_MEM->buffer[i + 0x20] != '\0'; i++) {

	for (i = 0; i < cnt && API_CALL_MEM->buffer[i + 0x20] != '\0'; i++) {

		buf[i] = API_CALL_MEM->buffer[i + 0x20];

		buf[i] = API_CALL_MEM->buffer[i + 0x20];

	}

	}

epicardium/api/control.c

+35 −14
Original line number Original line Diff line number Diff line 
#include "epicardium.h"

#include "epicardium.h"

#include "api/dispatcher.h"

#include "api/dispatcher.h"

#include "api/interrupt-sender.h"

#include "modules/log.h"





#include "card10.h"

#include "card10.h"
@@ -10,6 +8,7 @@ 
#include "tmr.h"

#include "tmr.h"





static void __core1_init(void);

static void __core1_init(void);

extern void interrupt_trigger_sync(api_int_id_t id);





struct core1_info {

struct core1_info {

	/* Location of core1's interrupt vector table */

	/* Location of core1's interrupt vector table */
@@ -76,6 +75,11 @@ void __core1_init(void) 
	 */

	 */

	TMR_IntClear(MXC_TMR5);

	TMR_IntClear(MXC_TMR5);





	/*

	 * Disable the SysTick

	 */

	SysTick->CTRL = SysTick_CTRL_CLKSOURCE_Msk;



	/*

	/*

	 * Reset Interrupts

	 * Reset Interrupts

	 *

	 *
@@ -201,14 +205,19 @@ void core1_boot(void) 




void core1_trigger_reset(void)

void core1_trigger_reset(void)

{

{

	/* Signal core 1 that we intend to load a new payload. */

	/*

	api_interrupt_trigger(EPIC_INT_RESET);

	 * Signal core 1 that we intend to load a new payload.

	 *

	 * This needs to be synchroneous because otherwise we will deadlock

	 * (Lifecycle task busy-spins and interrupt can never get dispatched).

	 */

	interrupt_trigger_sync(EPIC_INT_RESET);

}

}





void core1_wait_ready(void)

bool core1_is_ready(void)

{

{

	/* Wait for the core to accept */

	bool ready;

	while (1) {



	while (SEMA_GetSema(_CONTROL_SEMAPHORE) == E_BUSY) {

	while (SEMA_GetSema(_CONTROL_SEMAPHORE) == E_BUSY) {

	}

	}
@@ -216,12 +225,21 @@ void core1_wait_ready(void) 
	 * core 1 will set the ready flag once it is spinning in the

	 * core 1 will set the ready flag once it is spinning in the

	 * above loop, waiting for a new IVT.

	 * above loop, waiting for a new IVT.

	 */

	 */

		if (core1_info.ready) {

	ready = core1_info.ready;

			break;

		}





	SEMA_FreeSema(_CONTROL_SEMAPHORE);

	SEMA_FreeSema(_CONTROL_SEMAPHORE);





	return ready;

}



void core1_wait_ready(void)

{

	/* Wait for the core to accept */

	while (1) {

		if (core1_is_ready()) {

			break;

		}



		for (int i = 0; i < 10000; i++) {

		for (int i = 0; i < 10000; i++) {

		}

		}

	}

	}
@@ -235,6 +253,9 @@ void core1_wait_ready(void) 




void core1_load(void *ivt, char *args)

void core1_load(void *ivt, char *args)

{

{

	while (SEMA_GetSema(_CONTROL_SEMAPHORE) == E_BUSY) {

	}



	/* If the core is currently in an API call, reset it. */

	/* If the core is currently in an API call, reset it. */

	API_CALL_MEM->call_flag = _API_FLAG_IDLE;

	API_CALL_MEM->call_flag = _API_FLAG_IDLE;

	API_CALL_MEM->id        = 0;

	API_CALL_MEM->id        = 0;

epicardium/api/dispatcher.c

+12 −7
Original line number Original line Diff line number Diff line
@@ -9,7 +9,7 @@ 
/* This function is defined by the generated dispatcher code */

/* This function is defined by the generated dispatcher code */

void __api_dispatch_call(api_id_t id, void *buffer);

void __api_dispatch_call(api_id_t id, void *buffer);





static volatile bool event_ready = false;

static volatile bool call_pending = false;





int api_dispatcher_init()

int api_dispatcher_init()

{

{
@@ -34,7 +34,7 @@ int api_dispatcher_init() 




bool api_dispatcher_poll_once()

bool api_dispatcher_poll_once()

{

{

	if (event_ready) {

	if (call_pending) {

		return false;

		return false;

	}

	}
@@ -46,22 +46,27 @@ bool api_dispatcher_poll_once() 
		return false;

		return false;

	}

	}





	event_ready = true;

	call_pending = true;

	return true;

	return true;

}

}





bool api_dispatcher_poll()

bool api_dispatcher_poll()

{

{

	if (event_ready) {

	if (call_pending) {

		return true;

		return true;

	}

	}





	return api_dispatcher_poll_once();

	return api_dispatcher_poll_once();

}

}





bool api_dispatcher_call_pending()

{

	return call_pending;

}



api_id_t api_dispatcher_exec()

api_id_t api_dispatcher_exec()

{

{

	if (!event_ready) {

	if (!call_pending) {

		return 0;

		return 0;

	}

	}
@@ -69,7 +74,7 @@ api_id_t api_dispatcher_exec() 
	__api_dispatch_call(id, API_CALL_MEM->buffer);

	__api_dispatch_call(id, API_CALL_MEM->buffer);

	API_CALL_MEM->call_flag = _API_FLAG_RETURNED;

	API_CALL_MEM->call_flag = _API_FLAG_RETURNED;





	event_ready = false;

	call_pending = false;

	SEMA_FreeSema(_API_SEMAPHORE);

	SEMA_FreeSema(_API_SEMAPHORE);





	/* Notify the caller that we returned */

	/* Notify the caller that we returned */
@@ -86,7 +91,7 @@ void api_prepare_args(char *args) 
	 * collide with any integer return value of API calls like epic_exec().

	 * collide with any integer return value of API calls like epic_exec().

	 */

	 */

	API_CALL_MEM->id = 0;

	API_CALL_MEM->id = 0;

	for (int i = 0; i <= strlen(args); i++) {

	for (size_t i = 0; i <= strlen(args); i++) {

		API_CALL_MEM->buffer[i + 0x20] = args[i];

		API_CALL_MEM->buffer[i + 0x20] = args[i];

	}

	}

}
 
}

epicardium/api/dispatcher.h

+9 −0
Original line number Original line Diff line number Diff line
@@ -15,6 +15,12 @@ int api_dispatcher_init(); 
bool api_dispatcher_poll_once();

bool api_dispatcher_poll_once();

bool api_dispatcher_poll();

bool api_dispatcher_poll();





/*

 * Check if the other core requested a call or if we are already excuting it.

 * Only returns a cached version, without acquiring any locks.

 */

bool api_dispatcher_call_pending();



/*

/*

 * Attempt to dispatch a call, if one had been polled using

 * Attempt to dispatch a call, if one had been polled using

 * api_dispatcher_poll().  Will return 0 if no call was dispatched or the ID of

 * api_dispatcher_poll().  Will return 0 if no call was dispatched or the ID of
@@ -39,6 +45,9 @@ void core1_boot(void); 
/* Reset core 1 into a state where it can accept a new payload */

/* Reset core 1 into a state where it can accept a new payload */

void core1_trigger_reset(void);

void core1_trigger_reset(void);





/* Check if core 1 is ready for a new payload */

bool core1_is_ready(void);



/* Wait for core 1 to respond that it is ready for a new payload */

/* Wait for core 1 to respond that it is ready for a new payload */

void core1_wait_ready(void);

void core1_wait_ready(void);

epicardium/api/genapi.py

+1 −1
Original line number Original line Diff line number Diff line
@@ -246,7 +246,7 @@ void __dispatch_isr(api_int_id_t id) 
    # Generate Dispatcher {{{

    # Generate Dispatcher {{{

    with open(args.server, "w") as f_dispatcher:

    with open(args.server, "w") as f_dispatcher:

        tmp = """\

        tmp = """\

#include "modules/log.h"

#include "os/core.h"

#include "{header}"

#include "{header}"





void __api_dispatch_call(uint32_t id, void*epc__apistub_buffer)

void __api_dispatch_call(uint32_t id, void*epc__apistub_buffer)

epicardium/api/interrupt-sender.c

+7 −38
Original line number Original line Diff line number Diff line 
#include "api/interrupt-sender.h"

#include "api/interrupt-sender.h"

#include "api/common.h"

#include "api/common.h"

#include "tmr_utils.h"

#include "tmr_utils.h"



#include <assert.h>

static bool int_enabled[EPIC_INT_NUM];



int api_interrupt_trigger(api_int_id_t id)

{

	if (id >= EPIC_INT_NUM) {

		return -EINVAL;

	}



	if (int_enabled[id]) {

		while (API_CALL_MEM->int_id != (-1))

			;



		API_CALL_MEM->int_id = id;

		TMR_TO_Start(MXC_TMR5, 1, 0);

	}

	return 0;

}





void api_interrupt_init(void)

void api_interrupt_init(void)

{

{

	API_CALL_MEM->int_id = (-1);

	API_CALL_MEM->int_id = (-1);



	for (int i = 0; i < EPIC_INT_NUM; i++) {

		int_enabled[i] = false;

}

}





	/* Reset interrupt is always enabled */

bool api_interrupt_is_ready(void)

	int_enabled[EPIC_INT_RESET] = true;

}



int epic_interrupt_enable(api_int_id_t int_id)

{

{

	if (int_id >= EPIC_INT_NUM) {

	return API_CALL_MEM->int_id == (api_int_id_t)(-1);

		return -EINVAL;

}

}





	int_enabled[int_id] = true;

void api_interrupt_trigger(api_int_id_t id)

	return 0;

}



int epic_interrupt_disable(api_int_id_t int_id)

{

{

	if (int_id >= EPIC_INT_NUM || int_id == EPIC_INT_RESET) {

	assert(API_CALL_MEM->int_id == (api_int_id_t)(-1));

		return -EINVAL;

	}





	int_enabled[int_id] = false;

	API_CALL_MEM->int_id = id;

	return 0;

	TMR_TO_Start(MXC_TMR5, 1, 0);

}
 
}

epicardium/api/interrupt-sender.h

+2 −1
Original line number Original line Diff line number Diff line
@@ -2,4 +2,5 @@ 
#include "api/common.h"

#include "api/common.h"





void api_interrupt_init(void);

void api_interrupt_init(void);

int api_interrupt_trigger(api_int_id_t id);
 
bool api_interrupt_is_ready(void);

void api_interrupt_trigger(api_int_id_t id);

epicardium/ble/app/app_main.c

deleted100644 → 0
+0 −423
Original line number Original line Diff line number Diff line 
/*************************************************************************************************/

/*!

 *  \file

 *

 *  \brief  Application framework main module.

 *

 *  Copyright (c) 2011-2018 Arm Ltd. All Rights Reserved.

 *  ARM Ltd. confidential and proprietary.

 *

 *  IMPORTANT.  Your use of this file is governed by a Software License Agreement

 *  ("Agreement") that must be accepted in order to download or otherwise receive a

 *  copy of this file.  You may not use or copy this file for any purpose other than

 *  as described in the Agreement.  If you do not agree to all of the terms of the

 *  Agreement do not use this file and delete all copies in your possession or control;

 *  if you do not have a copy of the Agreement, you must contact ARM Ltd. prior

 *  to any use, copying or further distribution of this software.

 */

/*************************************************************************************************/



/* card10:

 * copied from: lib/sdk/Libraries/BTLE/stack/ble-profiles/sources/apps/app/app_main.c

 *

 * Reason: we need to correctly implement AppHandleNumericComparison

 */

/* clang-format off */

/* clang-formet turned off for easier diffing against orginal file */

#include <string.h>

#include "wsf_types.h"

#include "wsf_msg.h"

#include "sec_api.h"

#include "wsf_trace.h"

#include "wsf_timer.h"

#include "wsf_assert.h"

#include "util/bstream.h"

#include "dm_api.h"

#include "app_api.h"

#include "app_main.h"

#include "app_ui.h"



/**************************************************************************************************

  Global Variables

**************************************************************************************************/



/*! Configuration pointer for advertising */

appAdvCfg_t *pAppAdvCfg;



/*! Configuration pointer for extended and periodic advertising */

appExtAdvCfg_t *pAppExtAdvCfg;



/*! Configuration pointer for slave */

appSlaveCfg_t *pAppSlaveCfg;



/*! Configuration pointer for master */

appMasterCfg_t *pAppMasterCfg;



/*! Configuration pointer for extended master */

appExtMasterCfg_t *pAppExtMasterCfg;



/*! Configuration pointer for security */

appSecCfg_t *pAppSecCfg;



/*! Configuration pointer for connection parameter update */

appUpdateCfg_t *pAppUpdateCfg;



/*! Configuration pointer for discovery */

appDiscCfg_t *pAppDiscCfg;



/*! Configuration pointer for application */

appCfg_t *pAppCfg;



/*! Connection control block array */

appConnCb_t appConnCb[DM_CONN_MAX];



/*! WSF handler ID */

wsfHandlerId_t appHandlerId;



/*! Main control block */

appCb_t appCb;



/*! Configuration structure for incoming request actions */

const appReqActCfg_t appReqActCfg =

{

  APP_ACT_ACCEPT        /*! Action for the remote connection parameter request */

};



/*! Configuration pointer for incoming request actions on master */

appReqActCfg_t *pAppMasterReqActCfg = (appReqActCfg_t *) &appReqActCfg;



/*! Configurable pointer for incoming request actions on slave */

appReqActCfg_t *pAppSlaveReqActCfg = (appReqActCfg_t *) &appReqActCfg;



/*************************************************************************************************/

/*!

 *  \brief  Process messages from the event handler.

 *

 *  \param  pMsg    Pointer to message.

 *

 *  \return None.

 */

/*************************************************************************************************/

static void appProcMsg(wsfMsgHdr_t *pMsg)

{

  switch(pMsg->event)

  {

    case APP_BTN_POLL_IND:

      appUiBtnPoll();

      break;



    case APP_UI_TIMER_IND:

      appUiTimerExpired(pMsg);

      break;



    default:

      break;

  }

}



/*************************************************************************************************/

/*!

 *  \brief  Check the bonded state of a connection.

 *

 *  \param  connId      DM connection ID.

 *

 *  \return Bonded state.

 */

/*************************************************************************************************/

bool_t appCheckBonded(dmConnId_t connId)

{

  WSF_ASSERT((connId > 0) && (connId <= DM_CONN_MAX));



  return appConnCb[connId - 1].bonded;

}



/*************************************************************************************************/

/*!

 *  \brief  Check the bond-by-LTK state of a connection.

 *

 *  \param  connId      DM connection ID.

 *

 *  \return Bond-by-LTK state.

 */

/*************************************************************************************************/

bool_t appCheckBondByLtk(dmConnId_t connId)

{

  WSF_ASSERT((connId > 0) && (connId <= DM_CONN_MAX));



  return appConnCb[connId - 1].bondByLtk;

}



/*************************************************************************************************/

/*!

 *  \brief  Return the number of existing connections of the given role.

 *

 *  \param  role      Connection role

 *

 *  \return Number of connections.

 */

/*************************************************************************************************/

uint8_t appNumConns(uint8_t role)

{

  appConnCb_t   *pCcb = appConnCb;

  uint8_t       i, j;



  for (i = DM_CONN_MAX, j = 0; i > 0; i--, pCcb++)

  {

    if ((pCcb->connId != DM_CONN_ID_NONE) && (DmConnRole(pCcb->connId) == role))

    {

      j++;

    }

  }



  return j;

}



/*************************************************************************************************/

/*!

 *  \brief  App framework handler init function called during system initialization.

 *

 *  \param  handlerID  WSF handler ID for App.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppInit(void)

{

  appHandlerId = WsfOsSetNextHandler(AppHandler);



  AppDbInit();

}



/*************************************************************************************************/

/*!

 *  \brief  WSF event handler for app framework.

 *

 *  \param  event   WSF event mask.

 *  \param  pMsg    WSF message.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppHandler(wsfEventMask_t event, wsfMsgHdr_t *pMsg)

{

  if (pMsg != NULL)

  {

    APP_TRACE_INFO1("App got evt %d", pMsg->event);



    if (pMsg->event >= APP_MASTER_MSG_START)

    {

      /* pass event to master handler */

      (*appCb.masterCback)(pMsg);

    }

    else if (pMsg->event >= APP_SLAVE_MSG_START)

    {

      /* pass event to slave handler */

      (*appCb.slaveCback)(pMsg);

    }

    else

    {

      appProcMsg(pMsg);

    }

  }

  else

  {

    if (event & APP_BTN_DOWN_EVT)

    {

      AppUiBtnPressed();

    }

  }

}



/*************************************************************************************************/

/*!

 *  \brief  Handle a passkey request during pairing.  If the passkey is to displayed, a

 *          random passkey is generated and displayed.  If the passkey is to be entered

 *          the user is prompted to enter the passkey.

 *

 *  \param  pAuthReq  DM authentication requested event structure.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppHandlePasskey(dmSecAuthReqIndEvt_t *pAuthReq)

{

  uint32_t passkey;

  uint8_t  buf[SMP_PIN_LEN];



  if (pAuthReq->display)

  {

    /* generate random passkey, limit to 6 digit max */

    SecRand((uint8_t *) &passkey, sizeof(uint32_t));

    passkey %= 1000000;



    /* convert to byte buffer */

    buf[0] = UINT32_TO_BYTE0(passkey);

    buf[1] = UINT32_TO_BYTE1(passkey);

    buf[2] = UINT32_TO_BYTE2(passkey);



    /* send authentication response to DM */

    DmSecAuthRsp((dmConnId_t) pAuthReq->hdr.param, SMP_PIN_LEN, buf);



    /* display passkey */

    AppUiDisplayPasskey(passkey);

  }

  else

  {

    /* prompt user to enter passkey */

    AppUiAction(APP_UI_PASSKEY_PROMPT);

  }

}



/*************************************************************************************************/

/*!

*  \brief  Handle a numeric comparison indication during pairing.  The confirmation value is

*          displayed and the user is prompted to verify that the local and peer confirmation

*          values match.

*

*  \param  pCnfInd  DM confirmation indication event structure.

*

*  \return None.

*/

/*************************************************************************************************/

void AppHandleNumericComparison(dmSecCnfIndEvt_t *pCnfInd)

{

  uint32_t confirm = DmSecGetCompareValue(pCnfInd->confirm);



  /* display confirmation value */

  AppUiDisplayConfirmValue(confirm);



  /* TODO: Verify that local and peer confirmation values match */

  DmSecCompareRsp((dmConnId_t)pCnfInd->hdr.param, TRUE);

}



/*************************************************************************************************/

/*!

 *  \brief  Close the connection with the give connection identifier.

 *

 *  \param  connId    Connection identifier.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppConnClose(dmConnId_t connId)

{

  DmConnClose(DM_CLIENT_ID_APP, connId, HCI_ERR_REMOTE_TERMINATED);

}



/*************************************************************************************************/

/*!

 *  \brief  Get a list of connection identifiers of open connections.

 *

 *  \param  pConnIdList    Buffer to hold connection IDs (must be DM_CONN_MAX bytes).

 *

 *  \return Number of open connections.

 *

 */

/*************************************************************************************************/

uint8_t AppConnOpenList(dmConnId_t *pConnIdList)

{

  appConnCb_t   *pCcb = appConnCb;

  uint8_t       i;

  uint8_t       pos = 0;



  memset(pConnIdList, DM_CONN_ID_NONE, DM_CONN_MAX);



  for (i = DM_CONN_MAX; i > 0; i--, pCcb++)

  {

    if (pCcb->connId != DM_CONN_ID_NONE)

    {

      pConnIdList[pos++] = pCcb->connId;

    }

  }



  return pos;

}



/*************************************************************************************************/

/*!

 *  \brief  Check if a connection is open.

 *

 *  \return Connection ID of open connection or DM_CONN_ID_NONE if no open connections.

 */

/*************************************************************************************************/

dmConnId_t AppConnIsOpen(void)

{

  appConnCb_t   *pCcb = appConnCb;

  uint8_t       i;



  for (i = DM_CONN_MAX; i > 0; i--, pCcb++)

  {

    if (pCcb->connId != DM_CONN_ID_NONE)

    {

      return pCcb->connId;

    }

  }



  return DM_CONN_ID_NONE;

}



/*************************************************************************************************/

/*!

 *  \brief  Get the device database record handle associated with an open connection.

 *

 *  \param  connId    Connection identifier.

 *

 *  \return Database record handle or APP_DB_HDL_NONE.

 */

/*************************************************************************************************/

appDbHdl_t AppDbGetHdl(dmConnId_t connId)

{

  return appConnCb[connId-1].dbHdl;

}



/*************************************************************************************************/

/*!

 *  \brief  Add device to resolving list.

 *

 *  \param  pMsg    Pointer to DM callback event message.

 *  \param  connId  Connection identifier.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppAddDevToResList(dmEvt_t *pMsg, dmConnId_t connId)

{

  dmSecKey_t *pPeerKey;

  appDbHdl_t hdl = appConnCb[connId - 1].dbHdl;



  /* if LL Privacy is supported and the peer device has distributed its IRK */

  if (HciLlPrivacySupported() && ((pPeerKey = AppDbGetKey(hdl, DM_KEY_IRK, NULL))!= NULL))

  {

    /* add peer device to resolving list. If all-zero local or peer IRK is used then

       LL will only use or accept local or peer identity address respectively. */

    DmPrivAddDevToResList(pPeerKey->irk.addrType, pPeerKey->irk.bdAddr, pPeerKey->irk.key,

                          DmSecGetLocalIrk(), TRUE, pMsg->hdr.param);

  }

}



/*************************************************************************************************/

/*!

 *  \brief  Update privacy mode for a given peer device.

 *

 *  \param  hdl     Database record handle.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUpdatePrivacyMode(appDbHdl_t hdl)

{

  /* if peer device's been added to resolving list but RPA Only attribute not found on peer device */

  if ((hdl != APP_DB_HDL_NONE) && AppDbGetPeerAddedToRl(hdl) && !AppDbGetPeerRpao(hdl))

  {

    dmSecKey_t *pPeerKey = AppDbGetKey(hdl, DM_KEY_IRK, NULL);

    if (pPeerKey != NULL)

    {

      /* set device privacy mode for this peer device */

      DmPrivSetPrivacyMode(pPeerKey->irk.addrType, pPeerKey->irk.bdAddr, DM_PRIV_MODE_DEVICE);



      /* make sure resolving list flag cleared */

      AppDbSetPeerAddedToRl(hdl, FALSE);

    }

  }

}

/* clang-format on */

epicardium/ble/app/common/app_db.c

deleted100644 → 0
+0 −779

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/ble/app/common/app_ui.c

deleted100644 → 0
+0 −349
Original line number Original line Diff line number Diff line 
/*************************************************************************************************/

/*!

 *  \file

 *

 *  \brief  Application framework user interface.

 *

 *  Copyright (c) 2011-2018 Arm Ltd. All Rights Reserved.

 *  ARM Ltd. confidential and proprietary.

 *

 *  IMPORTANT.  Your use of this file is governed by a Software License Agreement

 *  ("Agreement") that must be accepted in order to download or otherwise receive a

 *  copy of this file.  You may not use or copy this file for any purpose other than

 *  as described in the Agreement.  If you do not agree to all of the terms of the

 *  Agreement do not use this file and delete all copies in your possession or control;

 *  if you do not have a copy of the Agreement, you must contact ARM Ltd. prior

 *  to any use, copying or further distribution of this software.

 */

/*************************************************************************************************/



#include "wsf_types.h"

#include "wsf_os.h"

#include "wsf_trace.h"

#include "app_ui.h"



/* card10:

 * copied from: lib/sdk/Libraries/BTLE/stack/ble-profiles/sources/apps/app/common/app_ui.c

 *

 * Reason: has several user interactions which we likley have to implement

 */



/* clang-format off */

/* clang-formet turned off for easier diffing against orginal file */

/**************************************************************************************************

  Global Variables

**************************************************************************************************/



/*! \brief Callback struct */

appUiCback_t appUiCbackTbl;





/*************************************************************************************************/

/*!

 *  \brief  card10 - Should disable encryption. MAXIM bug reported to us in current static library. Requires 

 *                   this to be called before the BTLE app starts making advertisements. Avoids encryption

 *                   rendering the frame unreadable.

 *

 *  \return None.

 */

/*************************************************************************************************/

void llc_api_crypto_disable_tx();





/*************************************************************************************************/

/*!

 *  \brief  Perform a user interface action based on the event value passed to the function.

 *

 *  \param  event   User interface event value.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiAction(uint8_t event)

{

  switch (event)

  {

    case APP_UI_NONE:

      /* no action */

      break;



    case APP_UI_RESET_CMPL:

      APP_TRACE_INFO0(">>> Reset complete <<<");

      break;



    case APP_UI_ADV_START:

      llc_api_crypto_disable_tx();

      APP_TRACE_INFO0(">>> Advertising started <<<");

      break;



    case APP_UI_ADV_STOP:

      APP_TRACE_INFO0(">>> Advertising stopped <<<");

      break;



    case APP_UI_SCAN_START:

      APP_TRACE_INFO0(">>> Scanning started <<<");

      break;



    case APP_UI_SCAN_STOP:

      APP_TRACE_INFO0(">>> Scanning stopped <<<");

      break;



    case APP_UI_SCAN_REPORT:

      APP_TRACE_INFO0(">>> Scan data received from peer <<<");

      break;



    case APP_UI_CONN_OPEN:

      APP_TRACE_INFO0(">>> Connection opened <<<");

      break;



    case APP_UI_CONN_CLOSE:

      APP_TRACE_INFO0(">>> Connection closed <<<");

      break;



    case APP_UI_SEC_PAIR_CMPL:

      APP_TRACE_INFO0(">>> Pairing completed successfully <<<");

      break;



    case APP_UI_SEC_PAIR_FAIL:

      APP_TRACE_INFO0(">>> Pairing failed <<<");

      break;



    case APP_UI_SEC_ENCRYPT:

      APP_TRACE_INFO0(">>> Connection encrypted <<<");

      break;



    case APP_UI_SEC_ENCRYPT_FAIL:

      APP_TRACE_INFO0(">>> Encryption failed <<<");

      break;



    case APP_UI_PASSKEY_PROMPT:

      APP_TRACE_INFO0(">>> Prompt user to enter passkey <<<");

      break;



    case APP_UI_ALERT_CANCEL:

      APP_TRACE_INFO0(">>> Cancel a low or high alert <<<");

      break;



    case APP_UI_ALERT_LOW:

      APP_TRACE_INFO0(">>> Low alert <<<");

      break;



    case APP_UI_ALERT_HIGH:

      APP_TRACE_INFO0(">>> High alert <<<");

      break;



    case APP_UI_ADV_SET_START_IND:

      APP_TRACE_INFO0(">>> Advertising set(s) started <<<");

      break;



    case APP_UI_ADV_SET_STOP_IND:

      APP_TRACE_INFO0(">>> Advertising set(s) stopped <<<");

      break;



    case APP_UI_SCAN_REQ_RCVD_IND:

      APP_TRACE_INFO0(">>> Scan request received <<<");

      break;



    case APP_UI_EXT_SCAN_START_IND:

      APP_TRACE_INFO0(">>> Extended scanning started <<<");

      break;



    case APP_UI_EXT_SCAN_STOP_IND:

      APP_TRACE_INFO0(">>> Extended scanning stopped <<<");

      break;



    case APP_UI_PER_ADV_SET_START_IND:

      APP_TRACE_INFO0(">>> Periodic advertising set started <<<");

      break;



    case APP_UI_PER_ADV_SET_STOP_IND:

      APP_TRACE_INFO0(">>> Periodic advertising set stopped <<<");

      break;



    case APP_UI_PER_ADV_SYNC_EST_IND:

      APP_TRACE_INFO0(">>> Periodic advertising sync established <<<");

      break;



    case APP_UI_PER_ADV_SYNC_LOST_IND:

      APP_TRACE_INFO0(">>> Periodic advertising sync lost <<<");

      break;



    default:

      break;

  }



  if (appUiCbackTbl.actionCback)

  {

    (*appUiCbackTbl.actionCback)(event);

  }

}



/*************************************************************************************************/

/*!

 *  \brief  Display a passkey.

 *

 *  \param  passkey   Passkey to display.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiDisplayPasskey(uint32_t passkey)

{

  APP_TRACE_INFO1(">>> Passkey: %d <<<", passkey);

}



/*************************************************************************************************/

/*!

*  \brief  Display a confirmation value.

*

*  \param  confirm    Confirm value to display.

*

*  \return None.

*/

/*************************************************************************************************/

void AppUiDisplayConfirmValue(uint32_t confirm)

{

  APP_TRACE_INFO1(">>> Confirm Value: %d <<<", confirm);

}



/*************************************************************************************************/

/*!

 *  \brief  Display an RSSI value.

 *

 *  \param  rssi   Rssi value to display.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiDisplayRssi(int8_t rssi)

{

  APP_TRACE_INFO1(">>> RSSI: %d dBm<<<", rssi);

}



/*************************************************************************************************/

/*!

 *  \brief  Handle a UI timer expiration event.

 *

 *  \param  pMsg    Pointer to message.

 *

 *  \return None.

 */

/*************************************************************************************************/

void appUiTimerExpired(wsfMsgHdr_t *pMsg)

{



}



/*************************************************************************************************/

/*!

 *  \brief  Perform button press polling.  This function is called to handle WSF

 *          message APP_BTN_POLL_IND.

 *

 *  \return None.

 */

/*************************************************************************************************/

void appUiBtnPoll(void)

{

  if (appUiCbackTbl.btnPollCback)

  {

    (*appUiCbackTbl.btnPollCback)();

  }

}



/*************************************************************************************************/

/*!

 *  \brief  Handle a hardware button press.  This function is called to handle WSF

 *          event APP_BTN_DOWN_EVT.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiBtnPressed(void)

{



}



/*************************************************************************************************/

/*!

 *  \brief  Register a callback function to receive application button press events.

 *

 *  \return None.

 *

 *  \note   Registered by application to receive button events

 */

/*************************************************************************************************/

void AppUiBtnRegister(appUiBtnCback_t btnCback)

{

  appUiCbackTbl.btnCback = btnCback;

}



/*************************************************************************************************/

/*!

 *  \brief  Register a callback function to receive action events.

 *

 *  \return None.

 *

 *  \note   Registered by platform

 */

/*************************************************************************************************/

void AppUiActionRegister(appUiActionCback_t actionCback)

{

  appUiCbackTbl.actionCback = actionCback;

}



/*************************************************************************************************/

/*!

 *  \brief  Register a callback function to receive APP_BTN_POLL_IND events.

 *

 *  \return None.

 *

 *  \note   Registered by platform

 */

/*************************************************************************************************/

void AppUiBtnPollRegister(appUiBtnPollCback_t btnPollCback)

{

  appUiCbackTbl.btnPollCback = btnPollCback;

}



/*************************************************************************************************/

/*!

 *  \brief  Play a sound.

 *

 *  \param  pSound   Pointer to sound tone/duration array.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiSoundPlay(const appUiSound_t *pSound)

{



}



/*************************************************************************************************/

/*!

 *  \brief  Stop the sound that is currently playing.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiSoundStop(void)

{



}



/*************************************************************************************************/

/*!

 *  \brief  Button test function-- for test purposes only.

 *

 *  \return None.

 */

/*************************************************************************************************/

void AppUiBtnTest(uint8_t btn)

{

  if (appUiCbackTbl.btnCback)

  {

    (*appUiCbackTbl.btnCback)(btn);

  }

}



/* clang-format on */

epicardium/ble/ble.c

+242 −48

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/ble/ble_adv.c

0 → 100644
+264 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/ble_api.h

+46 −0
Original line number Original line Diff line number Diff line 
#pragma once

#pragma once



#include "epicardium.h"



#include <stdint.h>

#include "wsf_types.h"



#include "att_api.h"

#include "dm_api.h"



#define CARD10_UUID_SUFFIX                                                     \

	0x42, 0x23, 0x42, 0x23, 0x42, 0x23, 0x42, 0x23, 0x42, 0x23, 0x42, 0x23

#define CARD10_UUID_PREFIX 0x02, 0x23, 0x42



/**************************************************************************************************

  Data Types

**************************************************************************************************/



/*! Application message type */

typedef union

{

  wsfMsgHdr_t     hdr;

  dmEvt_t         dm;

  attsCccEvt_t    ccc;

  attEvt_t        att;

} bleMsg_t;



/**************************************************************************************************

/**************************************************************************************************

  Function Declarations

  Function Declarations

**************************************************************************************************/

**************************************************************************************************/
@@ -11,3 +37,23 @@ 
/*************************************************************************************************/

/*************************************************************************************************/

void BleStart(void);

void BleStart(void);





/* ATT client module interface. Used by main BLE module */

void bleValueUpdate(attEvt_t *pMsg);

void bleDiscCback(dmConnId_t connId, uint8_t status);



void ble_epic_att_api_init(void);

void ble_epic_att_api_event(attEvt_t *att_event);

void ble_epic_att_api_free_att_write_data(struct epic_att_write *w);



void ble_epic_ble_api_trigger_event(enum epic_ble_event_type type, void *data);

void ble_epic_ble_api_init(void);

void ble_epic_dm_api_event(dmEvt_t *dm_event);

void ble_epic_disc_cfg_complete(void);



void ble_adv_init(void);

void ble_adv_setup(void);

void ble_adv_set_interval(uint32_t interval_ms);

void ble_adv_stop(void);

void ble_adv_start(uint8_t mode);

void ble_adv_discoverable(bool discoverable);

void ble_adv_proc_msg(bleMsg_t *pMsg);

epicardium/ble/ble_attc.c

0 → 100644
+275 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/ble_main.c

+434 −173

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/ble/bondings.c

0 → 100644
+957 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/card10.c

+358 −238

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/ble/cccd.h

0 → 100644
+19 −0
Original line number Original line Diff line number Diff line 
#pragma once

/*! enumeration of client characteristic configuration descriptors */

enum

{

  BLE_GATT_SC_CCC_IDX,                    /*! GATT service, service changed characteristic */

  BLE_BATT_LVL_CCC_IDX,                   /*! Battery service, battery level characteristic */

  BLE_ESS_TEMP_CCC_IDX,                   /*! Environmental sensing service, temperature characteristic */

  BLE_ESS_HUMI_CCC_IDX,                   /*! Environmental sensing service, humidity characteristic */

  BLE_ESS_PRES_CCC_IDX,                   /*! Environmental sensing service, pressure characteristic */

  HIDAPP_MBI_CCC_HDL,                   /*! HID Boot Mouse Input characteristic */

  HIDAPP_KBI_CCC_HDL,                   /*! HID Boot Keyboard Input characteristic */

  HIDAPP_IN_KEYBOARD_CCC_HDL,           /*! HID Input Report characteristic for keyboard inputs */

  HIDAPP_IN_MOUSE_CCC_HDL,              /*! HID Input Report characteristic for mouse inputs */

  HIDAPP_IN_CONSUMER_CCC_HDL,             /*! HID Input Report characteristic for consumer control inputs */

  BLE_ESS_IAQ_CCC_IDX,                    /*! Environmental sensing service, IAQ characteristic */

  UART_TX_CH_CCC_IDX,

  BLE_NUM_CCC_IDX

};

epicardium/ble/epic_att_api.c

0 → 100644
+362 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/epic_ble_api.c

0 → 100644
+259 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/ess.c

0 → 100644
+440 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/ess.h

0 → 100644
+36 −0
Original line number Original line Diff line number Diff line 
#pragma once



#include "epicardium.h"



/*!< \brief Service start handle. */

#define ESS_START_HDL 0x1000

/*!< \brief Service end handle. */

#define ESS_END_HDL (ESS_MAX_HDL - 1)



enum {

	/*!< \brief environmental sensing services service declaration */

	ESS_SVC_HDL = ESS_START_HDL,

	/*!< \brief temperature characteristic */

	ESS_TEMPERATURE_CH_HDL,

	ESS_TEMPERATURE_VAL_HDL,

	ESS_TEMP_CH_CCC_HDL,                  /*!< Temperature CCCD */

	/*!< \brief humidity characteristic */

	ESS_HUMIDITY_CH_HDL,

	ESS_HUMIDITY_VAL_HDL,

	ESS_HUMI_CH_CCC_HDL,                  /*!< Humidity CCCD */

	/*!< \brief pressure characteristic */

	ESS_PRESSURE_CH_HDL,

	ESS_PRESSURE_VAL_HDL,

	ESS_PRES_CH_CCC_HDL,                  /*!< Pressure CCCD */

	/*!< \brief IAQ/CO2 characteristic */

	ESS_IAQ_CH_HDL,

	ESS_IAQ_VAL_HDL,

	ESS_IAQ_CH_CCC_HDL,                   /*!< IAQ CCCD */





	/*!< \brief Maximum handle. */

	ESS_MAX_HDL

};



void bleESS_ccc_update(void);

void bleESS_update_from_bsec_data(struct bsec_sensor_data *data);

epicardium/ble/filetransfer.c

+17 −16
Original line number Original line Diff line number Diff line
@@ -33,7 +33,7 @@ 
#include "hci_vs.h"

#include "hci_vs.h"





#include <epicardium.h>

#include <epicardium.h>

#include "modules/log.h"

#include "os/core.h"





#include "util/bstream.h"

#include "util/bstream.h"

#include "att_api.h"

#include "att_api.h"
@@ -143,7 +143,8 @@ static const attsAttr_t fileTransCfgList[] = { 
		.pLen        = NULL,

		.pLen        = NULL,

		.maxLen      = 128,

		.maxLen      = 128,

		.settings    = ATTS_SET_WRITE_CBACK | ATTS_SET_VARIABLE_LEN,

		.settings    = ATTS_SET_WRITE_CBACK | ATTS_SET_VARIABLE_LEN,

		.permissions = ATTS_PERMIT_WRITE | ATTS_PERMIT_WRITE_AUTH,

		.permissions = ATTS_PERMIT_WRITE | ATTS_PERMIT_WRITE_ENC |

			       ATTS_PERMIT_WRITE_AUTH,

	},

	},

	/* File transfer Central RX characteristic */

	/* File transfer Central RX characteristic */

	{

	{
@@ -161,7 +162,8 @@ static const attsAttr_t fileTransCfgList[] = { 
		.pLen        = &attRxChConfigValue_len,

		.pLen        = &attRxChConfigValue_len,

		.maxLen      = sizeof(attRxChConfigValue),

		.maxLen      = sizeof(attRxChConfigValue),

		.settings    = ATTS_SET_VARIABLE_LEN,

		.settings    = ATTS_SET_VARIABLE_LEN,

		.permissions = ATTS_PERMIT_READ | ATTS_PERMIT_READ_AUTH,

		.permissions = ATTS_PERMIT_READ | ATTS_PERMIT_READ_ENC |

			       ATTS_PERMIT_READ_AUTH,

	},

	},

	/* File transfer Central RX notification channel */

	/* File transfer Central RX notification channel */

	{

	{
@@ -170,8 +172,9 @@ static const attsAttr_t fileTransCfgList[] = { 
		.pLen        = &attRxChConfigValue_len,

		.pLen        = &attRxChConfigValue_len,

		.maxLen      = sizeof(attRxChConfigValue),

		.maxLen      = sizeof(attRxChConfigValue),

		.settings    = ATTS_SET_CCC,

		.settings    = ATTS_SET_CCC,

		.permissions = ATTS_PERMIT_READ | ATTS_PERMIT_READ_AUTH |

		.permissions = ATTS_PERMIT_READ | ATTS_PERMIT_READ_ENC |

			       ATTS_PERMIT_WRITE | ATTS_PERMIT_WRITE_AUTH,

			       ATTS_PERMIT_READ_AUTH | ATTS_PERMIT_WRITE |

			       ATTS_PERMIT_WRITE_ENC | ATTS_PERMIT_WRITE_AUTH,

	},

	},

};

};
@@ -393,9 +396,7 @@ static uint8_t writeCallback( 
			connId, handle, operation, offset, len, pValue, pAttr

			connId, handle, operation, offset, len, pValue, pAttr

		);

		);

	default:

	default:

		LOG_ERR("filetrans",

		LOG_ERR("filetrans", "unsupported handle: %x\n", handle);

			"unsupported characteristic: %c\n",

			handle);

		return ATT_ERR_HANDLE;

		return ATT_ERR_HANDLE;

	}

	}

}

}

epicardium/ble/hid.c

0 → 100644
+221 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/hid.h

0 → 100644
+20 −0
Original line number Original line Diff line number Diff line 
#pragma once



#include "wsf_types.h"

#include "wsf_os.h"



/* The input report fits in one byte */

#define HIDAPP_KEYBOARD_INPUT_REPORT_LEN  8

#define HIDAPP_MOUSE_INPUT_REPORT_LEN     4

#define HIDAPP_CONSUMER_INPUT_REPORT_LEN  2

#define HIDAPP_OUTPUT_REPORT_LEN          1

#define HIDAPP_FEATURE_REPORT_LEN         1





/* HID Report IDs */

#define HIDAPP_KEYBOARD_REPORT_ID         1

#define HIDAPP_MOUSE_REPORT_ID            2

#define HIDAPP_CONSUMER_REPORT_ID         3



void hid_init(void);

void HidProcMsg(wsfMsgHdr_t *pMsg);

epicardium/ble/hid_work.c

0 → 100644
+241 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/meson.build

+10 −3
Original line number Original line Diff line number Diff line 
ble_sources = files(

ble_sources = files(

  'ble.c',

  'ble.c',

  'epic_ble_api.c',

  'epic_att_api.c',

  'stack.c',

  'stack.c',

  'ble_main.c',

  'ble_main.c',

  'ble_adv.c',

  'ble_attc.c',

  'profiles/tipc_main.c',

  'profiles/gap_main.c',

  'svc_dis.c',

  'svc_dis.c',

  'svc_core.c',

  'svc_core.c',

  'app/app_main.c',

  'bondings.c',

  'app/common/app_db.c',

  'app/common/app_ui.c',

  'uart.c',

  'uart.c',

  'card10.c',

  'card10.c',

  'ess.c',

  'filetransfer.c',

  'filetransfer.c',

  'hid.c',

  'hid_work.c',

)
 
)

epicardium/ble/profiles/gap_api.h

0 → 100644
+87 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/profiles/gap_main.c

0 → 100644
+157 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/profiles/tipc_main.c

0 → 100644
+203 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/ble/stack.c

+28 −17

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/ble/svc_dis.c

+8 −3
Original line number Original line Diff line number Diff line
@@ -24,13 +24,17 @@ 
 */

 */

/* clang-format off */

/* clang-format off */

/* clang-formet turned off for easier diffing against orginal file */

/* clang-formet turned off for easier diffing against orginal file */

#include "card10-version.h"

#include "wsf_types.h"

#include "wsf_types.h"

#include "att_api.h"

#include "att_api.h"

#include "wsf_assert.h"

#include "wsf_assert.h"

#include "wsf_trace.h"

#include "wsf_trace.h"

#include "util/bstream.h"

#include "util/bstream.h"



#define DIS_MAXSIZE_FWR_ATT 32

#include "svc_dis.h"

#include "svc_dis.h"

#include "svc_cfg.h"

#include "svc_cfg.h"

#include <string.h>





/**************************************************************************************************

/**************************************************************************************************

  Macros

  Macros
@@ -60,10 +64,10 @@ 
#define DIS_DEFAULT_SERIAL_NUM_LEN  1

#define DIS_DEFAULT_SERIAL_NUM_LEN  1





/*! Default firmware revision */

/*! Default firmware revision */

#define DIS_DEFAULT_FW_REV          "<git hash>"

#define DIS_DEFAULT_FW_REV          CARD10_VERSION





/*! Length of default firmware revision */

/*! Length of default firmware revision */

#define DIS_DEFAULT_FW_REV_LEN      10

#define DIS_DEFAULT_FW_REV_LEN      strlen(CARD10_VERSION)





/*! Default hardware revision */

/*! Default hardware revision */

#define DIS_DEFAULT_HW_REV          "1"

#define DIS_DEFAULT_HW_REV          "1"
@@ -128,7 +132,7 @@ static const uint16_t disLenFwrCh = sizeof(disValFwrCh); 
/* Firmware revision string */

/* Firmware revision string */

static const uint8_t disUuFwr[] = {UINT16_TO_BYTES(ATT_UUID_FIRMWARE_REV)};

static const uint8_t disUuFwr[] = {UINT16_TO_BYTES(ATT_UUID_FIRMWARE_REV)};

static uint8_t disValFwr[DIS_MAXSIZE_FWR_ATT] = DIS_DEFAULT_FW_REV;

static uint8_t disValFwr[DIS_MAXSIZE_FWR_ATT] = DIS_DEFAULT_FW_REV;

static uint16_t disLenFwr = DIS_DEFAULT_FW_REV_LEN;

static uint16_t disLenFwr;





/* Hardware revision string characteristic */

/* Hardware revision string characteristic */

static const uint8_t disValHwrCh[] = {ATT_PROP_READ, UINT16_TO_BYTES(DIS_HWR_HDL), UINT16_TO_BYTES(ATT_UUID_HARDWARE_REV)};

static const uint8_t disValHwrCh[] = {ATT_PROP_READ, UINT16_TO_BYTES(DIS_HWR_HDL), UINT16_TO_BYTES(ATT_UUID_HARDWARE_REV)};
@@ -319,6 +323,7 @@ WSF_CT_ASSERT(((sizeof(disList) / sizeof(disList[0])) == DIS_END_HDL - DIS_START 
/*************************************************************************************************/

/*************************************************************************************************/

void SvcDisAddGroup(void)

void SvcDisAddGroup(void)

{

{

  disLenFwr = DIS_DEFAULT_FW_REV_LEN;

  AttsAddGroup(&svcDisGroup);

  AttsAddGroup(&svcDisGroup);

}

}

epicardium/ble/uart.c

+155 −112

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/ble/uart.h

0 → 100644
+19 −0
Original line number Original line Diff line number Diff line 
#pragma once



#include "ble_api.h"



#define UART_START_HDL 0x800            /*!< \brief Service start handle. */

#define UART_END_HDL (UART_MAX_HDL - 1) /*!< \brief Service end handle. */



/*! \brief UART Service Handles */

enum { UART_SVC_HDL = UART_START_HDL, /*!< \brief UART service declaration */

       UART_RX_CH_HDL,                /*!< \brief UART rx characteristic */

       UART_RX_HDL,                   /*!< \brief UART rx value */

       UART_TX_CH_HDL,                /*!< \brief UART tx characteristic */

       UART_TX_HDL,                   /*!< \brief UART tx value */

       UART_TX_CH_CCC_HDL,            /*!< \brief UART tx CCCD */

       UART_MAX_HDL                   /*!< \brief Maximum handle. */

};



void UartProcMsg(bleMsg_t *pMsg);

epicardium/drivers/bhi.c

0 → 100644
+566 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/bme680.c

0 → 100644
+208 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/bsec.c

0 → 100644
+461 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/modules/buttons.c→epicardium/drivers/buttons.c

+41 −0

File changed and moved.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/display/api.c

0 → 100644
+383 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/display/epic_ctx.h

0 → 100644
+6 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/display/init.c

0 → 100644
+48 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/display/lcd.c

0 → 100644
+334 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/display/lcd.h

0 → 100644
+17 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/drivers.h

0 → 100644
+104 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/gpio.c

0 → 100644
+152 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/leds.c

0 → 100644
+193 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/modules/max30001.c→epicardium/drivers/max30001.c

+33 −73

File changed and moved.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/max86150.c

0 → 100644
+257 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/meson.build

0 → 100644
+24 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/pmic.c

0 → 100644
+439 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/rng.c

0 → 100644
+97 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/rtc.c

0 → 100644
+129 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/serial.c

0 → 100644
+360 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/sleep.c

0 → 100644
+225 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/modules/usb.c→epicardium/drivers/usb.c

+20 −8

File changed and moved.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/vibra.c

0 → 100644
+52 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/modules/watchdog.c→epicardium/drivers/watchdog.c

+1 −1

File changed and moved.

Preview size limit exceeded, changes collapsed.

epicardium/drivers/ws2812.c

0 → 100644
+85 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/epic_boot.c

0 → 100644
+53 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/epicardium.h

+1153 −110

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/fileops.c→epicardium/fs/fileops.c

+11 −0

File changed and moved.

Preview size limit exceeded, changes collapsed.

epicardium/modules/filesystem.h→epicardium/fs/filesystem.h

+3 −3

File changed and moved.

Contains only whitespace changes.

epicardium/fs/filesystem_fat.c

+26 −51

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/fs/fs_util.c

0 → 100644
+92 −0

File added.

Preview size limit exceeded, changes collapsed.

lib/ff13/util/fs_util.h→epicardium/fs/fs_util.h

+0 −0

File moved.

epicardium/fs/internal.h

+1 −1

File changed.

Contains only whitespace changes.

epicardium/fs/meson.build

0 → 100644
+5 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/l0der/l0der.c

+18 −14

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/main.c

+141 −44

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/meson.build

+22 −3

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/bhi.c

deleted100644 → 0
+0 −499

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/bme680.c

deleted100644 → 0
+0 −175

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/dispatcher.c

deleted100644 → 0
+0 −39

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/display.c

deleted100644 → 0
+0 −212

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/gpio.c

deleted100644 → 0
+0 −112

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/hardware.c

+63 −33

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/hw-lock.c

+22 −57

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/leds.c

deleted100644 → 0
+0 −134

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/log.h

deleted100644 → 0
+0 −59

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/meson.build

+0 −19

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/modules.h

+7 −73

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/personal_state.c

+100 −88

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/pmic.c

deleted100644 → 0
+0 −340

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/rtc.c

deleted100644 → 0
+0 −90

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/serial.c

deleted100644 → 0
+0 −281

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/stream.c

+22 −36

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/stream.h

+19 −5

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/modules/trng.c

deleted100644 → 0
+0 −12

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/modules/vibra.c

deleted100644 → 0
+0 −32

File deleted.

Preview size limit exceeded, changes collapsed.

epicardium/os/config.c

0 → 100644
+666 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/config.h

0 → 100644
+17 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/core.h

0 → 100644
+101 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/modules/log.c→epicardium/os/log.c

+1 −1

File changed and moved.

Preview size limit exceeded, changes collapsed.

epicardium/os/meson.build

0 → 100644
+7 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/mutex.c

0 → 100644
+70 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/mutex.h

0 → 100644
+91 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/panic.c

0 → 100644
+158 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/work_queue.c

0 → 100644
+47 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/os/work_queue.h

0 → 100644
+9 −0

File added.

Preview size limit exceeded, changes collapsed.

epicardium/support.c

+125 −11

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/usb/cdcacm.c

+15 −4

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/usb/epc_usb.c

+20 −20

File changed.

Preview size limit exceeded, changes collapsed.

epicardium/usb/epc_usb.h

+1 −1

File changed.

Contains only whitespace changes.