diff --git a/.forgejo/workflows/ci.yml b/.forgejo/workflows/ci.yml deleted file mode 100644 index 37d8d2c..0000000 --- a/.forgejo/workflows/ci.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: CI - -on: - push: - branches: [main] - pull_request: - branches: [main] - -concurrency: - group: ci-${{ github.ref }} - cancel-in-progress: true - -jobs: - build: - runs-on: self-hosted - steps: - - uses: actions/checkout@v4 - - - name: Build firmware - run: pio run diff --git a/.forgejo/workflows/release.yml b/.forgejo/workflows/release.yml deleted file mode 100644 index d479aab..0000000 --- a/.forgejo/workflows/release.yml +++ /dev/null @@ -1,77 +0,0 @@ -name: Release - -on: - push: - tags: - - 'v*' - workflow_dispatch: - -jobs: - build: - runs-on: self-hosted - steps: - - uses: actions/checkout@v4 - - - name: Build firmware - run: pio run - - - name: Copy firmware to Android assets - run: bash tools/copy_firmware.sh - - - name: Decode keystore - run: | - mkdir -p android/keystore - echo "${{ secrets.KEYSTORE_B64 }}" | base64 -d > android/keystore/sylda.jks - - - name: Write signing.properties - run: | - cat > android/signing.properties << 'PROPS' - KEYSTORE_PATH=keystore/sylda.jks - KEYSTORE_PASSWORD=${{ secrets.KEYSTORE_PASS }} - KEY_ALIAS=${{ secrets.KEY_ALIAS }} - KEY_PASSWORD=${{ secrets.KEY_PASS }} - PROPS - - - name: Build release APK + AAB - working-directory: android - run: ./gradlew assembleRelease bundleRelease - env: - ANDROID_HOME: ${{ vars.ANDROID_HOME || '/home/linuxbrew/.linuxbrew/share/android-commandlinetools' }} - - - name: Verify version consistency - run: bash tools/check_versions.sh - - - name: Gather release artifacts - run: | - mkdir -p release/artifacts - cp android/app/build/outputs/apk/release/app-release.apk release/artifacts/ - cp android/app/build/outputs/bundle/release/app-release.aab release/artifacts/ - cp android/app/src/main/assets/firmware/server/firmware.bin release/artifacts/server-firmware.bin - cp android/app/src/main/assets/firmware/client/firmware.bin release/artifacts/client-firmware.bin - cd release/artifacts - sha256sum * > checksums.txt - - - name: Create Forgejo release - env: - FORGEJO_TOKEN: ${{ secrets.FORGEJO_TOKEN }} - TAG: ${{ github.ref_name }} - run: | - API="https://git.eddydevink.nl/api/v1/repos/eddy/Project_SylDa/releases" - RELEASE=$(curl -s -X POST \ - -H "Authorization: token $FORGEJO_TOKEN" \ - -H "Content-Type: application/json" \ - -d "{\"tag_name\": \"$TAG\", \"name\": \"$TAG\"}" \ - "$API") - RELEASE_ID=$(echo "$RELEASE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])") - echo "Created release $TAG (id=$RELEASE_ID)" - - for file in release/artifacts/*; do - name=$(basename "$file") - echo "Uploading $name..." - curl -s -X POST \ - -H "Authorization: token $FORGEJO_TOKEN" \ - -H "Content-Type: application/octet-stream" \ - --data-binary "@$file" \ - "$API/$RELEASE_ID/assets?name=$name" > /dev/null - done - echo "Release $TAG published with $(ls release/artifacts | wc -l) assets" diff --git a/.gitignore b/.gitignore index 9338082..a955ae2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,3 @@ -# Generated from version.txt -src/version.h -android/app/src/main/java/nl/eddydevink/sylda/SylDaVersions.kt - # PlatformIO .pio/ .pioenvs/ @@ -23,10 +19,6 @@ local.properties *.ap_ *.dex -# Android signing (contains secrets) -android/keystore/ -android/signing.properties - # OS .DS_Store Thumbs.db @@ -36,29 +28,4 @@ Thumbs.db .idea/ *.swp *.swo -*~ - -# Git worktrees -.worktrees/ - -# Research/documentation (not part of the project code) -appstore.md -codereview.md -DC3-24V*.md -DC3-24V*.pdf -esplibalternatief.md -docs/handleiding.md -release/ -releases/ - -# Test/debug firmware files -src/blink.cpp -src/c1.cpp -src/get_mac.cpp -src/min_cli.cpp -src/min_srv.cpp -src/s1.cpp -src/test_*.cpp - -# Python cache -scripts/__pycache__/ +*~ \ No newline at end of file diff --git a/AGENTS.md b/AGENTS.md deleted file mode 100644 index 6ca0a56..0000000 --- a/AGENTS.md +++ /dev/null @@ -1,50 +0,0 @@ -# Project_SylDa - -M5Stack Atom S3 Lite (ESP32-S3), 2 relais, 2 touch sensors (HS-S43A), BLE, Android app USB OTG. - -## Hardware - -- **Board:** M5Stack Atom S3 Lite (ESP32-S3) -- **Pinnen:** G1=RELAY1, G2=RELAY2, G8=TOUCH1, G6=TOUCH2, G41=BUTTON (active low), G46=LED -- **Touch:** HS-S43A Digital Capacitive Switch Module (openelab.io). **Actief LOW** — pin GND bij aanraking, HIGH bij geen aanraking. Pin mode: `INPUT_PULLUP` (zonder sensor: pin HIGH → `t1Active=true` → `!t1Active=false` → relais UIT). Logica: `relayState = !tActive || btnActive`. **NOOIT de `!` weghalen.** -- **BLE:** "SylDa_Server", service `4fafc201-1fb5-459e-8fcc-c5c9c331914b` -- **BLE cmds:** 0x00=relay1 OFF, 0x01=ON, 0x02=relay2 ON, 0x03=OFF, HMAC_PKT_SIZE=37 (1 cmd + 4 seq + 32 hmac) -- **NVS:** namespace `hmac`, key `key` — HMAC key 32 bytes, NVS op 0x9000-0xDFFF (partitie tabel) - -## Workspace - -`/home/eddy/src/Project_SylDa/` — Atom S3 Lite firmware (server + client) + Android app - -## Firmware — `src/main.cpp` - -- PlatformIO, `platform = espressif32@6.7.0`, board `esp32-s3-devkitc-1` -- CDC USB serial (`ARDUINO_USB_CDC_ON_BOOT=1`), QIO QSPI flash -- **Upload:** `pio run -t upload` (via `--no-stub`). Poort: **NOOIT `/dev/ttyACM0`** (dat is het Atreus toetsenbord). ESP32 herkennen via `ls /dev/serial/by-id/ | grep -i espressif` en die poort gebruiken. PlatformIO: pas `upload_port` in `platformio.ini` aan naar de gevonden poort. -- **Direct flashen (handmatig):** `~/.platformio/packages/tool-esptoolpy/esptool.py --no-stub --chip esp32s3 --port /dev/ttyACM1 --baud 115200 --before default_reset --after hard_reset write_flash --flash_mode keep --flash_size keep 0x0 .pio/build/s3lite-server/bootloader.bin 0x8000 .pio/build/s3lite-server/partitions.bin 0xE000 ~/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin 0x10000 .pio/build/s3lite-server/firmware.bin` -- NVS: namespace "hmac", key "key" (32 bytes HMAC) -- BLE advertising "SylDa_Server", HMAC-verified relay commands - -## Android app — `android/` - -- CDC key exchange (geen FTDI), 2 relay knoppen (touch-to-hold), byte commands -- Key exchange: SettingsActivity via USB CDC (`UsbSerialTransport`) -- Flash: EspFlasher via USB CDC, `eraseFlash()` VERWIJDERD (NVS blijft behouden) -- Partitie layout flash: bootloader 0x0, partitions 0x8000, boot_app0 0xE000, firmware 0x10000 -- BLE scan: 30s timeout, auto-retry 3x, reconnect na disconnect -- `deviceId` = UUID van ESP, `hmacKey` = HMAC key uit key exchange -- Bestanden: `MainActivity.kt`, `SettingsActivity.kt`, `EspFlasher.kt`, `UsbSerialTransport.kt`, `PrefsHelper.kt`, `UsbUtils.kt` -- Assets: `firmware/bootloader.bin`, `partitions.bin`, `boot_app0.bin`, `firmware.bin` - -## Versiebeheer - -- **Single source of truth:** `version.txt` (regels `server=N` en `client=N`) -- `src/version.h` wordt **automatisch gegenereerd** uit `version.txt` door PlatformIO pre-build script -- Nooit `version.h` handmatig bewerken — altijd `version.txt` aanpassen en `pio run` laten regenereren -- Firmwareversie ophogen: bump het nummer in `version.txt`, commit, rebuild firmware, kopieer `.bin` naar Android assets - -## ADB — telefoon - -``` -adb connect 192.168.1.43:5555 -adb -s 192.168.1.43:5555 install -r app/build/outputs/apk/debug/app-debug.apk -``` diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/README.md b/README.md index e647f6b..552b090 100644 --- a/README.md +++ b/README.md @@ -1,504 +1,370 @@ -*Dit project is vibecoded met DeepSeek v4 Pro en OpenCode 1.18.5* +# Sylvia Touch Relay -# Project SylDa +BLE-gestuurde relais-switch voor de M5Stack Atom VoiceS3R (ESP32-S3) met een bijbehorende Android-app. Het relais kan worden bediend via een capacitieve touch-sensor (open-drain) óf via Bluetooth Low Energy vanaf een Android-telefoon. -BLE-gestuurde relais-switch voor de M5Stack Atom S3 Lite (ESP32-S3) met een bijbehorende Android-app. De relais kunnen worden bediend via capacitieve touch-sensoren (HS-S43A) óf via Bluetooth Low Energy vanaf een Android-telefoon. - -De BLE-verbinding is beveiligd met **ECDH (secp256r1) sleuteluitwisseling** en **AES-256-GCM encryptie** (authenticiteit + confidentiality). Een **PSK** (pre-shared key, via USB provisioning) wordt gebruikt voor ECDH pubkey HMAC-verificatie, niet direct voor command authenticatie. Sequence counters bieden replay-protectie. Eerdere versies gebruikten HMAC-SHA256 zonder encryptie — ECDH+AES-GCM is vanaf firmware server v16 / client v3. +De BLE-verbinding is beveiligd met **twee lagen**: BLE Just Works pairing (link-layer encryptie) en **HMAC-SHA256 authenticatie** (application-level handtekening met replay-protectie). ## Hardware | Component | Details | |---|---| -| Relais 1 | Op **G1** | -| Relais 2 | Op **G2** | -| Touch sensor 1 | HS-S43A Digital Capacitive Switch Module op **G8** (actief LOW) | -| Touch sensor 2 | HS-S43A Digital Capacitive Switch Module op **G6** (actief LOW) | -| Knop | Op **G41** (active low, interne Atom S3 Lite knop) | -| Status LED | Op **G35** (WS2812 RGB extern, rood = geen verbinding, geel = verbinding < 60 s, uit = stabiel) | +| Board | M5Stack Atom VoiceS3R (SKU: C126-ECHO) | +| SoC | ESP32-S3-PICO-1-N8R8 (8MB Flash, 8MB PSRAM) | +| Touch sensor | Open-drain sensor op **G38** (3.3V, interne pullup) | +| Relais / LED | Op **G1** (3.3V GPIO output) | +| Status LED | Op **G46** (knippert 3x bij opstarten) | -### Pinout +### Pinout (Atom VoiceS3R onderste header) ``` -G1 = RELAY1 -G2 = RELAY2 -G6 = TOUCH2 (INPUT_PULLUP, actief LOW) -G8 = TOUCH1 (INPUT_PULLUP, actief LOW) -G41 = BUTTON (INPUT, active low) -G35 = LED (WS2812 RGB, OUTPUT) +G38 G39 3.3V GND 5V G5 G6 G7 G8 ``` +- **G38** — Touch sensor input (active LOW, interne pullup ingeschakeld) +- **G1** — Relais output (HIGH = aan, LOW = uit) +- **G46** — Status LED (3x knipperen bij opstarten, daarna uit) + ### Aansluiting ``` -Touch sensor GND → GND -Touch sensor OUT → G8 / G6 -Touch sensor VCC → 3.3V +Sensor GND → GND +Sensor OUT → G38 +Sensor VCC → 3.3V -Relais + → G1 / G2 -Relais - → GND +Relais + → G1 +Relais - → GND ``` -> **HS-S43A touch sensor:** Digitale output (actief LOW — pin naar GND bij aanraking). Gebruik `INPUT_PULLUP` modus. De sensor trekt de pin actief laag bij detectie. - -## LED-signalering - -De LED fungeert als debug-indicator en schakelt uit na 60 seconden stabiele verbinding: - -| State | LED | Prioriteit | -|-------|-----|-----------| -| OTA in progress | Groen knipperend (100 ms) | 1 (hoogst) | -| OTA completed, wacht op confirm | Geel vast | 1 | -| Geen verbinding | Rood | 2 | -| Verbinding actief (< 60 s) | Geel | 3 | -| Verbinding stabiel (>= 60 s) | Uit | 4 (laagst) | -| Relais-flash overlay | Groen 150 ms | overlay | - -De relais-flash toont kort groen bij een verandering in relais-status, waarna de LED terugkeert naar de verbindingskleur. +> **Let op:** De ESP32-S3 interne pullup is ~45kΩ. Bij lange draden of elektrische ruis een externe 4.7kΩ–10kΩ pullup naar 3.3V plaatsen. ## Beveiliging -De relay is beveiligd tegen ongeautoriseerde toegang via ECDH (Elliptic Curve Diffie-Hellman over secp256r1) met AES-256-GCM encryptie op applicatieniveau. +De relay is beveiligd tegen ongeautoriseerde toegang via twee onafhankelijke lagen: -### ECDH + AES-256-GCM +### 1. BLE Just Works Pairing (link-layer encryptie) -- Zowel de firmware als de Android app delen een **32-byte PSK** (pre-shared key), die via USB provisioning op beide apparaten terechtkomt -- Bij BLE-connectie wordt een **ECDH sleuteluitwisseling** uitgevoerd: - 1. Client en server genereren elk een secp256r1 sleutelpaar - 2. Ze sturen hun public key (65 bytes) + HMAC-SHA256(PSK, public key) (32 bytes) naar elkaar (**ECDH packet: 97 bytes**) - 3. De ontvanger verifieert de HMAC met de PSK — ongeautoriseerde apparaten worden hier al geweerd - 4. Uit de eigen private key + peer public key wordt een shared secret berekend - 5. `SHA-256(shared secret)` levert de **AES-256 sleutel** op -- Elk relay-commando wordt daarna versleuteld met **AES-256-GCM** (authenticity + confidentiality) -- Een **sequence counter** (uint32, big-endian) voorkomt replay-aanvallen: elk packet moet een strikt oplopend volgnummer hebben -- GCM biedt zowel encryptie als integriteitsverificatie (AEAD) +- De ESP32 vereist **bonding** voordat de characteristic geschreven kan worden +- IO capability: `ESP_IO_CAP_NONE` (Just Works — geen passcode nodig) +- Authentication mode: `ESP_LE_AUTH_REQ_SC_BOND` (LE Secure Connections met bonding) +- De characteristic heeft `ESP_GATT_PERM_WRITE_ENCRYPTED` — writes worden alleen geaccepteerd over een versleutelde link +- Na de eerste keer paren onthoudt de telefoon de bonding; bij herverbinding wordt de link automatisch versleuteld -#### AES-GCM packet formaat (29 bytes) +### 2. HMAC-SHA256 Authenticatie (application-level) + +Omdat BLE Just Works geen MITM-bescherming biedt, is er een tweede laag toegevoegd: + +- Zowel de ESP firmware als de Android app delen een **32-byte shared secret** (HMAC key), die via USB provisioning op beide apparaten terechtkomt +- Elk commando wordt ondertekend met `HMAC-SHA256(key, command || sequence)` +- De ESP verifieert de handtekening voordat het relais schakelt +- Een **sequence counter** voorkomt replay-aanvallen: elk packet moet een strikt oplopend volgnummer hebben + +#### Packet formaat (37 bytes) ``` -Offset Grootte Veld Beschrijving -0 4 bytes sequence Big-endian uint32, strikt oplopend (start bij 1) -4 8 bytes nonce Random nonce voor AES-GCM -12 1 byte ciphertext 1 byte plaintext (command), versleuteld -13 16 bytes tag GCM authenticatie-tag +Offset Grootte Veld Beschrijving +0 1 byte command 0x01 = relais aan, 0x00 = relais uit +1 4 bytes sequence Big-endian uint32, strikt oplopend (start bij 1) +5 32 bytes hmac HMAC-SHA256(key, command || sequence) ``` -#### ECDH packet formaat (97 bytes) +De sequence counter reset naar 0 bij elke (re)connectie op de ESP. De app start bij 1 om te zorgen dat het eerste packet altijd geaccepteerd wordt (`1 > 0`). Replay van een eerder packet wordt geweerd omdat `seq <= lastSeq`. + +#### Key management + +- De HMAC key wordt **niet meegecompileerd** — de ESP start zonder key en wordt geprovisioneerd via USB +- De key wordt opgeslagen in **NVS** (Non-Volatile Storage) op de ESP via de Arduino `Preferences` library (survives reboots en power-cycles) +- De app slaat de key op in **SharedPreferences** (overleeft app-herstarts) +- **USB auto-provisioning:** Sluit de ESP via USB-OTG aan op de telefoon. De app stuurt `KEY?\n`: + - Als de ESP al een key heeft → ESP antwoordt `HMAC_KEY:` → app slaat op lokaal op + - Als de ESP nog geen key heeft → ESP antwoordt `NO_KEY` → app genereert willekeurige 32-byte key via `SecureRandom` → stuurt `SET_KEY:\n` → ESP slaat op in NVS en antwoordt `OK` → app slaat op lokaal op + - Beide paden tonen dezelfde toast: **"Beveiligingssleutel gelezen"** +- Handmatige invoer: via het instellingenscherm in de Android app (64-teken hex string) +- Zo kan dezelfde app gebruikt worden voor meerdere ESP modules — each met een eigen key + +#### USB Serial Protocol ``` -Offset Grootte Veld Beschrijving -0 65 bytes public key Uncompressed secp256r1 public key -65 32 bytes hmac HMAC-SHA256(PSK, public key) +App → ESP: KEY?\n +ESP → App: HMAC_KEY:C3F17B...AF\n (als key bekend) +ESP → App: NO_KEY\n (als ESP nog geen key heeft) + +App → ESP: SET_KEY:C3F17B...AF\n (nieuwe key schrijven) +ESP → App: OK\n (bevestiging) ``` -#### Commando codes +De ESP luistert in `loop()` voor USB serial data. Bij `KEY?\n` antwoordt hij met de hex key (`HMAC_KEY:`) of `NO_KEY`. Bij `SET_KEY:<64-hex>\n` slaat hij de key op in NVS en antwoordt `OK`. De Android `UsbKeyReceiver` (manifest-geregistreerde `BroadcastReceiver`) vangt `USB_DEVICE_ATTACHED` op, filtert op Espressif (vendor 0x303a), vraagt USB-permission, opent een CDC-ACM serial connectie, en handelt het hele provisioning-proces automatisch af. + +#### Provisioning flow (auto) ``` -0x00 = relay1 OFF -0x01 = relay1 ON -0x02 = relay2 ON -0x03 = relay2 OFF + Android app ESP32 (USB CDC) + ─────────── ─────────────── + USB device attached ──────────► + Request USB permission ◄────── Android dialog + Open CDC-ACM connection + Send KEY?\n ──────────────────► + ┌─ if key in NVS ──► HMAC_KEY:\n + │ App saves to prefs → toast + │ + └─ if no key ──────► NO_KEY\n + Generate 32 random bytes │ + Send SET_KEY:\n ─────────► (store in NVS) + ◄──────────────────────────── OK\n + App saves to prefs → toast ``` -De sequence counter reset naar 0 bij elke (re)connectie op de module. De app start bij 1 om te zorgen dat het eerste packet altijd geaccepteerd wordt (`1 > 0`). De sequence counter wordt gepersisteerd in SharedPreferences en overleeft app-herstarts. - -### Key management - -- De PSK wordt **niet meegecompileerd** — de module start zonder key en wordt geprovisioneerd via USB -- De PSK en device UUID worden opgeslagen in **NVS** (namespace `syl`, keys `psk` en `uuid`, partitie op 0x9000-0xDFFF) -- De app slaat PSK, device UUID, server UUID en client UUID op in **SharedPreferences** -- **USB provisioning:** Open Instellingen → Module bijwerken. De app checkt eerst de firmware versie (`VERSION?`) en flasht indien nodig. Na het flashen (of als versie al actueel is) volgt automatisch de key exchange: - - Als de module al keys heeft → module antwoordt `DEVICE_ID:` en `PSK:` → app slaat lokaal op - - Als de module nog geen keys heeft → module antwoordt `NO_KEY` → app genereert willekeurige 32-byte PSK via `SecureRandom` → stuurt `SET_KEY:\n`, `SET_ID:\n`, en voor client devices `SET_SERVER:\n` → module slaat op in NVS → app slaat lokaal op - -### USB Serial Protocol - -``` -App → module: VERSION?\n -module → App: BUILD_NR:\n (firmware versie check) - -App → module: ID?\n -module → App: SylDa_Server\n of SylDa_Client\n (device type) - -App → module: KEY?\n -module → App: DEVICE_ID:\n (module UUID, 16 bytes = 32 hex) -module → App: PSK:\n (PSK, 32 bytes = 64 hex) -module → App: SERVER_UUID:\n (alleen client: opgeslagen server UUID, 32 hex) -module → App: NO_KEY\n (als module nog geen key heeft) - -App → module: SET_KEY:\n (nieuwe PSK schrijven, 64 hex) -module → App: OK\n - -App → module: SET_ID:\n (UUID schrijven, 32 hex) -module → App: OK\n - -App → module: SET_SERVER:\n (server UUID voor client, 32 hex) -module → App: OK\n -``` - -### Multi-client ondersteuning - -De server ondersteunt tot **2 gelijktijdige BLE-clients** (MAX_CLIENTS 2). Elke client krijgt een onafhankelijke ECDH-handshake, AES-sleutel en sequence counter. Relais-commando's van alle clients worden gecombineerd: een relais gaat aan als minimaal één client het aan-commando stuurt (OR-logica). +De `UsbKeyReceiver` doet dit op een achtergrondthread met max 5 retries (1s pauze) om andere USB-apps te overleven die mogelijk het apparaat tijdelijk claimen. ### Beveiligingsanalyse | Aanval | Hoe geweerd | |---|---| -| **Replay** | Sequence counter — zelfde packet werkt niet 2× (`seq <= lastSeq` geweerd) | -| **Ongeautoriseerd device** | ECDH pubkey HMAC vereist PSK — verkeerde PSK = afgewezen public key | -| **BLE spoofing (client)** | Client gebruikt service UUID + manufacturer data voor scanning, full 16-byte UUID + ECDH PSK-HMAC voor verificatie na connect. 4-byte manufacturer data scan-filter (2^32 combinaties) kan tot onnodige connectiepogingen leiden — deze falen alsnog bij 16-byte UUID check of ECDH handshake. Voorheen (issue #10) werd alleen op naam "SylDa_Server" gescant zonder verdere verificatie. | -| **Commando vervalsing** | AES-GCM versleutelt en authenticeert command byte + nonce — wijzigen maakt tag ongeldig | -| **Afluisteren** | AES-256-GCM biedt confidentiality — commando's zijn onleesbaar zonder AES-sleutel | -| **Brute-force PSK** | 32-byte PSK = 2^256 mogelijkheden — onhaalbaar | -| **Reverse engineering van PSK** | PSK staat niet in de APK — wordt pas bij USB provisioning gegenereerd en in SharedPreferences opgeslagen. | -| **PSK extractie via USB** | `KEY?\n` geeft de huidige PSK terug. Fysieke USB-toegang is nodig — bescherm het board. | -| **NVS wiping** | `pio run -t erase` wist alle flash waaronder NVS — module start daarna zonder keys. | - -### Firmware (OTA via BLE) - -De firmware kan **over-the-air** worden geüpdatet via BLE (zonder USB): - -1. De app scant en verbindt zoals normaal -2. Instellingen → Module bijwerken (Server mode + BLE transport) -3. De app leest de `VERSION` characteristic — als de versie actueel is, wordt overgeslagen -4. Firmware wordt in **500-byte chunks** verzonden via de `OTA` characteristic (WRITE_NR + NOTIFY) -5. Elke chunk krijgt een ACK/NAK response -6. Na alle chunks wordt de SHA-256 hash van de ontvangen firmware geverifieerd -7. Bij match: `0xFF` confirmatie → `esp_ota_set_boot_partition` → module reboot met nieuwe firmware -8. 10-seconden timeout op 0xFF confirm — geen confirm = update wordt weggegooid - -Tijdens OTA zijn relais geforceerd UIT en knippert de LED groen. Na afloop (wachtend op confirm) is de LED geel. +| **Sniffen** | BLE link encrypted (AES-CCM via Just Works) | +| **Replay** | Sequence counter — zelfde packet werkt niet 2x | +| **Ongeautoriseerd device** | HMAC vereist geheime sleutel | +| **MITM** | Just Works is kwetsbaar voor MITM; HMAC maakt actieve MITM wel moeilijk (aanvaller moet de key kennen) | +| **Reverse engineering van key** | Sleutel staat niet in de APK — wordt pas bij USB provisioning gegenereerd en in SharedPreferences opgeslagen. Extractie vereist fysieke toegang tot de telefoon én root. | +| **Key extractie via USB** | Fysieke USB-toegang tot de ESP geeft `KEY?\n` de huidige key terug. Bescherming: fysieke toegang tot het board beperken. | +| **NVS wiping** | `pio run -t erase` wist alle flash waaronder NVS — ESP is daarna leeg en kan opnieuw geprovisioneerd worden. | ## Firmware -De firmware is geschreven in C++ met PlatformIO en de Arduino-framework. BLE: ESP32 NimBLE library, crypto: mbedtls (ingebouwd in ESP-IDF). - -| Environment | Bronbestand | Rol | -|---|---|---| -| `s3lite-server` | `src/main.cpp` | Ontvangt BLE-verbindingen, bedient relais | -| `s3lite-client` | `src/client.cpp` | Verbindt als BLE-central met server, stuurt relais-commando's | - -Firmwareversies: `version.txt` (single source of truth) → `src/version.h` (gegenereerd door `tools/pio_version_pre.py`) + `SylDaVersions.kt` (Android). Versiebeheer via `tools/check_versions.sh`. +De firmware is geschreven in C++ met behulp van PlatformIO en de Arduino-framework. BLE wordt verzorgd door de ESP32 BLE library, HMAC door mbedtls (ingebouwd in ESP-IDF). ### Logica -Elk relais gaat aan als **één van beide** bronnen actief is: +Het relais gaat aan als **één van beide** bronnen actief is: -| Relais | Bron | Voorwaarde | Resultaat | -|---|---|---|---| -| Relais 1 | Touch sensor 1 | G8 = LOW (aanraken, actief LOW) | Relais 1 aan | -| Relais 1 | BLE/AES command | App stuurt AES-GCM `0x01` | Relais 1 aan | -| Relais 1 | BLE/AES command (client) | Client stuurt AES-GCM `0x01` | Relais 1 aan | -| Relais 1 | Interne knop (G41) | Knop ingedrukt (LOW) | Relais 1 aan | -| Relais 2 | Touch sensor 2 | G6 = LOW (aanraken, actief LOW) | Relais 2 aan | -| Relais 2 | BLE/AES command | App stuurt AES-GCM `0x02` | Relais 2 aan | -| Relais 2 | BLE/AES command (client) | Client stuurt AES-GCM `0x02` | Relais 2 aan | -| Beide | Geen van beide | Geen touch + geen BLE command | Relais uit | +| Bron | Voorwaarde | Resultaat | +|---|---|---| +| Touch sensor | G38 = LOW (aanraken) | Relais aan | +| BLE command | App stuurt HMAC-ondertekend `0x01` | Relais aan | +| Geen van beide | G38 = HIGH + geen BLE command | Relais uit | -De touch sensoren, BLE, en interne knop werken onafhankelijk (OR-logica). De interne knop (G41) activeert alleen relais 1. Bij meerdere BLE-clients worden hun commando's samengevoegd. +De touch sensor en BLE werken onafzankelijk. Als de sensor losgelaten wordt en de BLE-knop niet ingedrukt is, gaat het relais uit. ### BLE GATT -| Eigenschap | UUID | Properties | Beschrijving | -|---|---|---|---| -| Service | `4fafc201-1fb5-459e-8fcc-c5c9c331914b` | — | SylDa service | -| Relay | `beb5483e-36e1-4688-b7f5-ea07361f26d8` | WRITE_NR | AES-GCM relay commands (29 bytes) | -| UUID | `beb5483e-36e1-4688-b7f5-ea07361f26d9` | READ | Device UUID (16 bytes) | -| VERSION | `beb5483e-36e1-4688-b7f5-ea07361f26db` | READ | Firmware versie string | -| OTA | `beb5483e-36e1-4688-b7f5-ea07361f26da` | WRITE_NR, NOTIFY | BLE OTA firmware update | -| ECDH | `beb5483e-36e1-4688-b7f5-ea07361f26dc` | WRITE_NR, NOTIFY | ECDH sleuteluitwisseling | +| Eigenschap | UUID | +|---|---| +| Service | `4fafc201-1fb5-459e-8fcc-c5c9c331914b` | +| Characteristic | `beb5483e-36e1-4688-b7f5-ea07361f26d8` | + +De characteristic ondersteunt `WRITE` (encrypted) en `NOTIFY`. Writes vereisen een versleutelde link (bonding) plus HMAC-authenticatie. ### Key provisioning -De firmware wordt zonder PSK gecompileerd. Bij de eerste opstart print de module: +De firmware wordt zonder HMAC key gecompileerd. Bij de eerste opstart print de ESP: ``` -No PSK — connect USB and run SET_KEY +No HMAC key provisioned — connect USB and run SET_KEY ``` -Sluit de module via USB aan op de telefoon met de app geïnstalleerd. De app genereert automatisch een willekeurige PSK en stuurt deze naar de module. Na provisioning print de module bij opstarten: +Sluit de ESP via USB aan op de telefoon met de app geinstalleerd. De app genereert automatisch een willekeurige key en stuurt deze naar de ESP. Na provisioning print de ESP bij opstarten: ``` -PSK loaded from NVS +HMAC key loaded from NVS +HMAC Key: C3F17B...AF ``` -**Key wissen (factory reset):** `pio run -t erase` wist alle flash inclusief NVS. +**Key wissen (factory reset):** Om de ESP terug te zetten naar ongeprovisioneerd: + +```bash +pio run -t erase +``` + +Dit wist alle flash inclusief NVS. Na opnieuw flashen start de ESP weer zonder key. ### Serial monitor -Baudrate: **115200** (USB CDC). De firmware stuurt heartbeats elke 60 seconden, logt statuswijzigingen, en print de PSK-status bij opstarten. +Baudrate: **115200** (USB CDC). De firmware stuurt heartbeat-statussen elke 5 seconden, logt statuswijzigingen, en print de HMAC key (of de afwezigheid ervan) bij opstarten. -**Met geprovisioneerde PSK (server):** +**Met geprovisioneerde key:** ``` -=== AtomS3 Lite BLE Relay v20 === -PSK loaded from NVS -BLE: advertising started +=== Atom VoiceS3R BLE Relay === +HMAC key loaded from NVS +LED blink done, starting BLE... +BLE: advertising started as 'AtomS3R-Relay' +HMAC Key: C3F17B612B93E82C56B055FA9B04E84664ACE1EC4E889F2763F271B65A5B54AF Setup done. -Relays: R1=ON R2=OFF (t1=YES t2=no btn=no ble1=OFF ble2=OFF) -[heartbeat] R1=ON R2=OFF t1=YES t2=no btn=no ble1=OFF ble2=OFF clients=1 +[heartbeat] relay=OFF touch=no ble=disconnected +BLE: device connected +Relay ON (touch=YES, ble=connected) +BLE: relay ON (seq=1) +BLE: relay OFF (seq=2) ``` -**Zonder PSK (nieuwe/gewiste module):** +**Zonder key (nieuwe/gewiste ESP):** ``` -=== AtomS3 Lite BLE Relay v20 === -No PSK — connect USB and run SET_KEY -BLE: advertising started -No PSK — use USB SET_KEY to provision +=== Atom VoiceS3R BLE Relay === +No HMAC key provisioned — connect USB and run SET_KEY +LED blink done, starting BLE... +BLE: advertising started as 'AtomS3R-Relay' +No HMAC key — use USB SET_KEY to provision Setup done. ``` -**Client firmware log (geprovisioneerd):** -``` -=== SylDa Client v5 === -PSK loaded from NVS -UUID loaded from NVS -BLE: scanning... -BLE: connected to xx:xx:xx:xx:xx:xx -[hb] t1=no t2=no btn=no r1=OFF r2=OFF conn=yes ecdh=yes -``` +In deze staat accepteert de ESP wel BLE-verbindingen, maar elk HMAC-packet faalt verificatie omdat er geen key is om mee te vergelijken. ### Uploaden -> **Download-mode:** Houd de reset-knop ~2 seconden ingedrukt tot de groene LED aangaat, laat dan los. +> **Download-mode:** Houd de reset-knop ~2 seconden ingedrukt tot de groene LED aangaat, laat dan los. Het board is nu in download-mode. ```bash -# Flash server firmware (behoudt NVS/PSK) -pio run -e s3lite-server --target upload +# Flash firmware (behoudt NVS/key) +pio run --target upload -# Flash client firmware (behoudt NVS/PSK) -pio run -e s3lite-client --target upload - -# Volledig wissen (incl. NVS/PSK) + opnieuw flashen -pio run -t erase && pio run -e s3lite-server --target upload +# Volledig wissen (incl. NVS/key) + opnieuw flashen +pio run -t erase && pio run -t upload ``` -De upload port wordt automatisch gedetecteerd door `tools/pio_upload_port.py` (post-build script). Deze script zoekt de ESP32 via `ID?` over de seriële poort en past `upload_port` aan in `platformio.ini`. - -**Direct flashen (handmatig):** -```bash -~/.platformio/packages/tool-esptoolpy/esptool.py --no-stub --chip esp32s3 --port /dev/ttyACM1 --baud 115200 --before default_reset --after hard_reset write_flash --flash_mode keep --flash_size keep 0x0 .pio/build/s3lite-server/bootloader.bin 0x8000 .pio/build/s3lite-server/partitions.bin 0xE000 ~/.platformio/packages/framework-arduinoespressif32/tools/partitions/boot_app0.bin 0x10000 .pio/build/s3lite-server/firmware.bin -``` - -### Firmware flashen via de app - -De firmware kan rechtstreeks via de Android-app worden geflashed (USB) of geüpdatet (BLE OTA): - -1. Sluit de module via USB-OTG aan op de telefoon (USB) of zorg dat deze verbonden is via BLE (OTA) -2. Open de app → Instellingen -3. Kies **Device Mode** (Server/Client) en **Transport Mode** (BLE/USB) -4. Tik op **Module bijwerken** -5. **USB transport:** App checkt versie, flasht bootloader/partitions/firmware indien verouderd, wisselt daarna PSK uit -6. **BLE transport (alleen server mode):** App checkt VERSION characteristic, voert OTA update uit zonder USB - -Firmware binaries: `tools/copy_firmware.sh` kopieert `.bin` bestanden naar `assets/firmware/server/` en `assets/firmware/client/`. +Na het uploaden treedt er een harde reset op. Als het board in download-mode blijft, USB eruit/erin of kort op reset tikken om in run-mode te komen. ## Android App ### Features -- **Auto-connect:** Scant bij opstarten naar BLE service UUID `4fafc201-1fb5-459e-8fcc-c5c9c331914b` ("SylDa_Server") -- **Manufacturer data matching:** Scant op manufacturer ID 0xFFFF die de eerste 4 bytes van de device UUID bevat — directe UUID-match bij scan -- **Device UUID verificatie:** Leest `UUID_CHAR_UUID` en vergelijkt met opgeslagen UUID — alleen correcte apparaten worden geaccepteerd -- **Firmware versie check:** Bij connect wordt VERSION characteristic gelezen — toont "Update beschikbaar" als app-versie nieuwer is -- **Auto-reconnect:** Bij wegvallen verbinding na 2 seconden opnieuw scannen -- **Scan retry:** Bij timeout 3× automatisch herhalen, daarna "Opnieuw zoeken" knop -- **Hold-to-activate:** Knop ingedrukt = relais aan, loslaten = relais uit -- **Twee onafhankelijke relais:** Twee knoppen, elk met eigen AES-GCM commando -- **Write Without Response:** `WRITE_TYPE_NO_RESPONSE` voor minimale latency -- **MTU negotiatie:** Vraagt MTU 512 aan na service discovery -- **ECDH + AES-256-GCM:** ECDH sleuteluitwisseling bij connectie, daarna AES-GCM encryptie voor elk commando -- **BLE OTA update:** Firmware updaten via BLE zonder USB (server mode + BLE transport) -- **Key exchange geïntegreerd:** Module bijwerken = versie check → flashen (indien nodig) → PSK-uitwisseling — volledig automatisch -- **Thema-selector:** Instellingen → Weergave met Systeem, Licht of Donker -- **Permissies:** Vraagt BLUETOOTH_SCAN en BLUETOOTH_CONNECT. Bij weigeren wordt verwezen naar Instellingen +- **Auto-connect:** De app scant automatisch bij opstarten naar het BLE-apparaat "AtomS3R-Relay" +- **Auto-reconnect:** Bij wegvallen van de verbinding wordt na 2 seconden opnieuw gescant +- **Hold-to-activate:** Houd de knop ingedrukt voor relais aan, loslaten voor relais uit (zelfde gedrag als de sensor) +- **BLE Pairing:** De app initieert bonding (`createBond()`) na connectie; Just Works pairing verloopt zonder gebruikersinteractie +- **MTU negotiatie:** Vraagt MTU 256 aan na service discovery (voor 37-byte HMAC packets) +- **HMAC authenticatie:** Elk commando wordt ondertekend met HMAC-SHA256 + sequence counter +- **USB auto-provisioning:** Bij aansluiten van de ESP via USB-OTG leest de app de bestaande key uit, of genereert een nieuwe key als de ESP er nog geen heeft. Beide scenario's tonen de toast _"Beveiligingssleutel gelezen"_ (BroadcastReceiver, werkt ook als app niet actief is) +- **Instellingenscherm:** Losse Activity voor het invoeren van de HMAC key (met oog-icoon om de key te tonen/verbergen), "Scan & Verbind" knop, en hint-tekst +- **Permissies:** Vraagt BLUETOOTH_SCAN, BLUETOOTH_CONNECT en ACCESS_FINE_LOCATION aan (Android 12+) ### Instellingenscherm -1. Open de app → tik op **instellingen** (tandwiel-icoon rechtsboven) -2. **Device Mode:** Kies Server of Client (bepaalt welke firmware wordt geflashed / provisioning flow) -3. **Transport Mode:** Kies BLE of USB (bepaalt hoe firmware wordt geüpdatet: OTA via BLE of USB flash) -4. **Module bijwerken:** Versie check → flash/OTA → PSK-uitwisseling — één knop voor de hele flow -5. **Weergave:** Kies Systeem (volgt telefoon), Licht of Donker -6. **Relais labels:** Stel eigen namen in voor de twee relais knoppen +1. Open de app +2. Tik op het **tandwiel-icoon** rechtsboven +3. De app toont een hint: _"Voer de HMAC sleutel in of sluit de relaismodule aan op de telefoon."_ +4. **Optie A — handmatig:** Voer de 64-teken hex key in. Tik op het **oog-icoon** om de key te tonen/verbergen. Tik **Opslaan**. +5. **Optie B — automatisch (aanbevolen):** Sluit de ESP via USB-OTG aan op de telefoon. Android vraagt USB-toestemming (1x). De app leest de key uit (als de ESP er al een heeft) of genereert een nieuwe key en provisioneert de ESP. Toast: _"Beveiligingssleutel gelezen"_. +6. Tik **Scan & Verbind** om op te slaan en direct BLE scannen te starten. -De PSK en UUIDs worden opgeslagen in SharedPreferences en overleven app-herstarts. Bij geen PSK toont de hoofdapp "Geen sleutel — open Instellingen". +De key wordt opgeslagen in SharedPreferences en overleeft app-herstarts. Bij geen key toont de hoofdapp "Geen HMAC sleutel - open Instellingen" en wordt er niet gescant. ### Hoofdscherm UI -- **instellingen** tekst + tandwiel-icoon rechtsboven → opent instellingenscherm -- **Twee knoppen** in het midden → hold-to-activate voor relais 1 en 2 (labels aanpasbaar) +- **Tandwiel-icoon** rechtsboven → opent instellingenscherm +- **HOLD-knop** centrum → houd ingedrukt voor relais aan - **Status tekst** linksonder (14sp) → toont verbindingsstatus ### Bouwen Vereisten: - Android SDK (API 34+) -- Java 17 target (JDK 21 voor Gradle — Java 26 werkt niet) -- Gradle 8.14 (via wrapper) -- AGP 8.5.2, Kotlin 2.0.21 (K2 compiler) -- USB host support (raw Android USB API, geen externe serial library) -- PlatformIO (voor firmware compilatie) +- Java 17+ (Java 26 werkt niet met Gradle 8.5 — gebruik Java 21) +- Gradle 8.2.2 (via wrapper) +- USB host support (raw Android USB API, geen externe library) ```bash -# Firmware compileren en naar app assets kopiëren -pio run -bash tools/copy_firmware.sh - -# App bouwen en installeren cd android -JAVA_HOME=/home/linuxbrew/.linuxbrew/opt/openjdk@21/libexec ./gradlew installDebug +JAVA_HOME=/pad/naar/jdk21 ./gradlew assembleDebug ``` -APK: `android/app/build/outputs/apk/debug/app-debug.apk`. +De APK staat na build in `android/app/build/outputs/apk/debug/app-debug.apk`. ### Installeren ```bash -adb -s :5555 install -r android/app/build/outputs/apk/debug/app-debug.apk +adb install -r android/app/build/outputs/apk/debug/app-debug.apk +``` + +Of via draadloze foutopsporing: + +```bash +adb connect : +adb install -r android/app/build/outputs/apk/debug/app-debug.apk ``` ## Eerste keer setup -1. **App op de telefoon installeren:** +1. **Flash de ESP:** ```bash - cd android - JAVA_HOME=/home/linuxbrew/.linuxbrew/opt/openjdk@21/libexec ./gradlew installDebug + pio run -t upload ``` -2. **Firmware flashen & sleutel uitwisselen (één flow):** - - Sluit de module via USB-OTG aan op de telefoon - - Open de app → Instellingen → kies Device Mode (Server/Client) → kies Transport (USB) → Module bijwerken - - De app checkt versie, flasht indien nodig, en wisselt PSK uit — volledig automatisch +2. **Installeer de app op de telefoon:** + ```bash + adb install -r android/app/build/outputs/apk/debug/app-debug.apk + ``` -3. **Gebruiken:** De app scant automatisch, verbindt, en toont "Verbonden". Houd een knop ingedrukt om het relais te schakelen. +3. **Provision de HMAC key (kies één):** -### Nieuwe module, bestaande telefoon + **Optie A — USB auto-provisioning (aanbevolen):** + - Sluit de ESP via USB-OTG aan op de telefoon + - Android vraagt USB-toestemming (1x) — tik "Toestaan" + - De app detecteert dat de ESP geen key heeft, genereert er één, en stuurt deze naar de ESP + - Toast: _"Beveiligingssleutel gelezen"_ + - Ontkoppel de ESP en zet hem op stroom -- Sluit nieuwe module via USB aan → Instellingen → Module bijwerken → app flasht en provisioneert + **Optie B — handmatig:** + - Open de app → tandwiel-icoon → voer een 64-teken hex key in → Opslaan + - Let op: de ESP moet dan dezelfde key hebben (via USB provisioning of handmatig via serial `SET_KEY:\n`) -### Bestaande module, nieuwe telefoon + **Optie C — bestand ESP, nieuwe telefoon:** + - Sluit de ESP via USB-OTG aan op de nieuwe telefoon + - De app leest de bestaande key uit de ESP en slaat lokaal op + - Toast: _"Beveiligingssleutel gelezen"_ -- Sluit module via USB-OTG aan op nieuwe telefoon → Instellingen → Module bijwerken → app leest bestaande PSK uit (antwoordt `PSK:`) + **Nieuwe ESP, bestaande telefoon:** + - Wis de app data (instellingen → apps → Atom Relay → storage → clear) of de-installeer en herinstalleer + - Sluit de nieuwe ESP via USB aan → app genereert nieuwe key + - Let op: de oude key in de app wordt overschreven + +4. **Scan & Verbind:** Tik in instellingen op "Scan & Verbind" (of de app scant automatisch bij terugkeren naar het hoofdscherm) + +5. De app scant, paart (Just Works), en verbindt. Houd de HOLD-knop ingedrukt om het relais te schakelen. ## Projectstructuur ``` -Project_SylDa/ -├── platformio.ini # PlatformIO configuratie (ESP32-S3, server + client) -├── version.txt # Single source of truth voor firmwareversies -├── icon.png / icon.svg # Project icon +sylvia-touch-relay/ +├── platformio.ini # PlatformIO configuratie (ESP32-S3) ├── src/ -│ ├── main.cpp # Server firmware (BLE + ECDH/AES + NVS + USB + touch + relais + OTA) -│ ├── client.cpp # Client firmware (BLE central + ECDH/AES + touch + relais) -│ ├── ecdh_helper.h # ECDH crypto helper (secp256r1, AES-sleutel afleiding, pubkey HMAC) -│ └── version.h # Auto-gegenereerd uit version.txt — niet handmatig bewerken -├── tools/ -│ ├── copy_firmware.sh # Kopieert firmware binaries naar Android app assets -│ ├── pio_version_pre.py # PlatformIO pre-build script (genereert version.h) -│ ├── pio_upload_port.py # PlatformIO post-build script (auto-detecteert upload port) -│ ├── check_versions.sh # Valideert version.txt vs version.h vs SylDaVersions.kt -│ └── test_ota_notify.py # Test BLE OTA notificatie flow -├── scripts/ -│ └── release.sh # Release automatisering: firmware + APK/AAB + Forgejo release +│ └── main.cpp # Firmware (BLE + HMAC + NVS key storage + USB serial + sensor + relais) ├── android/ -│ ├── build.gradle # Root Gradle config -│ ├── settings.gradle # Gradle settings +│ ├── build.gradle # Root Gradle config +│ ├── settings.gradle # Gradle settings │ ├── gradle.properties -│ ├── gradlew # Gradle wrapper +│ ├── gradlew # Gradle wrapper +│ ├── gradle/wrapper/ +│ │ └── gradle-wrapper.properties │ └── app/ -│ ├── build.gradle # App module (nl.eddydevink.sylda, minSdk 26) +│ ├── build.gradle # App module config │ └── src/main/ │ ├── AndroidManifest.xml -│ ├── assets/firmware/ -│ │ ├── server/ -│ │ │ ├── bootloader.bin -│ │ │ ├── partitions.bin -│ │ │ ├── firmware.bin -│ │ │ └── boot_app0.bin -│ │ └── client/ -│ │ ├── bootloader.bin -│ │ ├── partitions.bin -│ │ ├── firmware.bin -│ │ └── boot_app0.bin -│ ├── java/nl/eddydevink/sylda/ -│ │ ├── MainActivity.kt -│ │ ├── SettingsActivity.kt -│ │ ├── BleRelayManager.kt -│ │ ├── BleStatus.kt -│ │ ├── EspFlasher.kt -│ │ ├── OtaManager.kt -│ │ ├── SylDaVersions.kt -│ │ ├── UsbSerialTransport.kt -│ │ ├── UsbUtils.kt -│ │ └── PrefsHelper.kt -│ ├── res/ -│ │ ├── drawable/ -│ │ │ └── ic_settings.xml -│ │ ├── layout/ -│ │ │ ├── activity_main.xml -│ │ │ ├── activity_settings.xml -│ │ │ ├── dialog_waiting.xml -│ │ │ └── dialog_progress.xml -│ │ ├── values/strings.xml -│ │ └── xml/ -│ │ └── device_filter.xml -├── docs/ # Documentatie (handleiding, ontwerpplannen) -├── release/ # Release artifacts +│ ├── java/com/eddy/atomrelay/ +│ │ ├── MainActivity.kt # BLE client + HMAC signing +│ │ ├── SettingsActivity.kt # HMAC key invoer + scan knop +│ │ └── UsbKeyReceiver.kt # USB key provisioning (raw USB API) +│ └── res/ +│ ├── drawable/ +│ │ ├── ic_eye_open.xml # Oog open icoon +│ │ ├── ic_eye_closed.xml # Oog dicht icoon +│ │ └── ic_settings.xml # Tandwiel icoon +│ ├── layout/ +│ │ ├── activity_main.xml # Hoofd UI (FrameLayout) +│ │ └── activity_settings.xml # Key invoer + scan UI +│ └── values/strings.xml ├── .gitignore -├── LICENSE └── README.md ``` -## Ontwerpbeslissingen - -### WRITE_TYPE_NO_RESPONSE (geen BLE write ACK) - -De app gebruikt `WRITE_TYPE_NO_RESPONSE` in plaats van `WRITE_TYPE_DEFAULT`. Eerdere versies gebruikten ACK's, maar de BLE write acknowledgement duurde lang genoeg dat de gebruiker de knop kon loslaten vóór de ACK arriveerde. Als `ACTION_UP` plaatsvond tijdens een pending write, werd het loslaten genegeerd en bleven relais en app hangen in ON-status. `WRITE_TYPE_NO_RESPONSE` verwijdert die latency en maakt directe ON→OFF sequenties mogelijk. - -### compileSdk/targetSdk 34 (niet 35 / Android 15) - -De doelgroep (lichamelijk gehandicapte gebruikers) is terughoudend met telefoonupdates. API 34 (Android 14) maximaliseert compatibiliteit. Heroverweeg bij voldoende migratie. - -### Thema-selector en DayNight - -`Theme.AppCompat.DayNight` met 3 opties: Systeem, Licht, Donker. Android's `sp`-eenheden en hoog-contrast modus (Android 13+) volstaan voor visueel beperkte gebruikers — eigen implementatie zou onnodige complexiteit toevoegen. - -### ECDH + AES-256-GCM i.p.v. HMAC-only - -HMAC-SHA256 (vroegere versies) bood authenticatie maar geen confidentiality. ECDH+AES-GCM voegt encryptie toe zonder de complexiteit van BLE-link bonding (die Android sliding bugs veroorzaakt: write queues, `GATT_INSUFFICIENT_AUTHENTICATION`). De PSK wordt alleen gebruikt voor ECDH pubkey HMAC-verificatie — daarna is alle communicatie versleuteld met afgeleide AES-256-GCM sleutels. GCM is AEAD: één operatie voor zowel encryptie als authenticatie. - ## Technische notities -- De Atom S3 Lite heeft GPIO G1, G2, G5-G8, G38, G39 beschikbaar op de headers. G41 is de interne knop (active low). G35 wordt gebruikt voor een externe WS2812 LED (niet de interne G46 SK6812). -- G1 en G2 zitten op de HY2.0-4P Grove poort. G5-G8, G38, G39 op de onderste expansie-header. -- De firmware gebruikt geen M5Unified library — alleen Arduino core + ESP32 NimBLE + mbedtls + FastLED. +- De Atom VoiceS3R gebruikt de ES8311 audio codec op G45/G0/G48/G4/G3/G17/G11, IR TX op G47, en de knop op G41. Deze pinnen zijn niet beschikbaar voor eigen gebruik. +- G1 en G2 zitten op de HY2.0-4P Grove poort. G5-G8, G38, G39 zitten op de onderste expantie-header. +- De firmware gebruikt geen M5Unified library — alleen Arduino core + ESP32 BLE + mbedtls. Dit maakt de serial output betrouwbaarder via USB CDC. - `ARDUINO_USB_CDC_ON_BOOT=1` is ingeschakeld voor virtuele serial via USB. -- NVS: namespace `syl`, PSK in key `psk`, UUID in key `uuid`, server UUID in key `server`, BLE-adres in key `addr`. Partitie op 0x9000-0xDFFF. -- `pio run -t erase` wist alle NVS. `tools/pio_upload_port.py` auto-detecteert de upload port via `ID?` query. -- Firmwareversies: `version.txt` → `src/version.h` (gegenereerd) + `SylDaVersions.kt` (Android). `tools/check_versions.sh` valideert consistentie. -- De app gebruikt raw Android USB API (`UsbDeviceConnection.bulkTransfer`) — geen externe serial library. -- `minSdk` is 26 (Android 8.0). `compileSdk`/`targetSdk` blijft op 34. -- Sequence counters starten bij 1 (niet 0), wrappen bij 1.000.000. -- BLE MTU: server stelt 248 in (ESP32 NimBLE limiet), app vraagt 512. OTA/ECDH chunks passen zich aan aan `negotiatedMtu - 7`. -- Server krijgt maximaal 2 gelijktijdige BLE-clients. Client slaat server BLE-adres op in NVS voor snelle reconnect (valt terug op scan als adres niet werkt). -- Server advertising bevat manufacturer data (0xFFFF) met eerste 4 bytes van device UUID voor snelle identificatie. -- OTA: 500-byte chunks (aangepast aan MTU), 3 retries per chunk, SHA-256 hash verificatie, 10s 0xFF confirm timeout. - -## Release - -```bash -# Volledige release (firmware + APK + AAB + Forgejo) -bash scripts/release.sh -``` - -Deze script: -1. Compileert server + client firmware (`pio run`) -2. Kopieert firmware naar Android assets (`copy_firmware.sh`) -3. Bouwt release APK + AAB (`gradlew assembleRelease assembleAndroidTest bundleRelease`) -4. Publiceert de release op Forgejo (met APK/AAB als attachments) - -## Licentie - -**GNU General Public License v3.0 or later** (GPL-3.0-or-later). - -Vereist omdat de app [`esp32-flash-lib`](https://github.com/dkaukov/esp32-flash) (GPL-3.0) gebruikt voor ESP32 firmware flashing. Zie het `LICENSE` bestand. +- De HMAC key wordt opgeslagen in NVS (Non-Volatile Storage) via de Arduino `Preferences` library. De key wordt niet meegecompileerd maar via USB provisioning door de Android app op de ESP gezet. Sleuteloverdracht werkt in beide richtingen: de app kan een key naar de ESP schrijven (nieuwe ESP) of een bestaande key uitlezen (bestaande ESP op nieuwe telefoon). +- De app gebruikt `WRITE_TYPE_NO_RESPONSE` voor minimale latency — de encryptie en HMAC verificatie gebeuren op de link layer resp. application layer en zijn onafhankelijk van het write type. +- De sequence counter start bij 1 (niet 0) om te voorkomen dat het eerste packet na connectie als replay wordt geweerd (`0 <= 0` is true in de `seq <= lastSeq` check). +- Für meerdere ESP modules met verschillende keys: sluit elke ESP één voor één aan op de telefoon. De app genereert per ESP een eigen key en slaat deze op. De app ondersteunt momenteel slechts één key tegelijk (opgeslagen in SharedPreferences). Bij wisselen van ESP: wis app data of sluit de nieuwe ESP aan (overschrijft vorige key). +- De `UsbKeyReceiver` is een manifest-geregistreerde `BroadcastReceiver` voor `ACTION_USB_DEVICE_ATTACHED`. Hij filtert op Espressif (vendor 0x303a), vraagt USB-permission via `PendingIntent` (FLAG_MUTABLE voor Android 12+), opent een CDC-ACM serial connectie met raw USB API (geen externe library), configureert CDC control interface (line coding + DTR/RTS), en handelt het volledige provisioning-proces af. Werkt ook als de app niet actief is. +- De `UsbKeyReceiver` gebruikt raw Android USB API (`UsbDeviceConnection.bulkTransfer`) in plaats van een externe serial library. Dit vermijdt compatibiliteitsproblemen met de ESP32-S3 USB-JTAG/serial controller die geen CDC `get_status` requests ondersteunt. +- CDC control interface setup: line coding (115200 8N1) via SET_LINE_CODING request + DTR/RTS via SET_CONTROL_LINE_STATE. Dit activeert de data-flow op de ESP32-S3 CDC-ACM interface voordat commando's worden gestuurd. +- De `UsbKeyReceiver` doet serial I/O op een achtergrondthread (max 5s timeout per poging, 5 retries met 1s pauze) om ANR's te voorkomen en andere USB-apps te overleven die mogelijk het apparaat tijdelijk claimen. +- Bij elke retry wordt het ESP-apparaat opnieuw opgezocht via `UsbManager.deviceList` om apparaat-pad-wijzigingen op te vangen. \ No newline at end of file diff --git a/android/app/build.gradle b/android/app/build.gradle index 3d086ac..4981ef8 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -3,45 +3,20 @@ plugins { id 'org.jetbrains.kotlin.android' } -def signingPropsFile = rootProject.file('signing.properties') -def hasSigningConfig = signingPropsFile.exists() - android { - namespace 'nl.eddydevink.sylda' + namespace 'com.eddy.atomrelay' compileSdk 34 - if (hasSigningConfig) { - def props = new Properties() - props.load(new FileInputStream(signingPropsFile)) - - signingConfigs { - release { - storeFile rootProject.file(props['KEYSTORE_PATH']) - storePassword props['KEYSTORE_PASSWORD'] - keyAlias props['KEY_ALIAS'] - keyPassword props['KEY_PASSWORD'] - } - } - } - defaultConfig { - applicationId "nl.eddydevink.sylda" - minSdk 26 + applicationId "com.eddy.atomrelay" + minSdk 24 targetSdk 34 - versionCode 2 - versionName "1.1" - buildConfigField "String", "BUILD_NUMBER", "\"${new java.text.SimpleDateFormat("yyyyMMddHHmmss").format(new Date())}\"" - } - - buildFeatures { - buildConfig true + versionCode 1 + versionName "1.0" } buildTypes { release { - if (hasSigningConfig) { - signingConfig signingConfigs.release - } minifyEnabled false proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' } @@ -56,37 +31,7 @@ android { } } -task generateSylDaVersions { - def versionFile = rootProject.file('../version.txt') - def outputFile = file('src/main/java/nl/eddydevink/sylda/SylDaVersions.kt') - - inputs.file(versionFile) - outputs.file(outputFile) - - doLast { - def versions = [:] - versionFile.eachLine { line -> - def parts = line.trim().split('=') - if (parts.length == 2) versions[parts[0].trim()] = parts[1].trim() - } - outputFile.text = """// Auto-generated from version.txt — DO NOT EDIT -package nl.eddydevink.sylda - -object SylDaVersions { - const val SERVER = "${versions.server}" - const val CLIENT = "${versions.client}" -} -""" - } -} -preBuild.dependsOn generateSylDaVersions - dependencies { implementation 'androidx.core:core-ktx:1.12.0' implementation 'androidx.appcompat:appcompat:1.6.1' - implementation 'io.github.dkaukov:esp32-flash-lib:1.1.17' - implementation 'com.eclipsesource.minimal-json:minimal-json:0.9.5' - implementation 'org.slf4j:slf4j-nop:2.0.16' - implementation 'androidx.security:security-crypto:1.1.0-alpha06' - implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.7.0' } \ No newline at end of file diff --git a/android/app/proguard-rules.pro b/android/app/proguard-rules.pro deleted file mode 100644 index 86c9d28..0000000 --- a/android/app/proguard-rules.pro +++ /dev/null @@ -1,2 +0,0 @@ --keep class org.dkaukov.esp32.** { *; } --dontwarn org.dkaukov.esp32.** diff --git a/android/app/src/main/AndroidManifest.xml b/android/app/src/main/AndroidManifest.xml index c9c6ac8..2e6bef5 100644 --- a/android/app/src/main/AndroidManifest.xml +++ b/android/app/src/main/AndroidManifest.xml @@ -3,20 +3,18 @@ - + - - + + android:theme="@style/Theme.AppCompat.Light"> - - - - - + android:parentActivityName=".MainActivity"/> \ No newline at end of file diff --git a/android/app/src/main/assets/firmware/client/boot_app0.bin b/android/app/src/main/assets/firmware/client/boot_app0.bin deleted file mode 100644 index 13562ca..0000000 Binary files a/android/app/src/main/assets/firmware/client/boot_app0.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/client/bootloader.bin b/android/app/src/main/assets/firmware/client/bootloader.bin deleted file mode 100644 index 204061a..0000000 Binary files a/android/app/src/main/assets/firmware/client/bootloader.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/client/firmware.bin b/android/app/src/main/assets/firmware/client/firmware.bin deleted file mode 100644 index ca1b829..0000000 Binary files a/android/app/src/main/assets/firmware/client/firmware.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/client/partitions.bin b/android/app/src/main/assets/firmware/client/partitions.bin deleted file mode 100644 index 951265f..0000000 Binary files a/android/app/src/main/assets/firmware/client/partitions.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/server/boot_app0.bin b/android/app/src/main/assets/firmware/server/boot_app0.bin deleted file mode 100644 index 13562ca..0000000 Binary files a/android/app/src/main/assets/firmware/server/boot_app0.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/server/bootloader.bin b/android/app/src/main/assets/firmware/server/bootloader.bin deleted file mode 100644 index 204061a..0000000 Binary files a/android/app/src/main/assets/firmware/server/bootloader.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/server/firmware.bin b/android/app/src/main/assets/firmware/server/firmware.bin deleted file mode 100644 index 3a35b83..0000000 Binary files a/android/app/src/main/assets/firmware/server/firmware.bin and /dev/null differ diff --git a/android/app/src/main/assets/firmware/server/partitions.bin b/android/app/src/main/assets/firmware/server/partitions.bin deleted file mode 100644 index 951265f..0000000 Binary files a/android/app/src/main/assets/firmware/server/partitions.bin and /dev/null differ diff --git a/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt b/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt new file mode 100644 index 0000000..03e3eef --- /dev/null +++ b/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt @@ -0,0 +1,134 @@ +package com.eddy.atomrelay + +import android.content.Context +import android.hardware.usb.UsbConstants +import android.hardware.usb.UsbDevice +import android.hardware.usb.UsbManager +import android.os.Handler +import android.os.Looper +import android.util.Log +import org.dkaukov.esp32.core.EspFlasherApi +import org.dkaukov.esp32.io.ProgressCallback +import java.io.IOException + +class EspFlasher(private val context: Context) { + + companion object { + private const val TAG = "EspFlasher" + } + + interface FlashCallback { + fun onProgress(percent: Int, message: String) + fun onComplete() + fun onError(message: String) + } + + private val handler = Handler(Looper.getMainLooper()) + + fun flashDevice(usbManager: UsbManager, device: UsbDevice, callback: FlashCallback) { + Thread { + try { + doFlash(usbManager, device, callback) + } catch (e: Exception) { + Log.e(TAG, "Flash failed", e) + handler.post { callback.onError(e.message ?: "Onbekende fout") } + } + }.start() + } + + private class FlashStep( + val name: String, + val address: Int, + val data: ByteArray, + val baseProgress: Int, + val range: Int, + val compress: Boolean + ) + + private fun doFlash(usbManager: UsbManager, device: UsbDevice, callback: FlashCallback) { + Thread.sleep(500) + + val connection = usbManager.openDevice(device) + ?: throw IOException("Kan USB-apparaat niet openen") + + try { + val intf = UsbUtils.findCdcDataInterface(device) + ?: throw IOException("Geen CDC data interface gevonden") + + if (!connection.claimInterface(intf, true)) { + throw IOException("Kan USB interface niet claimen") + } + + val epOut = UsbUtils.findBulkEndpoint(intf, UsbConstants.USB_DIR_OUT) + ?: throw IOException("Geen USB OUT endpoint gevonden") + val epIn = UsbUtils.findBulkEndpoint(intf, UsbConstants.USB_DIR_IN) + ?: throw IOException("Geen USB IN endpoint gevonden") + + postProgress(callback, 0, "Verbinden met ESP bootloader...") + + val transport = UsbSerialTransport(connection, epOut, epIn) + + val assets = context.assets + val bootloader = assets.open("firmware/bootloader.bin").readBytes() + val partitions = assets.open("firmware/partitions.bin").readBytes() + val bootApp0 = assets.open("firmware/boot_app0.bin").readBytes() + val firmware = assets.open("firmware/firmware.bin").readBytes() + + val totalSize = bootloader.size + partitions.size + bootApp0.size + firmware.size + + val steps = listOf( + FlashStep("Bootloader", 0x0, bootloader, 30, 10, false), + FlashStep("Partitie tabel", 0x8000, partitions, 40, 10, false), + FlashStep("Boot app0", 0xe000, bootApp0, 50, 10, false), + FlashStep("Firmware", 0x10000, firmware, 60, 35, true) + ) + + postProgress(callback, 5, "Sync met bootloader...") + val api = EspFlasherApi.connect(transport) + .withCallBack(object : ProgressCallback { + override fun onProgress(pct: Float) { + Log.d(TAG, "Lib progress: $pct%") + } + override fun onInfo(value: String) { + Log.d(TAG, "Info: $value") + } + }) + + postProgress(callback, 10, "Chip detecteren...") + val detected = api.chipDetect() + val chipId = detected.getChipId() + Log.i(TAG, "Detected chip: $chipId") + postProgress(callback, 15, "Chip: ${chipId.readableName}") + + postProgress(callback, 20, "Stub laden...") + val stub = detected.loadStub() + + postProgress(callback, 25, "Flash wissen...") + stub.eraseFlash() + + for (step in steps) { + val sizeStr = if (step.data.size > 1024) "${step.data.size / 1024}KB" else "${step.data.size} bytes" + postProgress(callback, step.baseProgress, "${step.name} schrijven ($sizeStr)...") + + val writeStub = if (step.compress) stub.withCompression(true) else stub.withCompression(false) + writeStub.writeFlash(step.address, step.data) + + val endProgress = step.baseProgress + step.range + postProgress(callback, endProgress.coerceAtMost(95), "${step.name} geschreven") + } + + postProgress(callback, 95, "ESP resetten...") + stub.reset() + + postProgress(callback, 100, "Firmware geflashed!") + handler.post { callback.onComplete() } + } finally { + connection.close() + } + } + + private fun postProgress(callback: FlashCallback, percent: Int, message: String) { + Log.d(TAG, "Progress $percent%: $message") + handler.post { callback.onProgress(percent, message) } + } +} diff --git a/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt b/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt new file mode 100644 index 0000000..6e88176 --- /dev/null +++ b/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt @@ -0,0 +1,353 @@ +package com.eddy.atomrelay + +import android.Manifest +import android.annotation.SuppressLint +import android.app.Activity +import android.bluetooth.BluetoothAdapter +import android.bluetooth.BluetoothDevice +import android.bluetooth.BluetoothGatt +import android.bluetooth.BluetoothGattCallback +import android.bluetooth.BluetoothGattCharacteristic +import android.bluetooth.BluetoothGattDescriptor +import android.bluetooth.BluetoothProfile +import android.bluetooth.le.ScanCallback +import android.bluetooth.le.ScanResult +import android.content.BroadcastReceiver +import android.content.Context +import android.content.Intent +import android.content.IntentFilter +import android.content.pm.PackageManager +import android.os.Bundle +import android.os.Handler +import android.os.Looper +import android.util.Log +import android.view.MotionEvent +import android.widget.Button +import android.widget.ImageButton +import android.widget.TextView +import androidx.appcompat.app.AppCompatActivity +import androidx.core.app.ActivityCompat +import java.nio.ByteBuffer +import java.nio.ByteOrder +import javax.crypto.Mac +import javax.crypto.spec.SecretKeySpec +import java.util.UUID + +class MainActivity : AppCompatActivity() { + + companion object { + private const val TAG = "AtomRelay" + private val SERVICE_UUID: UUID = UUID.fromString("4fafc201-1fb5-459e-8fcc-c5c9c331914b") + private val CHARACTERISTIC_UUID: UUID = UUID.fromString("beb5483e-36e1-4688-b7f5-ea07361f26d8") + private val CCCD_UUID: UUID = UUID.fromString("00002902-0000-1000-8000-00805f9b34fb") + private const val DEVICE_NAME = "AtomS3R-Relay" + private const val HMAC_PKT_SIZE = 37 + private const val HMAC_LEN = 32 + private const val REQUEST_SETTINGS = 1 + private const val SCAN_TIMEOUT_MS = 10000L + } + + private var bluetoothGatt: BluetoothGatt? = null + private var relayCharacteristic: BluetoothGattCharacteristic? = null + private var isScanning = false + private var scanTimedOut = false + private val handler = Handler(Looper.getMainLooper()) + + private var seq = 1 + private var hmacKey: ByteArray? = null + private var pendingDevice: BluetoothDevice? = null + + private lateinit var statusText: TextView + private lateinit var relayButton: Button + + private val scanCallback = object : ScanCallback() { + override fun onScanResult(callbackType: Int, result: ScanResult) { + val device = result.device + val name = device?.name ?: "" + Log.d(TAG, "Found device: $name (${device?.address})") + if (name == DEVICE_NAME) { + stopScan() + connectToDevice(device) + } + } + } + + private val bondReceiver = object : BroadcastReceiver() { + @SuppressLint("MissingPermission") + override fun onReceive(context: Context, intent: Intent) { + val action = intent.action + if (action == BluetoothDevice.ACTION_BOND_STATE_CHANGED) { + val device = intent.getParcelableExtra(BluetoothDevice.EXTRA_DEVICE) + val bondState = intent.getIntExtra(BluetoothDevice.EXTRA_BOND_STATE, BluetoothDevice.BOND_NONE) + Log.d(TAG, "Bond state changed: ${device?.address} -> $bondState") + if (bondState == BluetoothDevice.BOND_BONDED && device == pendingDevice) { + Log.d(TAG, "Bonded, discovering services...") + runOnUiThread { statusText.text = "Bonded, connecting..." } + bluetoothGatt?.discoverServices() + } + } + } + } + + private val gattCallback = object : BluetoothGattCallback() { + override fun onConnectionStateChange(gatt: BluetoothGatt, status: Int, newState: Int) { + if (newState == BluetoothProfile.STATE_CONNECTED) { + Log.d(TAG, "GATT connected") + bluetoothGatt = gatt + val device = gatt.device + pendingDevice = device + if (device.bondState == BluetoothDevice.BOND_BONDED) { + Log.d(TAG, "Already bonded, discovering services...") + runOnUiThread { statusText.text = "Connected, discovering..." } + gatt.discoverServices() + } else { + Log.d(TAG, "Not bonded, creating bond...") + runOnUiThread { statusText.text = "Pairing..." } + device.createBond() + } + } else if (newState == BluetoothProfile.STATE_DISCONNECTED) { + Log.d(TAG, "GATT disconnected") + runOnUiThread { + statusText.text = "Reconnecting..." + relayButton.isEnabled = false + } + gatt.close() + bluetoothGatt = null + relayCharacteristic = null + seq = 1 + handler.postDelayed({ startScan() }, 2000) + } + } + + @SuppressLint("MissingPermission") + override fun onServicesDiscovered(gatt: BluetoothGatt, status: Int) { + Log.d(TAG, "Services discovered, requesting MTU...") + gatt.requestMtu(256) + } + + @SuppressLint("MissingPermission") + override fun onMtuChanged(gatt: BluetoothGatt, mtu: Int, status: Int) { + Log.d(TAG, "MTU changed to $mtu") + val service = gatt.getService(SERVICE_UUID) + if (service != null) { + relayCharacteristic = service.getCharacteristic(CHARACTERISTIC_UUID) + if (relayCharacteristic != null) { + gatt.setCharacteristicNotification(relayCharacteristic, true) + val descriptor = relayCharacteristic!!.getDescriptor(CCCD_UUID) + descriptor.value = BluetoothGattDescriptor.ENABLE_NOTIFICATION_VALUE + gatt.writeDescriptor(descriptor) + Log.d(TAG, "Ready, relay characteristic found") + runOnUiThread { + statusText.text = "Connected" + relayButton.isEnabled = true + } + } + } else { + Log.e(TAG, "Service not found") + runOnUiThread { statusText.text = "Service not found" } + } + } + + override fun onCharacteristicWrite( + gatt: BluetoothGatt, + characteristic: BluetoothGattCharacteristic, + status: Int + ) { + Log.d(TAG, "Write status: $status") + } + } + + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(R.layout.activity_main) + + statusText = findViewById(R.id.statusText) + relayButton = findViewById(R.id.relayButton) + val settingsButton = findViewById(R.id.settingsButton) + + settingsButton.setOnClickListener { + startActivityForResult(Intent(this, SettingsActivity::class.java), REQUEST_SETTINGS) + } + setupRelayButton() + + registerReceiver(bondReceiver, IntentFilter(BluetoothDevice.ACTION_BOND_STATE_CHANGED), Context.RECEIVER_NOT_EXPORTED) + } + + @Deprecated("Deprecated in Java") + override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) { + super.onActivityResult(requestCode, resultCode, data) + if (requestCode == REQUEST_SETTINGS && resultCode == Activity.RESULT_OK) { + handler.postDelayed({ startScan() }, 300) + } + } + + override fun onResume() { + super.onResume() + loadHmacKey() + if (hmacKey == null) { + statusText.text = "Geen HMAC sleutel - open Instellingen" + } else if (!isScanning && bluetoothGatt == null) { + handler.postDelayed({ startScan() }, 300) + } + } + + override fun onPause() { + super.onPause() + stopScan() + } + + private fun loadHmacKey() { + val prefs = getSharedPreferences(SettingsActivity.PREFS_NAME, Context.MODE_PRIVATE) + val hexKey = prefs.getString(SettingsActivity.PREF_KEY, null) + hmacKey = hexKey?.let { hexStringToBytes(it) } + Log.d(TAG, "HMAC key loaded: ${if (hmacKey != null) "${hmacKey!!.size} bytes" else "none"}") + } + + private fun hexStringToBytes(hex: String): ByteArray? { + val cleaned = hex.uppercase().filter { it in "0123456789ABCDEF" } + if (cleaned.length != 64) return null + return cleaned.chunked(2).map { it.toInt(16).toByte() }.toByteArray() + } + + private fun hmacSha256(data: ByteArray, key: ByteArray): ByteArray { + val mac = Mac.getInstance("HmacSHA256") + mac.init(SecretKeySpec(key, "HmacSHA256")) + return mac.doFinal(data) + } + + private fun buildPacket(cmd: Byte, key: ByteArray): ByteArray { + val seqBytes = ByteBuffer.allocate(4).order(ByteOrder.BIG_ENDIAN).putInt(seq).array() + val hmacData = ByteArray(5) + hmacData[0] = cmd + System.arraycopy(seqBytes, 0, hmacData, 1, 4) + val hmac = hmacSha256(hmacData, key) + val packet = ByteArray(HMAC_PKT_SIZE) + packet[0] = cmd + System.arraycopy(seqBytes, 0, packet, 1, 4) + System.arraycopy(hmac, 0, packet, 5, HMAC_LEN) + return packet + } + + @Deprecated("Deprecated in Java") + override fun onRequestPermissionsResult(requestCode: Int, permissions: Array, grantResults: IntArray) { + super.onRequestPermissionsResult(requestCode, permissions, grantResults) + if (requestCode == 1 && grantResults.all { it == PackageManager.PERMISSION_GRANTED }) { + startScan() + } + } + + private fun setupRelayButton() { + relayButton.setOnTouchListener { _, event -> + when (event.action) { + MotionEvent.ACTION_DOWN -> { + sendRelayCommand(true) + relayButton.text = "ON" + true + } + MotionEvent.ACTION_UP, MotionEvent.ACTION_CANCEL -> { + sendRelayCommand(false) + relayButton.text = "HOLD" + true + } + else -> false + } + } + } + + @SuppressLint("MissingPermission") + private fun startScan() { + if (isScanning) return + if (!hasPermissions()) { + requestPermissions() + return + } + + val adapter = BluetoothAdapter.getDefaultAdapter() + if (adapter == null || !adapter.isEnabled) { + statusText.text = "Bluetooth not enabled" + return + } + + if (hmacKey == null) { + statusText.text = "Geen HMAC sleutel - open Instellingen" + return + } + + isScanning = true + scanTimedOut = false + statusText.text = "Scanning..." + Log.d(TAG, "Starting BLE scan for $DEVICE_NAME") + + adapter.bluetoothLeScanner.startScan(scanCallback) + + handler.postDelayed({ + if (isScanning) { + scanTimedOut = true + stopScan() + } + }, SCAN_TIMEOUT_MS) + } + + @SuppressLint("MissingPermission") + private fun stopScan() { + if (!isScanning) return + isScanning = false + val adapter = BluetoothAdapter.getDefaultAdapter() + adapter?.bluetoothLeScanner?.stopScan(scanCallback) + if (scanTimedOut) { + statusText.text = "Device not found" + } + } + + @SuppressLint("MissingPermission") + private fun connectToDevice(device: BluetoothDevice) { + runOnUiThread { statusText.text = "Connecting..." } + Log.d(TAG, "Connecting to ${device.address}") + bluetoothGatt = device.connectGatt(this, false, gattCallback) + } + + @SuppressLint("MissingPermission") + private fun sendRelayCommand(on: Boolean) { + val char = relayCharacteristic ?: return + val gatt = bluetoothGatt ?: return + val key = hmacKey ?: return + + val cmd: Byte = if (on) 0x01 else 0x00 + val packet = buildPacket(cmd, key) + char.value = packet + char.writeType = BluetoothGattCharacteristic.WRITE_TYPE_NO_RESPONSE + gatt.writeCharacteristic(char) + seq++ + Log.d(TAG, "Sent relay ${if (on) "ON" else "OFF"} (seq=${seq - 1})") + } + + private fun getRequiredPermissions(): Array { + return if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.S) { + arrayOf( + Manifest.permission.BLUETOOTH_SCAN, + Manifest.permission.BLUETOOTH_CONNECT, + Manifest.permission.ACCESS_FINE_LOCATION + ) + } else { + arrayOf(Manifest.permission.ACCESS_FINE_LOCATION) + } + } + + private fun hasPermissions(): Boolean { + return getRequiredPermissions().all { + ActivityCompat.checkSelfPermission(this, it) == PackageManager.PERMISSION_GRANTED + } + } + + private fun requestPermissions() { + ActivityCompat.requestPermissions(this, getRequiredPermissions(), 1) + } + + override fun onDestroy() { + super.onDestroy() + handler.removeCallbacksAndMessages(null) + stopScan() + bluetoothGatt?.close() + try { unregisterReceiver(bondReceiver) } catch (e: Exception) {} + } +} \ No newline at end of file diff --git a/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt b/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt new file mode 100644 index 0000000..4b1e74b --- /dev/null +++ b/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt @@ -0,0 +1,431 @@ +package com.eddy.atomrelay + +import android.app.PendingIntent +import android.app.ProgressDialog +import android.content.BroadcastReceiver +import android.content.Context +import android.content.Intent +import android.content.IntentFilter +import android.hardware.usb.UsbConstants +import android.hardware.usb.UsbDevice +import android.hardware.usb.UsbDeviceConnection +import android.hardware.usb.UsbEndpoint +import android.hardware.usb.UsbInterface +import android.hardware.usb.UsbManager +import android.os.Bundle +import android.os.Handler +import android.os.Looper +import android.util.Log +import android.widget.Button +import android.widget.Toast +import androidx.appcompat.app.AppCompatActivity +import java.nio.charset.StandardCharsets +import java.security.SecureRandom + +class SettingsActivity : AppCompatActivity() { + + companion object { + const val PREFS_NAME = "relay_prefs" + const val PREF_KEY = "hmac_key" + const val RESULT_SCAN = 100 + private const val TAG = "SettingsActivity" + private const val ESP_VENDOR_ID = 0x303a + private const val CDC_DATA_INTERFACE_CLASS = 0x0A + private const val KEY_TIMEOUT_MS = 5000L + private const val SET_KEY_TIMEOUT_MS = 5000L + private const val ACTION_USB_PERMISSION = "com.eddy.atomrelay.USB_PERMISSION" + } + + private enum class UsbAction { NONE, EXCHANGE_KEY, FLASH } + + private var currentAction = UsbAction.NONE + private var dialog: ProgressDialog? = null + private val handler = Handler(Looper.getMainLooper()) + + private val usbAttachedReceiver = object : BroadcastReceiver() { + override fun onReceive(context: Context, intent: Intent) { + if (intent.action == UsbManager.ACTION_USB_DEVICE_ATTACHED && currentAction != UsbAction.NONE) { + val device = intent.getParcelableExtra(UsbManager.EXTRA_DEVICE) + if (device?.vendorId == ESP_VENDOR_ID) { + val usbManager = context.getSystemService(Context.USB_SERVICE) as UsbManager + if (usbManager.hasPermission(device)) { + onDeviceReady(usbManager, device) + } else { + requestUsbPermission(usbManager, device) + } + } + } + } + } + + private val usbPermissionReceiver = object : BroadcastReceiver() { + override fun onReceive(context: Context, intent: Intent) { + if (intent.action == ACTION_USB_PERMISSION && currentAction != UsbAction.NONE) { + val granted = intent.getBooleanExtra(UsbManager.EXTRA_PERMISSION_GRANTED, false) + if (granted) { + val usbManager = context.getSystemService(Context.USB_SERVICE) as UsbManager + val device = usbManager.deviceList.values.firstOrNull { it.vendorId == ESP_VENDOR_ID } + if (device != null) { + onDeviceReady(usbManager, device) + } + } else { + Toast.makeText(this@SettingsActivity, "USB-toegang geweigerd", Toast.LENGTH_SHORT).show() + cleanupAction() + } + } + } + } + + private val usbDetachedReceiver = object : BroadcastReceiver() { + override fun onReceive(context: Context, intent: Intent) { + if (intent.action == UsbManager.ACTION_USB_DEVICE_DETACHED) { + val device = intent.getParcelableExtra(UsbManager.EXTRA_DEVICE) + if (device?.vendorId == ESP_VENDOR_ID && dialog != null && currentAction == UsbAction.NONE) { + dialog?.dismiss() + dialog = null + } + } + } + } + + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(R.layout.activity_settings) + + supportActionBar?.setDisplayHomeAsUpEnabled(true) + supportActionBar?.title = "Instellingen" + + findViewById