patch-3 to master · card10 / firmware

Some changes are not shown.

For a faster browsing experience, only 63 of 1000 files are shown. Download one of the files below to see all changes.

.clang

+1 −1

flags = -DBOARD_CARD10=1 -D_FILE_OFFSET_BITS=64 -DTARGET=32665 -DTARGET_REV=0x4131 -Ibuild/../hw-tests/api-demo -Ibuild/hw-tests/api-demo/ -Ibuild/hw-tests/api-demo/53736c5@@api-demo-core0.elf@exe -Ibuild/hw-tests/api-demo/53736c5@@api-demo-core1.elf@exe -Ibuild/../hw-tests/bmatest -Ibuild/hw-tests/bmatest/ -Ibuild/hw-tests/bmatest/9cb7b92@@bmatest.elf@exe -Ibuild/../hw-tests/bmetest -Ibuild/hw-tests/bmetest/ -Ibuild/hw-tests/bmetest/6886391@@bmetest.elf@exe -Ibuild/../hw-tests/dual-core -Ibuild/hw-tests/dual-core/ -Ibuild/hw-tests/dual-core/b5198ad@@dual-core0.elf@exe -Ibuild/hw-tests/dual-core/b5198ad@@dual-core1.elf@exe -Ibuild/../hw-tests/ecgtest -Ibuild/hw-tests/ecgtest/ -Ibuild/hw-tests/ecgtest/8ae72c4@@ecgtest.elf@exe -Ibuild/../hw-tests/hello-freertos -Ibuild/../hw-tests/hello-freertos/./ -Ibuild/hw-tests/hello-freertos/ -Ibuild/hw-tests/hello-freertos/./ -Ibuild/hw-tests/hello-freertos/b7270e9@@freertos-sdk@sta -Ibuild/hw-tests/hello-freertos/b7270e9@@hello-freertos.elf@exe -Ibuild/../hw-tests/hello-world -Ibuild/hw-tests/hello-world/ -Ibuild/hw-tests/hello-world/96b467b@@hello-world.elf@exe -Ibuild/../hw-tests/imutest -Ibuild/hw-tests/imutest/ -Ibuild/hw-tests/imutest/438301c@@imutest.elf@exe -Ibuild/../hw-tests/ips -Ibuild/hw-tests/ips/ -Ibuild/hw-tests/ips/3a8d6c1@@ips.elf@exe -Ibuild/../hw-tests/upy-minimal -Ibuild/hw-tests/upy-minimal/ -Ibuild/hw-tests/upy-minimal/59d35c7@@micropython@sta -Ibuild/hw-tests/upy-minimal/59d35c7@@upy-minimal.elf@exe -Ibuild/../lib/./card10/./ -Ibuild/../lib/card10 -Ibuild/lib/./card10/ -Ibuild/lib/./card10/./ -Ibuild/lib/./card10/7eaaaa5@@card10@sta -Ibuild/../lib/./gfx/./ -Ibuild/../lib/gfx -Ibuild/lib/./gfx/ -Ibuild/lib/./gfx/./ -Ibuild/lib/./gfx/2308dff@@gfx@sta -Ibuild/../lib/./gfx/./Fonts/ -Ibuild/../lib/./gfx/./GUI_DEV/ -Ibuild/../lib/./gfx/./LCD/ -Ibuild/../lib/./micropython/./micropython/ -Ibuild/../lib/./micropython/./micropython/extmod/ -Ibuild/../lib/./micropython/./micropython/lib/utils -Ibuild/../lib/sdk/Libraries/Boards/card10 -Ibuild/lib/./sdk/./Libraries/Boards/card10/ -Ibuild/lib/./sdk/./Libraries/Boards/card10/9eeeac4@@board-card10@sta -Ibuild/../lib/./sdk/./Libraries/Boards/card10/../Include/ -Ibuild/../lib/./sdk/./Libraries/Boards/card10/./Include/ -Ibuild/../lib/sdk/Libraries/CMSIS/Device/Maxim/MAX32665 -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/FreeRTOS/../FreeRTOS-Plus/Source/FreeRTOS-Plus-CLI/ -Ibuild/../lib/./sdk/./Libraries/FreeRTOS/./Source/include/ -Ibuild/../lib/./sdk/./Libraries/FreeRTOS/./Source/portable/GCC/ARM_CM4F/ -Ibuild/../lib/sdk/Libraries/MAX32665PeriphDriver -Ibuild/lib/./sdk/./Libraries/MAX32665PeriphDriver/ -Ibuild/lib/./sdk/./Libraries/MAX32665PeriphDriver/0d96707@@PeriphDriver@sta -Ibuild/../lib/./sdk/./Libraries/MAX32665PeriphDriver/../CMSIS/Device/Maxim/MAX32665/Include/ -Ibuild/../lib/./sdk/./Libraries/MAX32665PeriphDriver/../CMSIS/Include/ -Ibuild/../lib/./sdk/./Libraries/MAX32665PeriphDriver/Include/ -Ibuild/../lib/vendor/Bosch/BHy1 -Ibuild/lib/./vendor/Bosch/BHy1/ -Ibuild/lib/./vendor/Bosch/BHy1/6298ab9@@bhy1@sta -Ibuild/../lib/./vendor/Bosch/BHy1/../../../card10/ -Ibuild/lib/./vendor/Bosch/BHy1/../../../card10/ -Ibuild/../lib/./vendor/Bosch/BHy1/./driver/inc/ -Ibuild/../lib/./vendor/Bosch/BHy1/./examples/firmware/ -Ibuild/../lib/./vendor/Bosch/BMA400/./ -Ibuild/../lib/vendor/Bosch/BMA400 -Ibuild/lib/./vendor/Bosch/BMA400/ -Ibuild/lib/./vendor/Bosch/BMA400/./ -Ibuild/lib/./vendor/Bosch/BMA400/b6b0216@@bma400@sta -Ibuild/../lib/./vendor/Bosch/BME680/./ -Ibuild/../lib/vendor/Bosch/BME680 -Ibuild/lib/./vendor/Bosch/BME680/ -Ibuild/lib/./vendor/Bosch/BME680/./ -Ibuild/lib/./vendor/Bosch/BME680/ef6f079@@bme680@sta -Ibuild/../lib/./vendor/Maxim/MAX77650/./ -Ibuild/../lib/vendor/Maxim/MAX77650 -Ibuild/lib/./vendor/Maxim/MAX77650/ -Ibuild/lib/./vendor/Maxim/MAX77650/./ -Ibuild/lib/./vendor/Maxim/MAX77650/cc369b8@@max77650@sta

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

.clang-tidy

0 → 100644

+34 −0

Original line number	Diff line number	Diff line
		---
		Checks: 'clang-diagnostic-,clang-analyzer-,bugprone-*'
		WarningsAsErrors: ''
		HeaderFilterRegex: ''
		AnalyzeTemporaryDtors: false
		FormatStyle: none
		User: swym
		CheckOptions:
		- key: cert-dcl16-c.NewSuffixes
		value: 'L;LL;LU;LLU'
		- key: cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic
		value: '1'
		- key: google-readability-braces-around-statements.ShortStatementLines
		value: '1'
		- key: google-readability-function-size.StatementThreshold
		value: '800'
		- key: google-readability-namespace-comments.ShortNamespaceLines
		value: '10'
		- key: google-readability-namespace-comments.SpacesBeforeComments
		value: '2'
		- key: modernize-loop-convert.MaxCopySize
		value: '16'
		- key: modernize-loop-convert.MinConfidence
		value: reasonable
		- key: modernize-loop-convert.NamingStyle
		value: CamelCase
		- key: modernize-pass-by-value.IncludeStyle
		value: llvm
		- key: modernize-replace-auto-ptr.IncludeStyle
		value: llvm
		- key: modernize-use-nullptr.NullMacros
		value: 'NULL'
		...

.gitignore

+4 −1

Original line number	Diff line number	Diff line
		build/
		/build/
		/Documentation/output/
		__pycache__/
		*.pyc
		.*.swp
		*~
		compile_commands.json
		/tags
		/release-*/

.gitlab-ci.yml

+51 −13

Original line number	Diff line number	Diff line
		image: "debian"
		# maintained by q3k, built using docker/build-env
		image: "derq3k/card10-build-env:20190806-195837Z-f95b541-dirty"

		build:
		stage: build
		before_script:
		- echo "deb http://deb.debian.org/debian stretch-backports main" >> /etc/apt/sources.list
		- apt update -qq
		- apt install -y -qq gcc-arm-none-eabi python3-pip git
		- apt install -y -qq -t stretch-backports meson
		- pip3 install crc16
		script:
		- ./bootstrap.sh
		- git submodule deinit --all -f
		- ./bootstrap.sh --werror
		- ninja -C build/
		- arm-none-eabi-size build/bootloader/bootloader.elf build/epicardium/epicardium.elf build/pycardium/pycardium.elf
		- cp build/pycardium/pycardium_epicardium.bin card10.bin
		only:
		- merge_requests
		- master
		artifacts:
		expose_as: Firmware Binaries
		expire_in: 1 week
		paths:
		- build/epicardium/epicardium.elf
		- build/pycardium/pycardium.elf
		- card10.bin

		release:
		stage: build
		script:
		- git submodule deinit --all -f
		- ./bootstrap.sh --werror
		- ninja -C build/
		- arm-none-eabi-size build/bootloader/bootloader.elf build/epicardium/epicardium.elf build/pycardium/pycardium.elf
		only:
		- tag
		artifacts:
		expire_in: never
		paths:
		- build/bootloader/bootloader.elf
		- build/epicardium/epicardium.elf
		- build/pycardium/pycardium.elf
		- build/pycardium/pycardium_epicardium.bin

		lint:
		stage: test
		image: "derq3k/card10-lint-env:20190806-201106Z-f95b541-dirty"
		script:
		# Annoyatron is maintained by q3k. Its job is to serve MR comments that are friendlier than just a failing pipeline.
		# source code: https://git.card10.badge.events.ccc.de/q3k/annoyatron/
		# prod deployment: https://gerrit.hackerspace.pl/plugins/gitiles/hscloud/+/refs/heads/master/personal/q3k/annoyatron/
		# If this starts failing for any reason, just remove this curl ping.
		- curl --fail https://annoyatron-prod.q3k.org/ping/mr?mr=${CI_MERGE_REQUEST_IID}
		- git remote rm card10 \|\| true # old gitlab runners might have this remote.
		- git -c http.sslVerify=false fetch https://git.card10.badge.events.ccc.de/card10/firmware.git master:card10/master
		- git merge-base card10/master HEAD \|\| ( echo "Your change needs to be rebased against current master."; exit 1; )
		- git diff --name-only --diff-filter=d card10/master...HEAD \| xargs tools/code-style.sh
		- git diff --exit-code
		only:
		- merge_requests

		pages:
		stage: deploy
		image: ubuntu:bionic
		before_script:
		- apt update -qq
		- apt install -y -qq python3-pip git clang libclang-dev llvm
		- pip3 install sphinx sphinx_rtd_theme clang
		# maintaned by q3k, build using docker/deploy-env
		image: "registry.k0.hswaw.net/q3k/card10-deploy-env:20210403-110003Z-4d929ee0"
		script:
		- export LD_LIBRARY_PATH=$(llvm-config --libdir)
		- echo $LD_LIBRARY_PATH

.gitmodules

+12 −0

Original line number	Diff line number	Diff line
		[submodule "lib/micropython/micropython"]
		path = lib/micropython/micropython
		url = https://github.com/micropython/micropython.git
		[submodule "lib/micropython/micropython-lib"]
		path = lib/micropython/micropython-lib
		url = https://github.com/micropython/micropython-lib.git
		[submodule "lib/crypto/tiny-AES-c"]
		path = lib/crypto/tiny-AES-c
		url = https://github.com/kokke/tiny-AES-c
		[submodule "lib/crypto/SHA256"]
		path = lib/crypto/SHA256
		url = https://github.com/ilvn/SHA256
		[submodule "lib/lodepng/lodepng"]
		path = lib/lodepng/lodepng
		url = https://github.com/lvandeve/lodepng

CHANGELOG.md

0 → 100644

+570 −0

File added.

Preview size limit exceeded, changes collapsed.

COPYING

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		Copyright 2019 card10-firmware contributors

		Permission is hereby granted, free of charge, to any person obtaining a copy of
		this software and associated documentation files (the "Software"), to deal in
		the Software without restriction, including without limitation the rights to
		use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
		of the Software, and to permit persons to whom the Software is furnished to do
		so, subject to the following conditions:

		The above copyright notice and this permission notice shall be included in all
		copies or substantial portions of the Software.

		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
		IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
		FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
		AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
		LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
		OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
		SOFTWARE.

Documentation/bluetooth/card10.rst

0 → 100644

+247 −0

Original line number	Diff line number	Diff line
		.. _bluetooth_card10_service:

		Bluetooth Card10 Service
		========================

		.. warning::
		The specification is still work in progress

		The Card10 Service implemented a direct Hardware access of the card10.

		BLE Service
		-----------

		The current draft uses following service specification:

		- Service

		UUID: ``42230200-2342-2342-2342-234223422342``

		- Time update characteristic:

		UUID: ``42230201-2342-2342-2342-234223422342``
		read and write no response

		- Vibra characteristic:

		UUID: ``4223020f-2342-2342-2342-234223422342``
		write no response

		- Rockets characteristic:

		UUID: ``42230210-2342-2342-2342-234223422342``
		read and write no response

		- Background LED Bottom Left characteristic:

		UUID: ``42230211-2342-2342-2342-234223422342``
		read and write no response

		- Background LED Bottom Right characteristic:

		UUID: ``42230212-2342-2342-2342-234223422342``
		read and write no response

		- Background LED Top Right characteristic:

		UUID: ``42230213-2342-2342-2342-234223422342``
		read and write no response

		- Background LED Top Left characteristic:

		UUID: ``42230214-2342-2342-2342-234223422342``
		read and write no reponse

		- LEDS dim bottom characteristic:

		UUID: ``42230215-2342-2342-2342-234223422342``
		write with response

		- LEDs dim top characteristic:

		UUID: ``42230216-2342-2342-2342-234223422342``
		write with response

		- LEDs powersafe characteristic:

		UUID: ``42230217-2342-2342-2342-234223422342``
		write no response

		- Flashlight characteristic:

		UUID: ``42230218-2342-2342-2342-234223422342``
		write no response

		- Personal State characteristic:

		UUID: ``42230219-2342-2342-2342-234223422342``
		read and write with response

		- LEDs above characteristic:

		UUID: ``42230220-2342-2342-2342-234223422342``
		read and write no reponse

		- Light sensor characteristic:

		UUID: ``422302f0-2342-2342-2342-234223422342``
		read no response

		Time update characteristic
		---------------------------------

		The time update characteristic makes it possible to set and get the current time given in milliseconds after 1.1.1970 in the UTC timezone. The value is represented as a big endian ``uint64``

		- Thu Aug 15 19:40:45 UTC 2019 : ``0x0 0x0 0x1 0x6c 0x96 0xcb 0xf8 0xcc``

		Vibra characteristic
		---------------------------------

		The vibra characteristic makes it possible to let the card10 for given millisecound in a ``uint16`` vibrate.

		- One secound: ``0xe803``

		Rockets characteristic
		---------------------------------

		The Rockets characteristic makes it possible to address every three rockets.
		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:

		======= ======= =======
		0 1 2
		------- ------- -------
		Rocket0 Rocket1 Rocket2
		======= ======= =======

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

		Background LED <Position> characteristic
		----------------------------------------

		The Background LEDs <Position> characteristic makes it possible to address the bottom LEDs by position.
		Just write there three ``uint8`` for the rgb color or read the current value.

		Dataformat:

		===== ======= =======
		0 1 2
		----- ------- -------
		red green blue
		===== ======= =======

		- set led blue: ``0x0000ff``
		- disabled: ``0x000000``

		LEDs dim <Position> characteristic
		----------------------------------

		The LEDs dim <Position> characteristic makes it possible to dim LEDs by position.
		Just write a ``uint8`` between ``1`` and ``8``.

		LEDs powersafe characteristic
		---------------------------------

		This characteristic makes it possible to set the LEDs in powersafe mode.
		Even when set to zero, the RGB LEDs still individually consume ~1mA.
		Powersave intelligently switches the supply power in groups.
		This introduces delays in the magnitude of ~10µs, so it can be disabled for high speed applications such as POV

		- enabled: ``0x01``
		- disabled: ``0x00``

		Flashlight characteristic
		---------------------------------

		This characteristic makes it possible to activate the flashlight.

		- enabled: ``0x01``
		- disabled: ``0x00``

		Personal state characteristic
		---------------------------------
		This characteristic makes it possible to read and write the personal state.
		It writes always as persistant and it gives feedback if the value is in range and your firmware support it.

		- No State ``0x0000``
		- No Contact ``0x0100``
		- Chaos ``0x0200``
		- ...

		LEDs above characteristic
		---------------------------------
		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.

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

		Light sensor characteristic
		---------------------------------

		The light sensor characteristic makes it possible to read the current value of the light sensor by receiving a ``uint16``.
		The range of this sensor is between 0 (``0x0``) and 400 (``0x9001``).

		- reading of ``0x0e00`` means 14

		Access via btgatt-client
		---------------------------------

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

		Example:

		.. code-block::

		# pairing the card10:

		$ bluetoothctl
		[bluetooth]# power on
		[bluetooth]# scan on
		[bluetooth]# pair CA:4D:10:xx:xx:xx #replace xx:xx:xx with scan result
		# if this query doesn't appear, remove and re-pair:
		[agent] Confirm passkey ###### (yes/no): [CHG] Device CA:4D:10:xx:xx:xx Name: card10
		[card10-xxxxxx]# disconnect CA:4D:10:xx:xx:xx

		# using a service:

		$ btgatt-client -d CA:4D:10:xx:xx:xx
		# wait until services have been discovered, may take a minute
		[GATT client]# write-value 0x0926 31 31 31

		# if this error appears remove and re-pair:
		[GATT client]# Device disconnected: Software caused connection abort


		ARM Cordio Sources
		------------------

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

		There are many copies of it floating around on the Internet and some are more up to date than others. To keep track here is a list:
		- mbed
		- mbed has a reasonably up to date version of the stack in their GitHub repository.
		- It is scattered below the CORDIO directories in https://github.com/ARMmbed/mbed-os/tree/master/features/FEATURE_BLE/targets
		- ble-profiles are not included. mbed has written their own adaptation layer to interface with the stack and implements profiles in C++
		- Ambiq Suite SDK
		- Can be found here: https://github.com/sparkfun/AmbiqSuiteSDK/tree/master/third_party/exactle
		- Patches on top might be here: https://support.ambiqmicro.com/hc/en-us/categories/115000239012-Software
		- Reasonably up to date
		- Intersting part: has their own FreeRTOS integration (but apparently on older WSF)
		- BLE 5.1 (?)
		- Packetcraft
		- Apparently tasked with maintaining the stack in general
		- Most up to date version
		- https://github.com/packetcraft-inc/cordio
		- Apparently developing (security) fixes, distributing them to customers, but not applying them to master: https://github.com/ARMmbed/mbed-os/commit/c92777311578eb003b4546c4e5e6f2c1f8ba3c84
		- BLE 5.1
		- Maxim
		- Distributed via Maxim Toolchain Installation tool, no repository available
		- Contains software implementation of the base band
		- ble-host and ble-profiles might be compatible with the one directly from Packetcraft
		- Developing their own low-power enhancements
		- BLE 5.0

Documentation/bluetooth/ecg.rst

0 → 100644

+31 −0

Original line number	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	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

0 → 100644

+193 −0

Original line number	Diff line number	Diff line
		.. _bluetooth_file_transfer:

		Bluetooth File Transfer
		=======================

		.. warning::
		The file transfer specification is still work in progress

		File transfer to the card10 is implemented using the custom Low Effort File
		Transfer Protocol.

		BLE Service
		-----------
		The service consists of two GATT characteristics that act as a bidrectional
		link, similar to many BLE UART implementations. The two channels are seen from
		the Central perspective and hence named Central TX and Central RX.

		The current version uses following service specification:

		- Service

		UUID: 42230100-2342-2342-2342-234223422342

		- Central TX characteristic:

		UUID: 42230101-2342-2342-2342-234223422342
		write

		- Central RX characteristic:

		UUID 42230102-2342-2342-2342-234223422342
		read, notify

		Low Effort File Transfer Protocol
		---------------------------------
		(Version 1)

		This protocol was designed to strike a balance between ease of implementation
		and reasonable levels of functionality.

		Features:

		- File push from Central (e.g. Android) to Peripheral (card10)
		- Path and file name support
		- Chunked data transfer for variable MTUs
		- CRC32 error-detection
		- Basic error handling

		All communication between Central and Peripheral is packet based. The first
		byte specifies the packet type using a char followed by an optional CRC and/or
		payload, depending on the packet type.

		START:

		===== ====
		0 1-N
		----- ----
		s path
		===== ====

		START_ACK:

		===== ===
		0 1-4
		----- ---
		S CRC
		===== ===

		CHUNK:

		===== ====== =======
		0 1-4 4-N
		----- ------ -------
		c offset payload
		===== ====== =======

		CHUNK_ACK:

		===== ===
		0 1-4
		----- ---
		C CRC(*)
		===== ===

		CRC32 of the whole CHUNK packet including first byte, offset and payload.

		FINISH:

		=== ===
		0
		--- ---
		f
		=== ===

		FINISH_ACK:

		=== ===
		0
		--- ---
		F
		=== ===

		ERROR:

		=== ===
		0
		--- ---
		e
		=== ===


		ERROR_ACK:

		=== ===
		0
		--- ---
		E
		=== ===

		Flow
		----

		The file transfer process can be described as a series of states from the view
		of the Central role:


		.. image:: ../static/ble-low-effort-flow.png


		``IDLE`` state:

		- Send ``START`` to initiate transfer

		``START_SENT`` state:

		- Wait for ``START_ACK``

		``SEND_READY`` state:

		- Send first ``CHUNK``

		``CHUNK_SENT`` state:

		- Wait for ``CHUNK_ACK``

		``SEND_READY`` state:

		- Repeat previous two steps until all data is sent
		- If the last chunk was sent, send ``FINISH``

		``FINISH_SENT`` state:

		- Wait for ``FINISH_ACK``

		After ``FINISH_ACK`` was received, the transfer is complete and the process can
		return to ``IDLE``.

		Error Handling
		--------------
		Three types of errors are currently supported:

		- CRC errors:

		If an ``ACK`` packet contains a CRC that fails the verification, then the
		original packet must be retransmitted. If three consecutive attempts to
		send a packet fail, then the transfer is aborted.


		- ACK timeouts:

		If the Central does not receive a required ``ACK`` within 10 seconds, then
		the original packet must be retransmitted. If three consecutive attempts to
		send a packet fail, then the transfer is aborted.


		- Unexpected response:

		All steps in the flow described above have exactly one expected response.
		If any other packet is received, then the transfer is aborted.

		Aborting Transfer
		-----------------
		To abort the transfer, the Central role sends an ``ERROR`` packet and returns
		to ``IDLE`` after receiving the ``ERROR_ACK``.
		If the Peripheral role aborts the transfer, i.e. the Central receives an
		``ERROR`` at any point, then it responds with ``ERROR_ACK`` and returns to
		``IDLE``

		.. warning::
		As this is a custom file transfer protocol developed under less than ideal
		circumstances, it does not provide any guarantees, especially not regarding
		reliability or security. The protocol assumes a secure link and a
		trustworthy peer, amongst many other things. Use with caution.

Documentation/bluetooth/nimble.rst

0 → 100644

+115 −0

Original line number	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	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	Diff line number	Diff line
		@@ -4,3 +4,7 @@ set -e
		cd "$(dirname "$0")"

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

+75 −9

Original line number	Diff line number	Diff line
		@@ -3,6 +3,8 @@ import subprocess
		import sys
		import time
		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,
		# add these directories to sys.path here. If the directory is relative to the
		@@ -13,16 +15,15 @@ sys.path.insert(0, os.path.abspath("./"))

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


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

		project = "card10-firmware"
		copyright = "2019"

		# The full version, including alpha/beta/rc tags
		release = subprocess.check_output(
		["git", "describe", "--long", "--always"]
		).decode().strip()
		release = (
		subprocess.check_output(["git", "describe", "--long", "--always"]).decode().strip()
		)
		release += "<br />"
		release += time.strftime("%F %R")
		version = release
		@@ -47,6 +48,23 @@ todo_include_todos = True
		# This pattern also affects html_static_path and html_extra_path.
		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 ------------------------------------------------- {{{

		# The Read the Docs theme is available from
		@@ -55,11 +73,14 @@ exclude_patterns = ["output", "Thumbs.db", ".DS_Store", "hawkmoth"]
		# - python-sphinx-rtd-theme package (on Debian)
		try:
		import sphinx_rtd_theme

		html_theme = "sphinx_rtd_theme"
		html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
		pygments_style = "monokai"
		except ImportError:
		logger.warning("The Sphinx \"sphinx_rtd_theme\" HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.")
		logger.warning(
		'The Sphinx "sphinx_rtd_theme" HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.'
		)


		# Add any paths that contain custom static files (such as style sheets) here,
		@@ -68,9 +89,7 @@ except ImportError:
		html_static_path = ["static"]

		# Theme Options
		html_theme_options = {
		"style_external_links": True,
		}
		html_theme_options = {"style_external_links": True}

		# Show "Edit on GitLab" links
		html_show_sourcelink = False
		@@ -87,8 +106,19 @@ html_context = {

		# -- Options for Auto-Doc ---------------------------------------------------- {{{
		autodoc_mock_imports = [
		"buttons",
		"interrupt",
		"sys_ble_hid",
		"sys_bme680",
		"sys_bhi160",
		"sys_display",
		"sys_leds",
		"sys_max30001",
		"sys_max86150",
		"sys_png",
		"sys_config",
		"ucollections",
		"uerrno",
		"urandom",
		"utime",
		]
		@@ -101,6 +131,7 @@ has_hawkmoth = False
		try:
		# Attempt importing hawkmoth
		import hawkmoth # noqa: F401

		extensions.append("hawkmoth")

		cautodoc_root = os.path.abspath("..")
		@@ -108,10 +139,45 @@ try:
		has_hawkmoth = True
		except ImportError as e:
		if e.name == "clang":
		logger.warning("hawkmoth requires the clang python module. Documentation for Epicardium API will not be generated.")
		logger.warning(
		"hawkmoth requires the clang python module. Documentation for Epicardium API will not be generated."
		)
		# }}}


		# -- Sphinx Setup ------------------------------------------------------------
		def setup(app):
		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

+48 −16

Original line number	Diff line number	Diff line
		@@ -7,6 +7,36 @@ it. The debugger looks like either one in the following pictures:

		.. image:: static/debuggers.png

		First of all, you need to connect your debugger and card10. There are three
		connections that you need (take a look at the above diagram for more info):

		* ``HDK``: This connection provides debugging (SWD) and UART.
		* ``DEV``: This connection provides power (battery charger) and the native USB
		connection (bootloader).
		* ``USB-C``: Connect the proved USB-C cable with the side which has the blue
		dot, so the blue dots have the same side.

		Console
		-------
		When using the debugger, you will usually have two /dev/ttyACM* devices (one
		each for ``HDK`` and ``DEV``). To avoid confusion, allow access without
		``sudo`` and tell ModemManager to ignore them, you can use the following udev
		rule file (saved under ``/etc/udev/rules.d/99-card10.rules``):

		.. code-block:: text

		SUBSYSTEM=="tty", ATTRS{idVendor}=="0d28", ATTRS{idProduct}=="0204", MODE="0664", GROUP="plugdev", SYMLINK+="ttyACM-card10-hdk", ENV{ID_MM_DEVICE_IGNORE}="1"
		SUBSYSTEM=="tty", ATTRS{idVendor}=="0b6a", ATTRS{idProduct}=="003c", MODE="0664", GROUP="plugdev", SYMLINK+="ttyACM-card10-dev", ENV{ID_MM_DEVICE_IGNORE}="1"

		After changing udev rules, you need to tell the udev daemon:

		.. code-block:: shell-session

		$ sudo udevadm control --reload

		Now, additional symlinks (``/dev/ttyACM-card10-hdk`` and
		``/dev/ttyACM-card10-dev``) will be created when connecting the card10.

		OpenOCD
		-------
		For debugging card10, you need our `own fork`_ of OpenOCD. It contains a patch
		@@ -17,18 +47,22 @@ the following commands:

		.. code-block:: shell-session

		$ git clone https://git.card10.badge.events.ccc.de/card10/openocd.git
		$ git clone --recursive https://git.card10.badge.events.ccc.de/card10/openocd.git
		$ cd openocd

		$ git submodule update --init
		$ ./bootstrap
		$ ./configure --disable-werror
		$ make -j8

		.. warning::
		Make sure ``CMSIS-DAP Compliant Debugger`` is set to yes (auto) after
		running ``./configure`` (if it is not, you might need to install libusb). If
		you get errors making the documentation you can ``touch doc/openocd.info`` to
		skip it and continue with ``make``.
		running ``./configure`` (if it is not, you might need to install ``libhidapi-dev``
		(Ubuntu)). If you get errors making the documentation you can
		``touch doc/openocd.info`` to skip it and continue with ``make``.

		.. code-block:: shell-session

		$ make -j8


		Please run ``make install`` after removing any already installed OpenOCD
		version. Otherwise please always specify the full path to OpenOCD (the binary
		@@ -45,20 +79,12 @@ GDB (``arm-none-eabi-gdb``)
		Apart from OpenOCD you also need ``arm-none-eabi-gdb``. You should install
		that package from your distros repositories:

		* Ubuntu: ``gdb-arm-none-eabi``
		* Ubuntu (older): ``gdb-arm-none-eabi``
		* Ubuntu (newer): ``gdb-multiarch``
		* Arch: ``arm-none-eabi-gdb``

		Debugging
		---------
		First of all, you need to connect your debugger and card10. There are three
		connections that you need (take a look at the above diagram for more info):

		* ``HDK``: This connection provides debugging (SWD) and UART.
		* ``DEV``: This connection provides power (battery charger) and the native USB
		connection (bootloader).
		* ``USB-C``: Connect the proved USB-C cable with the side which has the blue
		dot, so the blue dots have the same side.

		Run OpenOCD from the ``openocd/scripts`` directory in the firmware repository.
		Call it as ``openocd -f interface/cmsis-dap.cfg -f target/max32665.cfg``. If
		the debugger and card10 are connected correctly, you should see the following
		@@ -89,6 +115,12 @@ command to soft-reset card10.
		...
		(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::
		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

Documentation/epicardium-guide.rst

+2 −2

Original line number	Diff line number	Diff line
		@@ -93,8 +93,8 @@ formatted, don't be afraid to do so.

		.. warning::

		When writing you calls, never make assumptions about which FreeRTOS task
		you are running in. While all calls from core 1 will end up in the
		When writing your calls, never make assumptions about which FreeRTOS
		task you are running in. While all calls from core 1 will end up in the
		"Dispatcher" task, other FreeRTOS tasks might might call your code at any
		time just as well.

Documentation/epicardium/api.rst

+2 −0

Original line number	Diff line number	Diff line
		.. _epicardium_api:

		Epicardium API
		==============

Documentation/epicardium/internal.rst

0 → 100644

+8 −0

Original line number	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	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	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	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	Diff line number	Diff line
		0.4
		0.7.0

Documentation/hawkmoth/init.py

+5 −2

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

		for (severity, filename, lineno, msg) in errors:
		if filename:
		toprint = '{}:{}: {}'.format(filename, lineno, msg)
		else:
		toprint = '{}'.format(msg)

		if severity.value <= env.app.verbosity:
		self.logger.log(self._log_lvl[severity], toprint,
		@@ -109,7 +112,7 @@ class CAutoDocDirective(Directive):
		return node.children

		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_compat', None, 'env')
		app.add_config_value('cautodoc_clang', None, 'env')

Documentation/hawkmoth/main.py

+5 −2

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

		for (severity, filename, lineno, msg) in errors:
		if filename:
		print('{}: {}:{}: {}'.format(severity.name,
		filename, lineno, msg), file=sys.stderr)
		else:
		print('{}: {}'.format(severity.name, msg), file=sys.stderr)

		main()

Documentation/hawkmoth/parser.py

+48 −23

Original line number	Diff line number	Diff line
		# 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.
		"""
		Documentation comment extractor
		@@ -34,7 +34,7 @@ Otherwise, documentation comments are passed through verbatim.
		"""

		import enum
		import itertools
		import re
		import sys

		from clang.cindex import CursorKind, TypeKind
		@@ -75,18 +75,22 @@ def comment_extract(tu):
		current_comment = token
		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
		# between comment and the actual cursor being documented
		if (token.cursor.kind == CursorKind.INVALID_FILE or
		token.cursor.kind == CursorKind.TYPE_REF or
		token.cursor.kind == CursorKind.PREPROCESSING_DIRECTIVE or
		token.cursor.kind == CursorKind.MACRO_INSTANTIATION):
		if (token_cursor.kind == CursorKind.INVALID_FILE or
		token_cursor.kind == CursorKind.TYPE_REF or
		token_cursor.kind == CursorKind.PREPROCESSING_DIRECTIVE or
		token_cursor.kind == CursorKind.MACRO_INSTANTIATION):
		continue

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

		cursor = token.cursor
		cursor = token_cursor

		# Note: current_comment may be None
		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:
		return None

		tokens = cursor.get_tokens()

		# Use the first two tokens to make sure this starts with 'IDENTIFIER('
		x = [token for token in itertools.islice(cursor.get_tokens(), 2)]
		if (len(x) != 2 or x[0].spelling != cursor.spelling or
		x[1].spelling != '(' or x[0].extent.end != x[1].extent.start):
		one = next(tokens)
		two = next(tokens, None)
		if two is None or one.extent.end != two.extent.start or two.spelling != '(':
		return None

		# Naïve parsing of macro arguments
		# FIXME: This doesn't handle GCC named vararg extension FOO(vararg...)
		args = []
		for token in itertools.islice(cursor.get_tokens(), 2, None):
		for token in tokens:
		if token.spelling == ')':
		return args
		elif token.spelling == ',':
		@@ -161,8 +167,26 @@ def _recursive_parse(comments, cursor, nest, compat):
		return _result(comment, cursor=cursor, fmt=fmt,
		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
		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,
		nest=nest, name=name, ttype=ttype, compat=compat)
		@@ -188,9 +212,15 @@ def _recursive_parse(comments, cursor, nest, compat):

		# 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,
		nest=nest, name=ttype, compat=compat)
		nest=nest, name=name if name else ttype, compat=compat)

		nest += 1
		for c in cursor.get_children():
		@@ -205,12 +235,6 @@ def _recursive_parse(comments, cursor, nest, compat):
		return _result(comment, cursor=cursor, fmt=fmt,
		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:
		# FIXME: check args against comment
		# FIXME: children may contain extra stuff if the return type is a
		@@ -261,7 +285,8 @@ def clang_diagnostics(errors, diagnostics):
		4: ErrorLevel.ERROR}

		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)])

		# return a list of (comment, metadata) tuples

Documentation/hawkmoth/util/docstr.py

+10 −4

Original line number	Diff line number	Diff line
		# Copyright (c) 2016-2017 Jani Nikula <jani@nikula.org>
		# Copyright (c) 2018-2019 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>
		# Copyright (c) 2016-2020 Jani Nikula <jani@nikula.org>
		# Copyright (c) 2018-2020 Bruno Santos <brunomanuelsantos@tecnico.ulisboa.pt>
		# Licensed under the terms of BSD 2-Clause, see LICENSE for details.
		"""
		Documentation strings manipulation library
		@@ -17,6 +17,9 @@ class Type(Enum):
		TEXT = auto()
		VAR = auto()
		TYPE = auto()
		STRUCT = auto()
		UNION = auto()
		ENUM = auto()
		ENUM_VAL = auto()
		MEMBER = auto()
		MACRO = auto()
		@@ -31,10 +34,13 @@ _doc_fmt = {
		Type.TEXT: (0, '\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.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.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')
		}

Documentation/hawkmoth/util/readthedocs.py

0 → 100644

+25 −0

Original line number	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

+179 −19

Original line number	Diff line number	Diff line
		.. _how_to_build:

		How To Build
		============
		If you just want to write MicroPython code for card10, you probably won't
		need to build the firmware yourself. This page is for people who want to work
		on the underlying firmware itself.
		need to build the firmware yourself. This page is for people **who want to work
		on the underlying firmware itself**.

		Dependencies
		------------
		* gcc, binutils & newlib for ``arm-none-eabi``: The packages have
		slightly different names on different distros.

		- Ubuntu: ``gcc-arm-none-eabi``, ``binutils-arm-none-eabi``, ``libnewlib-arm-none-eabi``
		- Arch: ``arm-none-eabi-gcc``, ``arm-none-eabi-binutils``, ``arm-none-eabi-newlib``
		- Ubuntu / Debian:

		.. code-block:: shell-session

		apt install gcc-arm-none-eabi binutils-arm-none-eabi libnewlib-arm-none-eabi

		- Arch:

		.. code-block:: shell-session

		pacman -S arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib

		- Fedora

		.. code-block:: shell-session

		dnf install arm-none-eabi-gcc arm-none-eabi-binutils arm-none-eabi-newlib

		- macOS (Note: The card10 firmware team used Linux so far. macOS recommendations here are experimental.)

		You can use `Homebrew`_ to install the required tools. The version of the
		ARM crosscompiler tool chain is quite important; with the wrong version,
		e.g. strip and/or ld might throw strange errors.

		.. code-block:: shell-session

		brew tap px4/px4
		brew install px4/px4/gcc-arm-none-eabi-63
		brew install coreutils

		.. _Homebrew: https://brew.sh/

		- Alternative: Download `ARM's GNU toolchain`_. TODO


		* python3: For meson and various scripts needed for building.
		* ninja: Needed for meson.
		* meson (>0.43.0): Unfortunately most distros only have very old versions
		* meson (>0.43.0) & ninja: Unfortunately most distros only have very old versions
		of meson in their repositories. Instead, you'll probably save yourself a lot
		of headaches by installing meson from ``pip3 install --user meson``.
		* python3-crc16: Install with ``pip3 install --user crc16``.
		of headaches by installing meson from pip.

		- Ubuntu / Debian:

		.. code-block:: shell-session

		apt install ninja-build
		pip3 install --user meson

		- Arch (has latest meson in the repos):

		.. code-block:: shell-session

		pacman -S meson

		- macOS

		.. code-block:: shell-session

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

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

		- 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

		.. code-block:: shell-session

		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

		Building
		--------
		Build using the following two commands:
		Cloning
		-------
		Clone the ``master`` branch of the firmware repository:

		.. code-block:: shell-session

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

		Build Configuration
		-------------------
		Initialize the build-system using

		.. code-block:: shell-session

		$ ./bootstrap.sh
		$ ninja -C build/

		``bootstrap.sh`` initializes git submodules and runs meson. Afterwards you
		can build with ninja.
		Additional arguments to ``bootstrap.sh`` will be passed to meson. You can
		use this to for example, to enable one or more of the following optional
		firmware features:

		.. note::
		- ``-Ddebug_prints=true``: Print more verbose debugging log messages
		- ``-Dble_trace=true``: Enable BLE tracing. This will output lots of status
		info related to BLE.
		- ``-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.

		.. warning::

		Our build-system contains a few workarounds around short-comings in meson.
		These workarounds might break on some setups which we did not yet test. If
		@@ -41,13 +144,70 @@ can build with ninja.

		.. _issue tracker: https://git.card10.badge.events.ccc.de/card10/firmware/issues

		If ninja succeeds, the binaries are in ``build/``. They are available in two
		formats: As an ``.elf`` which can be flashed using a debugger and as a
		``.bin`` which can be loaded using the provided bootloader. Here is a list of
		the binaries:
		Building
		--------
		Build using ninja:

		.. code-block:: shell-session

		$ ninja -C build/

		If ninja succeeds, the resulting binaries are in ``build/``. They are
		available in two formats: As an ``.elf`` which can be flashed using a debugger
		and as a ``.bin`` which can be loaded using the provided bootloader. Here is a
		list of the binaries:

		- ``build/bootloader/bootloader.elf``: Our bootloader. It should already be on
		your card10. The bootloader can only be flashed using a debugger.
		- ``build/pycardium/pycardium_epicardium.bin``: The entire firmware in one ``.bin``.
		- ``build/epicardium/epicardium.elf``: The core 0 part of the firmware, called Epicardium.
		- ``build/pycardium/pycardium.elf``: Our MicroPython port, the core 1 part of the firmware.

		In order to do a rebuild you can issue a clean command to ninja via

		.. code-block:: shell-session

		$ ninja -C build/ -t clean

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

		If you try to flash pycardium_epicardium.bin (renamed to card10.bin)
		and the bootloader does not finish updating, the file might be too large.
		~700kB is the normal size, but problems were reported where the file size
		was >1MB. This was caused by the ``tr`` tool in the build process
		(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"
		(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

+9 −26

Original line number	Diff line number	Diff line
		@@ -5,35 +5,18 @@ method of flashing:

		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

		Bootloader
		Jul 12 2019
		USB activated.
		Waiting.

		On your host, you should now see an 8MB flash-device appear. You can now drop
		the firmware's ``.bin`` (from ``build/pycardium/pycardium_epicardium.bin`` in
		most cases) into this flash-storage. You must call the file ``card10.bin``
		for the bootloader to use it.

		Afterwards eject the flash device and reboot card10. You should now see
		your new firmware boot up!
		If you do not have a debugger, you have to update the firmware using our
		bootloader by going into :ref:`usb_file_transfer`.

		.. warning::
		After you get your badge into :ref:`usb_file_transfer`, you can drop the firmware's
		``.bin`` (from ``build/pycardium/pycardium_epicardium.bin`` in most cases) into
		this flash-storage. You must call the file ``card10.bin`` for the
		bootloader to use it.

		You must EJECT the flash device! ``umount`` & ``sync`` is not
		enough and will result in the bootloader not loading the new binary.
		The bootloader will then display ``Writing.`` in red while it is actually
		writing the file to external flash. Please wait until it displays ``Ready.``
		again before resetting card10 by pressing the power button again.

		Flash Using Debugger
		--------------------

Documentation/index.rst

+39 −0

Original line number	Diff line number	Diff line
		@@ -21,22 +21,42 @@ Last but not least, if you want to start hacking the lower-level firmware, the
		:caption: Pycardium

		pycardium/overview
		pycardium/stdlib
		pycardium/bhi160
		pycardium/ble_hid
		pycardium/bme680
		pycardium/max30001
		pycardium/max86150
		pycardium/buttons
		pycardium/color
		pycardium/config
		pycardium/display
		pycardium/gpio
		pycardium/leds
		pycardium/light-sensor
		pycardium/os
		pycardium/personal_state
		pycardium/png
		pycardium/power
		pycardium/pride
		pycardium/simple_menu
		pycardium/utime
		pycardium/vibra
		pycardium/ws2812

		.. toctree::
		:maxdepth: 1
		:caption: Firmware

		overview
		card10-cfg
		usb-file-transfer
		how-to-build
		how-to-flash
		debugger
		pycardium-guide
		memorymap
		epicardium/mutex
		epicardium/sensor-streams

		.. toctree::
		@@ -46,3 +66,22 @@ Last but not least, if you want to start hacking the lower-level firmware, the
		epicardium/overview
		epicardium/api
		epicardium-guide
		epicardium/internal

		.. toctree::
		:maxdepth: 1
		:caption: Bluetooth

		bluetooth/overview
		bluetooth/ess
		bluetooth/file-transfer
		bluetooth/card10
		bluetooth/ecg
		bluetooth/nimble

		Indices and tables
		==================

		* :ref:`genindex`
		* :ref:`modindex`
		* :ref:`search`

Documentation/overview.rst

+55 −23

Original line number	Diff line number	Diff line
		@@ -14,43 +14,75 @@ Epicardium
		Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_. There are a
		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
		statistics that can be gathered from our power manager IC (MAX77650).
		* Serial: Handles serial communication via UART, CDC ACM and possibly
		Bluetooth.
		* BHI160: Housekeeping task for interaction with the `BHI160`_.
		+--------------------+-------------------------------+----------+-------------------------------------------+
		\| Name \| ID Global \| Priority \| Description \|
		+====================+===============================+==========+===========================================+
		\| `vPmicTask`_ \| ``pmic_task_id`` (static) \| +4 \| Power Management (and Reset Button) \|
		+--------------------+-------------------------------+----------+-------------------------------------------+
		\| `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 \|
		+--------------------+-------------------------------+----------+-------------------------------------------+

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

		.. _#23: https://git.card10.badge.events.ccc.de/card10/firmware/issues/23
		.. _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

		Epicardium API
		--------------
		Epicardium exposes lots of functionality via the Epicardium API. The
		technical details if this API can be found in this :ref:`overview
		<epicardium_api_overview>`. If you are interesting in adding new API calls,
		technical details of this API can be found in this :ref:`overview
		<epicardium_api_overview>`. If you are interested in adding new API calls,
		you should probably read the :ref:`epicardium_api_guide` guide.

		Pycardium
		---------

		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
		Pycardium, take a look at the :ref:`pycardium_guide` guide.

		\*cardium
		---------
		.. warning::
		.. _l0dables:

		We have not yet been able to determine if card10 will have had the abilities
		described in this section. And if yes, how they will have been implemented.
		l0dables
		--------

		Next to Pycardium, other bare-metal code can also run on core 1. For example,
		a Rustcardium or Cccardium.
		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
		interface with the :ref:`epicardium_api`.

		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.

		.. _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
		--------------------
		The following diagram is a rough overview of the program flow in this fimware:

		.. image:: ./static/firmware-flow.svg

Documentation/pycardium-guide.rst

+3 −7

Original line number	Diff line number	Diff line
		@@ -40,13 +40,9 @@ the output of
		ls -lh build/pycardium/@@frozen.c@/

		If your module contains some kind of big lookup-table or data-block, consider
		pushing that into external flash.

		.. todo::

		External flash is not yet accessible by Pycardium (ref `#11`_).

		.. _#11: https://git.card10.badge.events.ccc.de/card10/firmware/issues/11
		pushing that into external flash. You can then read the data using standard
		Python ``open()`` and if you need to decode it, use the ``ustruct`` or ``ujson``
		module.

		Creating a new C module
		-----------------------

Documentation/pycardium/bhi160.rst

0 → 100644

+67 −0

Original line number	Diff line number	Diff line
		.. py:module:: bhi160

		``bhi160`` - Sensor Fusion
		==========================

		.. versionadded:: 1.4

		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:

		.. code-block:: python

		import bhi160
		import time

		bhi = bhi160.BHI160Orientation()

		while True:
		samples = bhi.read()
		if len(samples) == 0:
		time.sleep(0.25)
		continue
		# print the latest sample
		print(samples[-1])
		time.sleep(0.25)


		Orientation
		-----------
		.. autoclass:: bhi160.BHI160Orientation
		:members:
		:inherited-members:

		Accelerometer
		-------------
		.. autoclass:: bhi160.BHI160Accelerometer
		:members:
		:inherited-members:

		Gyroscope
		---------
		.. autoclass:: bhi160.BHI160Gyroscope
		:members:
		:inherited-members:

		Magnetometer
		------------
		.. autoclass:: bhi160.BHI160Magnetometer
		:members:
		:inherited-members:

Documentation/pycardium/ble_hid.rst

0 → 100644

+88 −0

Original line number	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

0 → 100644

+111 −0

Original line number	Diff line number	Diff line
		.. py:module:: bme680

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

		.. code-block:: python

		import bme680, time

		with bme680.Bme680() as environment:
		while True:
		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
		------------

		.. autoclass:: bme680.Bme680
		:members:

		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()

		Initialize the sensor.

		Before being able to read data from the sensor, you have to call
		:py:func:`bme680.init`.

		.. versionadded:: 1.4
		.. deprecated:: 1.10
		Use the :py:class:`bme680.Bme680` class instead.

		.. py:function:: get_data()

		Perform a single measurement of environmental data.

		:return: Tuple containing ``temperature`` (°C), ``humidity`` (% r.h.),
		``pressure`` (hPa) and ``gas resistance`` (Ohm).

		.. versionadded:: 1.4
		.. deprecated:: 1.10
		Use the :py:class:`bme680.Bme680` class instead.

		.. py:function:: deinit()

		Deinitialize the sensor.

		.. versionadded:: 1.4
		.. deprecated:: 1.10
		Use the :py:class:`bme680.Bme680` class instead.

Documentation/pycardium/buttons.rst

0 → 100644

+59 −0

Original line number	Diff line number	Diff line
		.. py:module:: buttons

		``buttons`` - Push Buttons
		==========================
		The :py:mod:`buttons` module allows you to use card10's push buttons as input
		in your scripts.

		Example:

		.. code-block:: python

		import buttons

		print("Press bottom left or right button:")

		while True:
		pressed = buttons.read(
		buttons.BOTTOM_LEFT \| buttons.BOTTOM_RIGHT
		)

		if pressed != 0:
		break

		if pressed & buttons.BOTTOM_LEFT != 0:
		print("Left button pressed!")

		if pressed & buttons.BOTTOM_RIGHT != 0:
		print("Right button pressed!")

		.. py:function:: read(mask)

		Read button status.

		:param int mask: Mask of buttons to check. Create the mask by ORing
		:py:data:`buttons.BOTTOM_LEFT`, :py:data:`buttons.BOTTOM_RIGHT`,
		:py:data:`buttons.TOP_RIGHT`, and :py:data:`buttons.TOP_LEFT` (=
		:py:data:`buttons.RESET`).
		:returns: An integer with the bits for pressed buttons set. Use the same
		costants as for the mask to check which buttons were pressed.

		.. py:data:: BOTTOM_LEFT

		Bottom left button.

		.. py:data:: BOTTOM_RIGHT

		Bottom right button.

		.. py:data:: TOP_RIGHT

		Top right button.

		.. py:data:: TOP_LEFT

		Top left button (Reset button).

		.. py:data:: RESET

		Top left button (Reset button).

Documentation/pycardium/color.rst

+622 −149

Original line number	Diff line number	Diff line
		@@ -9,160 +9,633 @@ Color Class

		Constants
		---------

		The color module also contains a few constanst for commonly used colors:

		.. py:data:: color.BLACK
		.. py:data:: color.WHITE
		.. py:data:: color.RED
		.. py:data:: color.GREEN
		.. py:data:: color.YELLOW
		.. py:data:: color.BLUE
		.. py:data:: color.MAGENTA
		.. py:data:: color.CYAN
		Camp Colors
		~~~~~~~~~~~
		.. py:data:: CHAOSBLUE

		.. color-example:: #0076BA

		.. py:data:: CHAOSBLUE_DARK

		.. color-example:: #005383

		.. py:data:: COMMYELLOW

		.. color-example:: #FFC600

		.. py:data:: COMMYELLOW_DARK

		.. color-example:: #D39A00

		.. py:data:: CAMPGREEN

		.. color-example:: #99BA00

		.. py:data:: CAMPGREEN_DARK

		.. color-example:: #6F8700


		General
		~~~~~~~
		.. py:data:: BLACK

		.. color-example:: #000

		.. py:data:: WHITE

		.. color-example:: #fff

		.. py:data:: RED

		.. color-example:: #f00

		.. py:data:: GREEN

		.. color-example:: #0f0

		.. py:data:: YELLOW

		.. color-example:: #ff0

		.. py:data:: BLUE

		.. color-example:: #00f

		.. py:data:: MAGENTA

		.. color-example:: #f0f

		.. py:data:: CYAN

		.. color-example:: #0ff


		.. py:module:: htmlcolor

		``htmlcolor`` - Color Constants
		===============================
		The ``htmlcolor`` module contains even more color constants. Note
		that loading the ``htmlcolor`` module will require ~12K of RAM.

		.. py:data:: htmlcolor.ALICEBLUE
		.. py:data:: htmlcolor.ANTIQUEWHITE
		.. py:data:: htmlcolor.AQUA
		.. py:data:: htmlcolor.AQUAMARINE
		.. py:data:: htmlcolor.AZURE
		.. py:data:: htmlcolor.BEIGE
		.. py:data:: htmlcolor.BISQUE
		.. py:data:: htmlcolor.BLACK
		.. py:data:: htmlcolor.BLANCHEDALMOND
		.. py:data:: htmlcolor.BLUE
		.. py:data:: htmlcolor.BLUEVIOLET
		.. py:data:: htmlcolor.BROWN
		.. py:data:: htmlcolor.BURLYWOOD
		.. py:data:: htmlcolor.CADETBLUE
		.. py:data:: htmlcolor.CHARTREUSE
		.. py:data:: htmlcolor.CHOCOLATE
		.. py:data:: htmlcolor.CORAL
		.. py:data:: htmlcolor.CORNFLOWERBLUE
		.. py:data:: htmlcolor.CORNSILK
		.. py:data:: htmlcolor.CRIMSON
		.. py:data:: htmlcolor.CYAN
		.. py:data:: htmlcolor.DARKBLUE
		.. py:data:: htmlcolor.DARKCYAN
		.. py:data:: htmlcolor.DARKGOLDENROD
		.. py:data:: htmlcolor.DARKGRAY
		.. py:data:: htmlcolor.DARKGREEN
		.. py:data:: htmlcolor.DARKKHAKI
		.. py:data:: htmlcolor.DARKMAGENTA
		.. py:data:: htmlcolor.DARKOLIVEGREEN
		.. py:data:: htmlcolor.DARKORANGE
		.. py:data:: htmlcolor.DARKORCHID
		.. py:data:: htmlcolor.DARKRED
		.. py:data:: htmlcolor.DARKSALMON
		.. py:data:: htmlcolor.DARKSEAGREEN
		.. py:data:: htmlcolor.DARKSLATEBLUE
		.. py:data:: htmlcolor.DARKSLATEGRAY
		.. py:data:: htmlcolor.DARKTURQUOISE
		.. py:data:: htmlcolor.DARKVIOLET
		.. py:data:: htmlcolor.DEEPPINK
		.. py:data:: htmlcolor.DEEPSKYBLUE
		.. py:data:: htmlcolor.DIMGRAY
		.. py:data:: htmlcolor.DODGERBLUE
		.. py:data:: htmlcolor.FIREBRICK
		.. py:data:: htmlcolor.FLORALWHITE
		.. py:data:: htmlcolor.FORESTGREEN
		.. py:data:: htmlcolor.FUCHSIA
		.. py:data:: htmlcolor.GAINSBORO
		.. py:data:: htmlcolor.GHOSTWHITE
		.. py:data:: htmlcolor.GOLD
		.. py:data:: htmlcolor.GOLDENROD
		.. py:data:: htmlcolor.GRAY
		.. py:data:: htmlcolor.GREEN
		.. py:data:: htmlcolor.GREENYELLOW
		.. py:data:: htmlcolor.HONEYDEW
		.. py:data:: htmlcolor.HOTPINK
		.. py:data:: htmlcolor.INDIANRED
		.. py:data:: htmlcolor.INDIGO
		.. py:data:: htmlcolor.IVORY
		.. py:data:: htmlcolor.KHAKI
		.. py:data:: htmlcolor.LAVENDER
		.. py:data:: htmlcolor.LAVENDERBLUSH
		.. py:data:: htmlcolor.LAWNGREEN
		.. py:data:: htmlcolor.LEMONCHIFFON
		.. py:data:: htmlcolor.LIGHTBLUE
		.. py:data:: htmlcolor.LIGHTCORAL
		.. py:data:: htmlcolor.LIGHTCYAN
		.. py:data:: htmlcolor.LIGHTGOLDENRODYELLOW
		.. py:data:: htmlcolor.LIGHTGRAY
		.. py:data:: htmlcolor.LIGHTGREEN
		.. py:data:: htmlcolor.LIGHTPINK
		.. py:data:: htmlcolor.LIGHTSALMON
		.. py:data:: htmlcolor.LIGHTSEAGREEN
		.. py:data:: htmlcolor.LIGHTSKYBLUE
		.. py:data:: htmlcolor.LIGHTSLATEGRAY
		.. py:data:: htmlcolor.LIGHTSTEELBLUE
		.. py:data:: htmlcolor.LIGHTYELLOW
		.. py:data:: htmlcolor.LIME
		.. py:data:: htmlcolor.LIMEGREEN
		.. py:data:: htmlcolor.LINEN
		.. py:data:: htmlcolor.MAGENTA
		.. py:data:: htmlcolor.MAROON
		.. py:data:: htmlcolor.MEDIUMAQUAMARINE
		.. py:data:: htmlcolor.MEDIUMBLUE
		.. py:data:: htmlcolor.MEDIUMORCHID
		.. py:data:: htmlcolor.MEDIUMPURPLE
		.. py:data:: htmlcolor.MEDIUMSEAGREEN
		.. py:data:: htmlcolor.MEDIUMSLATEBLUE
		.. py:data:: htmlcolor.MEDIUMSPRINGGREEN
		.. py:data:: htmlcolor.MEDIUMTURQUOISE
		.. py:data:: htmlcolor.MEDIUMVIOLETRED
		.. py:data:: htmlcolor.MIDNIGHTBLUE
		.. py:data:: htmlcolor.MINTCREAM
		.. py:data:: htmlcolor.MISTYROSE
		.. py:data:: htmlcolor.MOCCASIN
		.. py:data:: htmlcolor.NAVAJOWHITE
		.. py:data:: htmlcolor.NAVY
		.. py:data:: htmlcolor.OLDLACE
		.. py:data:: htmlcolor.OLIVE
		.. py:data:: htmlcolor.OLIVEDRAB
		.. py:data:: htmlcolor.ORANGE
		.. py:data:: htmlcolor.ORANGERED
		.. py:data:: htmlcolor.ORCHID
		.. py:data:: htmlcolor.PALEGOLDENROD
		.. py:data:: htmlcolor.PALEGREEN
		.. py:data:: htmlcolor.PALETURQUOISE
		.. py:data:: htmlcolor.PALEVIOLETRED
		.. py:data:: htmlcolor.PAPAYAWHIP
		.. py:data:: htmlcolor.PEACHPUFF
		.. py:data:: htmlcolor.PERU
		.. py:data:: htmlcolor.PINK
		.. py:data:: htmlcolor.PLUM
		.. py:data:: htmlcolor.POWDERBLUE
		.. py:data:: htmlcolor.PURPLE
		.. py:data:: htmlcolor.RED
		.. py:data:: htmlcolor.ROSYBROWN
		.. py:data:: htmlcolor.ROYALBLUE
		.. py:data:: htmlcolor.SADDLEBROWN
		.. py:data:: htmlcolor.SALMON
		.. py:data:: htmlcolor.SANDYBROWN
		.. py:data:: htmlcolor.SEAGREEN
		.. py:data:: htmlcolor.SEASHELL
		.. py:data:: htmlcolor.SIENNA
		.. py:data:: htmlcolor.SILVER
		.. py:data:: htmlcolor.SKYBLUE
		.. py:data:: htmlcolor.SLATEBLUE
		.. py:data:: htmlcolor.SLATEGRAY
		.. py:data:: htmlcolor.SNOW
		.. py:data:: htmlcolor.SPRINGGREEN
		.. py:data:: htmlcolor.STEELBLUE
		.. py:data:: htmlcolor.TAN
		.. py:data:: htmlcolor.TEAL
		.. py:data:: htmlcolor.THISTLE
		.. py:data:: htmlcolor.TOMATO
		.. py:data:: htmlcolor.TURQUOISE
		.. py:data:: htmlcolor.VIOLET
		.. py:data:: htmlcolor.WHEAT
		.. py:data:: htmlcolor.WHITE
		.. py:data:: htmlcolor.WHITESMOKE
		.. py:data:: htmlcolor.YELLOW
		.. py:data:: htmlcolor.YELLOWGREEN
		.. py:data:: ALICEBLUE

		.. color-example:: aliceblue

		.. py:data:: ANTIQUEWHITE

		.. color-example:: antiquewhite

		.. py:data:: AQUA

		.. color-example:: aqua

		.. py:data:: AQUAMARINE

		.. color-example:: aquamarine

		.. py:data:: AZURE

		.. color-example:: azure

		.. py:data:: BEIGE

		.. color-example:: beige

		.. py:data:: BISQUE

		.. color-example:: bisque

		.. py:data:: BLACK

		.. color-example:: black

		.. py:data:: BLANCHEDALMOND

		.. color-example:: blanchedalmond

		.. py:data:: BLUE

		.. color-example:: blue

		.. py:data:: BLUEVIOLET

		.. color-example:: blueviolet

		.. py:data:: BROWN

		.. color-example:: brown

		.. py:data:: BURLYWOOD

		.. color-example:: burlywood

		.. py:data:: CADETBLUE

		.. color-example:: cadetblue

		.. py:data:: CHARTREUSE

		.. color-example:: chartreuse

		.. py:data:: CHOCOLATE

		.. color-example:: chocolate

		.. py:data:: CORAL

		.. color-example:: coral

		.. py:data:: CORNFLOWERBLUE

		.. color-example:: cornflowerblue

		.. py:data:: CORNSILK

		.. color-example:: cornsilk

		.. py:data:: CRIMSON

		.. color-example:: crimson

		.. py:data:: CYAN

		.. color-example:: cyan

		.. py:data:: DARKBLUE

		.. color-example:: darkblue

		.. py:data:: DARKCYAN

		.. color-example:: darkcyan

		.. py:data:: DARKGOLDENROD

		.. color-example:: darkgoldenrod

		.. py:data:: DARKGRAY

		.. color-example:: darkgray

		.. py:data:: DARKGREEN

		.. color-example:: darkgreen

		.. py:data:: DARKKHAKI

		.. color-example:: darkkhaki

		.. py:data:: DARKMAGENTA

		.. color-example:: darkmagenta

		.. py:data:: DARKOLIVEGREEN

		.. color-example:: darkolivegreen

		.. py:data:: DARKORANGE

		.. color-example:: darkorange

		.. py:data:: DARKORCHID

		.. color-example:: darkorchid

		.. py:data:: DARKRED

		.. color-example:: darkred

		.. py:data:: DARKSALMON

		.. color-example:: darksalmon

		.. py:data:: DARKSEAGREEN

		.. color-example:: darkseagreen

		.. py:data:: DARKSLATEBLUE

		.. color-example:: darkslateblue

		.. py:data:: DARKSLATEGRAY

		.. color-example:: darkslategray

		.. py:data:: DARKTURQUOISE

		.. color-example:: darkturquoise

		.. py:data:: DARKVIOLET

		.. color-example:: darkviolet

		.. py:data:: DEEPPINK

		.. color-example:: deeppink

		.. py:data:: DEEPSKYBLUE

		.. color-example:: deepskyblue

		.. py:data:: DIMGRAY

		.. color-example:: dimgray

		.. py:data:: DODGERBLUE

		.. color-example:: dodgerblue

		.. py:data:: FIREBRICK

		.. color-example:: firebrick

		.. py:data:: FLORALWHITE

		.. color-example:: floralwhite

		.. py:data:: FORESTGREEN

		.. color-example:: forestgreen

		.. py:data:: FUCHSIA

		.. color-example:: fuchsia

		.. py:data:: GAINSBORO

		.. color-example:: gainsboro

		.. py:data:: GHOSTWHITE

		.. color-example:: ghostwhite

		.. py:data:: GOLD

		.. color-example:: gold

		.. py:data:: GOLDENROD

		.. color-example:: goldenrod

		.. py:data:: GRAY

		.. color-example:: gray

		.. py:data:: GREEN

		.. color-example:: green

		.. py:data:: GREENYELLOW

		.. color-example:: greenyellow

		.. py:data:: HONEYDEW

		.. color-example:: honeydew

		.. py:data:: HOTPINK

		.. color-example:: hotpink

		.. py:data:: INDIANRED

		.. color-example:: indianred

		.. py:data:: INDIGO

		.. color-example:: indigo

		.. py:data:: IVORY

		.. color-example:: ivory

		.. py:data:: KHAKI

		.. color-example:: khaki

		.. py:data:: LAVENDER

		.. color-example:: lavender

		.. py:data:: LAVENDERBLUSH

		.. color-example:: lavenderblush

		.. py:data:: LAWNGREEN

		.. color-example:: lawngreen

		.. py:data:: LEMONCHIFFON

		.. color-example:: lemonchiffon

		.. py:data:: LIGHTBLUE

		.. color-example:: lightblue

		.. py:data:: LIGHTCORAL

		.. color-example:: lightcoral

		.. py:data:: LIGHTCYAN

		.. color-example:: lightcyan

		.. py:data:: LIGHTGOLDENRODYELLOW

		.. color-example:: lightgoldenrodyellow

		.. py:data:: LIGHTGRAY

		.. color-example:: lightgray

		.. py:data:: LIGHTGREEN

		.. color-example:: lightgreen

		.. py:data:: LIGHTPINK

		.. color-example:: lightpink

		.. py:data:: LIGHTSALMON

		.. color-example:: lightsalmon

		.. py:data:: LIGHTSEAGREEN

		.. color-example:: lightseagreen

		.. py:data:: LIGHTSKYBLUE

		.. color-example:: lightskyblue

		.. py:data:: LIGHTSLATEGRAY

		.. color-example:: lightslategray

		.. py:data:: LIGHTSTEELBLUE

		.. color-example:: lightsteelblue

		.. py:data:: LIGHTYELLOW

		.. color-example:: lightyellow

		.. py:data:: LIME

		.. color-example:: lime

		.. py:data:: LIMEGREEN

		.. color-example:: limegreen

		.. py:data:: LINEN

		.. color-example:: linen

		.. py:data:: MAGENTA

		.. color-example:: magenta

		.. py:data:: MAROON

		.. color-example:: maroon

		.. py:data:: MEDIUMAQUAMARINE

		.. color-example:: mediumaquamarine

		.. py:data:: MEDIUMBLUE

		.. color-example:: mediumblue

		.. py:data:: MEDIUMORCHID

		.. color-example:: mediumorchid

		.. py:data:: MEDIUMPURPLE

		.. color-example:: mediumpurple

		.. py:data:: MEDIUMSEAGREEN

		.. color-example:: mediumseagreen

		.. py:data:: MEDIUMSLATEBLUE

		.. color-example:: mediumslateblue

		.. py:data:: MEDIUMSPRINGGREEN

		.. color-example:: mediumspringgreen

		.. py:data:: MEDIUMTURQUOISE

		.. color-example:: mediumturquoise

		.. py:data:: MEDIUMVIOLETRED

		.. color-example:: mediumvioletred

		.. py:data:: MIDNIGHTBLUE

		.. color-example:: midnightblue

		.. py:data:: MINTCREAM

		.. color-example:: mintcream

		.. py:data:: MISTYROSE

		.. color-example:: mistyrose

		.. py:data:: MOCCASIN

		.. color-example:: moccasin

		.. py:data:: NAVAJOWHITE

		.. color-example:: navajowhite

		.. py:data:: NAVY

		.. color-example:: navy

		.. py:data:: OLDLACE

		.. color-example:: oldlace

		.. py:data:: OLIVE

		.. color-example:: olive

		.. py:data:: OLIVEDRAB

		.. color-example:: olivedrab

		.. py:data:: ORANGE

		.. color-example:: orange

		.. py:data:: ORANGERED

		.. color-example:: orangered

		.. py:data:: ORCHID

		.. color-example:: orchid

		.. py:data:: PALEGOLDENROD

		.. color-example:: palegoldenrod

		.. py:data:: PALEGREEN

		.. color-example:: palegreen

		.. py:data:: PALETURQUOISE

		.. color-example:: paleturquoise

		.. py:data:: PALEVIOLETRED

		.. color-example:: palevioletred

		.. py:data:: PAPAYAWHIP

		.. color-example:: papayawhip

		.. py:data:: PEACHPUFF

		.. color-example:: peachpuff

		.. py:data:: PERU

		.. color-example:: peru

		.. py:data:: PINK

		.. color-example:: pink

		.. py:data:: PLUM

		.. color-example:: plum

		.. py:data:: POWDERBLUE

		.. color-example:: powderblue

		.. py:data:: PURPLE

		.. color-example:: purple

		.. py:data:: RED

		.. color-example:: red

		.. py:data:: ROSYBROWN

		.. color-example:: rosybrown

		.. py:data:: ROYALBLUE

		.. color-example:: royalblue

		.. py:data:: SADDLEBROWN

		.. color-example:: saddlebrown

		.. py:data:: SALMON

		.. color-example:: salmon

		.. py:data:: SANDYBROWN

		.. color-example:: sandybrown

		.. py:data:: SEAGREEN

		.. color-example:: seagreen

		.. py:data:: SEASHELL

		.. color-example:: seashell

		.. py:data:: SIENNA

		.. color-example:: sienna

		.. py:data:: SILVER

		.. color-example:: silver

		.. py:data:: SKYBLUE

		.. color-example:: skyblue

		.. py:data:: SLATEBLUE

		.. color-example:: slateblue

		.. py:data:: SLATEGRAY

		.. color-example:: slategray

		.. py:data:: SNOW

		.. color-example:: snow

		.. py:data:: SPRINGGREEN

		.. color-example:: springgreen

		.. py:data:: STEELBLUE

		.. color-example:: steelblue

		.. py:data:: TAN

		.. color-example:: tan

		.. py:data:: TEAL

		.. color-example:: teal

		.. py:data:: THISTLE

		.. color-example:: thistle

		.. py:data:: TOMATO

		.. color-example:: tomato

		.. py:data:: TURQUOISE

		.. color-example:: turquoise

		.. py:data:: VIOLET

		.. color-example:: violet

		.. py:data:: WHEAT

		.. color-example:: wheat

		.. py:data:: WHITE

		.. color-example:: white

		.. py:data:: WHITESMOKE

		.. color-example:: whitesmoke

		.. py:data:: YELLOW

		.. color-example:: yellow

		.. py:data:: YELLOWGREEN

		.. color-example:: yellowgreen

Documentation/pycardium/config.rst

0 → 100644

+9 −0

Original line number	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	Diff line number	Diff line
		``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
		:members:

Documentation/pycardium/gpio.rst

0 → 100644

+96 −0

Original line number	Diff line number	Diff line
		.. py:module:: gpio

		``gpio`` - GPIO Pins
		==========================
		The :py:mod:`gpio` module allows you to use card10's GPIO pins as input and
		output in your scripts.

		Example:

		.. code-block:: python

		import gpio

		gpio.set_mode(gpio.WRISTBAND_1, gpio.mode.OUTPUT)
		gpio.write(gpio.WRISTBAND_1, True)

		gpio.set_mode(gpio.WRISTBAND_2, gpio.mode.INPUT \| gpio.mode.PULL_UP)
		state = gpio.read(gpio.WRISTBAND_2)
		print("State of Wristband pin 2:", state)

		.. py:function:: set_mode(pin, mode)

		Configure GPIO pin state.

		: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
		integer by ORing :py:data:`gpio.mode.OUTPUT`, :py:data:`gpio.mode.INPUT`,
		: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)

		Get GPIO pin state.

		:param int pin: ID of the pin of to get the mode of.
		:returns: An integer with the configure mode bits set.

		.. py:function:: write(pin, value)

		Write a value to a GPIO pin.

		:param int pin: ID of the pin of to get the mode of.
		:param bool value: New pin value.

		.. py:function:: read(pin)

		Read GPIO pin value.

		:param int pin: ID of the pin of to get the mode of.
		: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

		Pin ID for Wristband GPIO 1.

		.. py:data:: WRISTBAND_2

		Pin ID for Wristband GPIO 2.

		.. py:data:: WRISTBAND_3

		Pin ID for Wristband GPIO 3.

		.. py:data:: WRISTBAND_4

		Pin ID for Wristband GPIO 4.


		.. py:module:: gpio.mode

		.. py:data:: OUTPUT

		Configures a pin as output.

		.. py:data:: INPUT

		Configures a pin as input.

		.. py:data:: ADC

		Configure pin as ADC input.

		.. versionadded: 1.9

		.. py:data:: PULL_UP

		Enables the internal pull-up resistor of a pin.

		.. py:data:: PULL_DOWN

		Enables the internal pull-down resistor of a pin.

Documentation/pycardium/leds.rst

+9 −33

Original line number	Diff line number	Diff line
		``leds`` - LEDs
		===============
		The ``leds`` module provides functions to interact with card10's RGB LEDs.
		This is the 11 LEDs above the display and 4 LEDs on the underside of the
		top-board, in the four corners.

		.. py:function:: leds.set(led, color)
		.. automodule:: leds
		:members:

		Set one of the card10's RGB LEDs to a certain color.
		``ledfx`` - LED Effects
		=======================

		Example:

		.. code-block:: python

		import leds, color

		# Set all of the top LEDs to red
		for i in range(11):
		leds.set(i, color.RED)

		:param led: Which led to set. 0-10 are the leds on the top
		and 11-14 are the 4 "ambient" leds.
		:param color: What color to set the led to. Should be a
		:py:class:`color.Color` but any list/tuple with 3 elements
		will work just as well.

		.. py:data:: leds.BOTTOM_RIGHT

		Index of the LED in the bottom right of card10.

		.. py:data:: leds.BOTTOM_LEFT

		Index of the LED in the bottom left of card10.

		.. py:data:: leds.TOP_RIGHT

		Index of the LED in the top right of card10.

		.. py:data:: leds.TOP_LEFT

		Index of the LED in the top left of card10.
		.. automodule:: ledfx
		:members:

Documentation/pycardium/light-sensor.rst

+18 −6

Original line number	Diff line number	Diff line
		.. py:module:: light_sensor

		``light_sensor`` - Ambient Brightness
		=====================================
		On the harmonic board, there is an IR-LED which can be used in reverse as a
		crude brightness sensor. Values returned are in no particular unit but seem to
		be fairly stable.

		.. py:function:: light_sensor.start()
		.. py:function:: start()

		Turn on the ADC and start reading brightness values. This function must be
		called before any measurements can be taken.
		Turn on the ADC and start reading brightness values. (In past this function must be
		called before any measurements can be taken.)

		.. py:function:: light_sensor.get_reading()
		.. py:function:: get_reading()

		Get an ambient brightness reading. The returned value is in no particular
		unit, though it seems to be fairly stable. Common values:
		unit, though it seems to be fairly stable. The value could be between 0 and 400. Common values:

		- ~8: Very dark are
		- ~17: Typical hackerspace brightness
		@@ -20,6 +22,16 @@ be fairly stable.

		:returns: A brightness reading in no particular unit

		.. py:function:: light_sensor.stop()
		.. py:function:: stop()

		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/max30001.rst

0 → 100644

+5 −0

Original line number	Diff line number	Diff line
		``max30001`` - MAX30001
		=======================

		.. automodule:: max30001
		:members:

Documentation/pycardium/max86150.rst

0 → 100644

+5 −0

Original line number	Diff line number	Diff line
		``max86150`` - MAX86150
		=======================

		.. automodule:: max86150
		:members:

Documentation/pycardium/os.rst

0 → 100644

+131 −0

Original line number	Diff line number	Diff line
		.. py:module:: os

		``os`` - OS Functions
		=====================
		The ``os`` module allows access to a few core functionalities of Epicardium and
		functions found in CPythons ``os`` module.

		CPython-Like
		------------

		.. py:function:: listdir(dir)

		List contents of a directory.

		:param str dir: Path to the directory to list.
		:returns: A list of entities (files or subdirectories) in the directory
		``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)

		Return ``n`` random bytes.

		.. versionadded:: 1.3

		:param int n: Number of random bytes to retrieve.
		:returns: ``bytes()`` object with ``n`` random bytes.


		Card10-Specific
		---------------

		.. py:function:: exit(ret = None)

		Exit from the current app and return to the menu.


		:param int ret: Optional return code, same semantics as Posix (``0`` means
		success).
		:return: This function will never return.

		.. py:function:: exec(name)

		Try executing a new app, stopping the currently running one.

		``name`` is the path to either a l0dable (ending in ``.elf``) or a python
		script (ending in ``.py``). If the path does not lead to an executable file,
		``os.exec()`` will raise an exception.

		:param str name: Path to new app/script/l0dable.
		:return: This function never returns. It can, however raise an exception.

		.. py:function:: read_battery()

		Read the current battery voltage in V. Please keep in mind that battery
		voltage behaves exponentially when interpreting this value.

		.. warning::

		Card10 will hard-shutdown once the voltage drops below 3.4 V

		.. py:function:: reset()

		Reboot card10.

		.. warning::

		Please only call this function if absolutely necessary. In most cases
		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

+50 −5

Original line number	Diff line number	Diff line
		@@ -33,11 +33,56 @@ systems this device will be called ``/dev/ttyACM0`` or ``/dev/ttyACM1``.
		Choose a terminal-emulator of your liking and open the above mentioned device.
		Baud-rate is 115200. Some options are:

		* screen: ``screen /dev/ttyACM0 115200``
		* picocom: ``picocom -b 115200 /dev/ttyACM0``
		* screen: ``sudo screen /dev/ttyACM0 115200``
		* 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/personal_state.rst

0 → 100644

+74 −0

Original line number	Diff line number	Diff line
		.. py:module:: personal_state

		``personal_state`` - Personal State
		===================================
		The :py:mod:`personal_state` module allows you to set and get the card10 users
		`personal state`_ from your script. The personal state is displayed on the
		top-left LED on the bottom of the harmonics board. While the personal state is
		set the LED can't be controlled by the :py:mod:`leds` module.

		.. _personal state: https://card10.badge.events.ccc.de/ps/

		Example:

		.. code-block:: python

		import personal_state

		# Enable the "camp" state only while the app is running.
		personal_state.set(personal_state.CAMP, False)

		# Enable the "chaos" state and keep it after the app exits.
		personal_state.set(personal_state.CHAOS, True)

		# Query the currently configured state and if it's persistent.
		state, persistent = personal_state.get()

		# Clear the currently configured state
		personal_state.clear()

		.. py:function:: set(state, persistent)

		Set the users personal state.

		:param int state: ID of the personal state to set. Must be one of
		:py:data:`personal_state.NO_CONTACT`, :py:data:`personal_state.CHAOS`,
		:py:data:`personal_state.COMMUNICATION`, :py:data:`personal_state.CAMP`.
		:param int persistent: Controls whether the personal state is persistent. A
		persistent state is not reset when the pycardium application is changed
		or restarted. In persistent mode the personal state LED is not
		controllable by the pycardium application.

		.. py:function:: clear()

		Clears a previously set personal state.

		If no personal state was set this function does nothing. It does not matter
		if a set state is marked as persistent or not.

		.. py:function:: get()

		Get the users personal state.

		:returns: A tuple containing the currently set state and a boolean
		indicating if it's persistent or not.

		.. py:data:: NO_STATE

		State ID reported when no personal state is set.

		.. py:data:: NO_CONTACT

		State ID for the "No Contact" personal state.

		.. py:data:: CHAOS

		State ID for the "Chaos" personal state.

		.. py:data:: COMMUNICATION

		State ID for the "Communicatoin" personal state.

		.. py:data:: CAMP

		State ID for the "Camp" personal state.

Documentation/pycardium/png.rst

0 → 100644

+7 −0

Original line number	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/power.rst

0 → 100644

+61 −0

Original line number	Diff line number	Diff line
		.. py:module:: power

		``power`` - PMIC power module handling
		======================================
		.. versionadded:: 1.4

		The :py:mod:`power` module allows you to read the card10's power status
		in your scripts.

		Example:

		.. code-block:: python

		import power

		print(power.read_battery_voltage())

		.. py:function:: read_battery_voltage()

		Read the battery voltage in V. Please keep in mind that battery
		voltage behaves exponentially when interpreting this value.

		.. warning::

		Card10 will hard-shutdown once the voltage drops below 3.4 V

		.. versionadded:: 1.4

		.. py:function:: read_battery_current()

		Read the battery-side current flow in A.

		.. versionadded:: 1.4

		.. py:function:: read_chargein_voltage()

		Read the charge voltage in V.

		.. versionadded:: 1.4

		.. py:function:: read_chargein_current()

		Read the charge current in A.

		.. versionadded:: 1.4

		.. py:function:: read_system_voltage()

		Read the system-side voltate in V.

		.. versionadded:: 1.4

		.. py:function:: read_thermistor_voltage()

		Read the thermistor voltage in V.

		There is a resistor network from GND over a thermistor
		(10K at room temperature) over 10K to the Thermistor Bias voltage.
		This reads the voltage between thermistor and resistor.

		.. versionadded:: 1.4

Documentation/pycardium/pride.rst

0 → 100644

+7 −0

Original line number	Diff line number	Diff line
		``pride`` - Pride flags
		=======================
		The ``pride`` module provides an easy interface to print pride flags to the top LEDs and the display.

		.. automodule:: pride
		:members:

Documentation/pycardium/simple_menu.rst

0 → 100644

+30 −0

Original line number	Diff line number	Diff line
		``simple_menu`` - Draw a Menu
		=============================
		.. versionadded:: 1.4

		To allow quickly hacking some scripts, Pycardium has a small library for
		displaying menus. You can use it like this:

		.. code-block:: python

		import color
		import simple_menu


		class MyMenu(simple_menu.Menu):
		color_1 = color.CAMPGREEN
		color_2 = color.CAMPGREEN_DARK

		def on_select(self, name, index):
		print("{!r} was selected!".format(name))


		if __name__ == "__main__":
		MyMenu(["foo", "bar", "baz"]).run()

		.. autoclass:: simple_menu.Menu
		:members:

		.. autodata:: simple_menu.TIMEOUT

		.. autofunction:: simple_menu.button_events

Documentation/pycardium/stdlib.rst

0 → 100644

+244 −0

Original line number	Diff line number	Diff line
		MicroPython Standard Library
		============================
		Pycardium contains some modules from the MicroPython standard library.

		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

		``ubinascii``
		-------------
		Refer to the official `MicroPython docs for ubinascii`_.

		.. _MicroPython docs for ubinascii: http://docs.micropython.org/en/latest/library/ubinascii.html

		.. py:module:: ucollections

		``ucollections``
		----------------

		.. py:function:: namedtuple(...)

		See the official `MicroPython docs for namedtuple`_ for details.

		.. _MicroPython docs for namedtuple: http://docs.micropython.org/en/latest/library/ucollections.html#ucollections.namedtuple

		.. py:module:: uerrno

		``uerrno``
		----------
		Refer to the offical `MicroPython docs for uerrno`_.

		.. _MicroPython docs for uerrno: http://docs.micropython.org/en/latest/library/uerrno.html

		.. py:module:: uheapq

		``uheapq``
		----------
		Refer to the offical `MicroPython docs for uheapq`_.

		.. _MicroPython docs for uheapq: http://docs.micropython.org/en/latest/library/uheapq.html

		.. py:module:: uio

		``uio``
		-------
		Refer to the offical `MicroPython docs for uio`_.

		.. _MicroPython docs for uio: http://docs.micropython.org/en/latest/library/uio.html

		.. py:module:: ujson

		``ujson``
		---------
		Refer to the offical `MicroPython docs for ujson`_.

		.. _MicroPython docs for ujson: http://docs.micropython.org/en/latest/library/ujson.html

		.. py:module:: urandom

		``urandom``
		-----------
		Pseudo-random number generator.

		.. py:function:: choice(seq)

		Return a random element from the non-empty sequence ``seq``.

		.. py:function:: getrandbits(k)

		Returns a Python integer with ``k`` random bits.

		.. py:function:: randint(a, b)

		Return a random integer ``N`` such that ``a <= N <= b``. Alias for
		:py:func:`randrange(a, b+1) <urandom.randrange>`.

		.. py:function:: random()

		Return the next random floating point number in the range [0.0, 1.0).

		.. py:function:: randrange(start, stop, [step])

		.. py:function:: randrange(stop)
		:noindex:

		Return a randomly selected element from ``range(start, stop, step)``. This
		is equivalent to ``urandom.choice(range(start, stop, step))``, but doesn’t
		actually build a range object.

		The positional argument pattern matches that of ``range()``. Keyword
		arguments should not be used because the function may use them in unexpected
		ways.

		.. py:function:: seed(n)

		Seed the pseudo-random number generator from ``n``.

		.. note::

		CPython does not provide a :py:func:`seed` function. This is a
		difference in the MicroPython implementation.

		.. py:function:: uniform(a, b)

		Return a random floating point number ``N`` such that ``a <= N <= b`` for
		``a <= b`` and ``b <= N <= a`` for ``b < a``.

		The end-point value ``b`` may or may not be included in the range depending
		on floating-point rounding in the equation ``a + (b-a) * random()``.

		.. py:module:: ure

		``ure``
		-------
		Minimal regular expression library. Refer to the offical `MicroPython docs for ure`_.

		.. _MicroPython docs for ure: http://docs.micropython.org/en/latest/library/ure.html

		.. py:module:: ustruct

		``ustruct``
		-----------
		Refer to the offical `MicroPython docs for ustruct`_.

		.. _MicroPython docs for ustruct: http://docs.micropython.org/en/latest/library/ustruct.html

		``utime``
		---------
		``utime`` contains non-standard functions as well. Please refer to our
		dedicated :py:mod:`utime` docs.


		Python Standard Library
		=======================
		Additionally to the MicroPython module, Pycardium contains a subset of the
		CPython standard library, as implemented by `micropython-lib`_. The following
		modules are included:

		.. _micropython-lib: https://github.com/micropython/micropython-lib

		.. py:module:: collections

		``collections``
		---------------
		Collections module.

		.. py:module:: contextlib

		``contextlib``
		--------------
		Contextlib module.

		.. py:module:: functools

		``functools``
		-------------
		Functools module.

		.. py:module:: itertools

		``itertools``
		-------------
		Itertools module.

		.. warning::

		:py:func:`itertools.tee` is not implemented correctly.

		.. py:module:: string

		``string``
		----------
		String module.

		.. py:module:: struct

		``struct``
		----------
		Struct module.

		.. py:module:: uuid

		``uuid``
		--------

		.. py:class:: UUID(hex=None, bytes=None, int=None, version=None)

		Create a new UUID object.

		Exactly one of ``hex``, ``bytes``, or ``int`` must be given. The
		``version`` argument is optional; if given, the resulting UUID will have its
		variant and version set according to RFC 4122, overriding the given ``hex``,
		``bytes``, or ``int``.

		Examples:

		.. code-block:: python

		UUID('{12345678-1234-5678-1234-567812345678}')
		UUID('12345678123456781234567812345678')
		UUID('urn:uuid:12345678-1234-5678-1234-567812345678')
		UUID(bytes='\x12\x34\x56\x78' * 4)
		UUID(int=0x12345678123456781234567812345678)

		.. versionadded:: 1.10

		.. py:attribute:: bytes

		UUID as ``bytes()`` object

		.. py:attribute:: node

		Node of this UUID

		.. py:attribute:: hex

		Hex-String representation of this UUID

		.. py:attribute:: version

		UUID version accordiung to RFC 4122

		.. py:function:: uuid4()

		Generate a new UUID version 4 (random UUID).

		.. versionadded:: 1.10

Documentation/pycardium/utime.rst

0 → 100644

+168 −0

Original line number	Diff line number	Diff line
		.. py:module:: utime

		``utime`` - Time
		================
		The ``utime`` module loosely follows CPython's \|time\|_ module, but is heavily
		stripped down. Instead, it has a few time related functions which are not in
		CPython but wouldn't fit anywhere else in our implementation. Most
		prominently, this is the :py:func:`utime.alarm` function for setting an RTC
		alarm.

		Like all other u-name modules, ``utime`` can also imported using the standard
		``import time`` statement.

		.. \|time\| replace:: ``time``
		.. _time: https://docs.python.org/3/library/time.html

		.. py:function:: sleep(secs)

		Sleep for ``secs`` seconds. Can take a floating-point value.

		.. py:function:: sleep_ms(msecs)

		Sleep for ``msecs`` milliseconds. Only takes integer values.

		.. py:function:: sleep_us(usecs)

		Sleep for ``usecs`` microseconds. Only takes integer values.

		.. py:function:: time()

		Return the current timestamp in seconds since 2000-01-01 00:00 in
		the local timezone.

		.. py:function:: time_ms()

		Return the current timestamp in milliseconds since 2000-01-01 00:00 in
		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)

		Sets the time to ``secs`` seconds since 2000-01-01 00:00 in the local
		timezone.

		.. versionchanged:: 1.4
		:py:func:`utime.set_time` previously applied a wrong timezone offset,
		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)

		Sets the time to ``secs`` seconds since 1970-01-01 00:00 UTC.
		This corresponds to a regular Unix timestamp which can be obtained
		by running ``date +%s`` in a command line or ``int(time.time())``
		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])

		Return the current time as a timestruct tuple. If ``secs`` is given, return
		its timestruct tuple instead. Timestruct tuple looks like:

		.. code-block:: python

		(year, month, mday, hour, min, sec, wday, yday)
		# 0 1 2 3 4 5 6 7

		.. py:function:: mktime(t)

		Convert timestruct tuple into a seconds time stamp. See
		:py:func:`utime.localtime` for details about timestruct tuples.

		:returns: Seconds since 2000-01-01

		.. py:function:: alarm(secs, [callback])

		Register the next RTC alarm for the timestamp ``secs``. ``secs`` is seconds
		since 2000-01-01.

		If an optional ``callback`` is given, it will be registered for the RTC
		alarm interrupt. This will overwrite any previous interrupt handler. If
		``callback`` is given, :c:func:`utime.alarm` will also enable the RTC alarm
		interrupt.

		Example:

		.. code-block:: python

		import time

		def minute_timer(x):
		current = time.time()
		print("Current: " + str(current))
		alarm = (current // 60 + 1) * 60
		time.alarm(alarm, minute_timer)

		minute_timer(None)

		Alternatively, you can register a callback using the interrupt module and
		then call :py:func:`utime.alarm` without a ``callback`` parameter:

		.. code-block:: python

		import interrupt, time

		def 5_second_timer(x):
		current = time.time()
		print("Current: " + str(current))
		alarm = (current // 10) * 10 + 5
		time.alarm(alarm)

		# This time, we need to register and enable the callback manually
		interrupt.set_callback(interrupt.RTC_ALARM, 5_second_timer)
		interrupt.enable_callback(interrupt.RTC_ALARM)

		5_second_timer(None)

Documentation/pycardium/vibra.rst

+2 −0

Original line number	Diff line number	Diff line
		.. py:module:: vibra

		``vibra`` - Vibration Motor
		===========================

Documentation/pycardium/ws2812.rst

0 → 100644

+35 −0

Original line number	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