├── .github └── workflows │ ├── arduino.yml │ └── ota-publisher.yml ├── .gitignore ├── LICENSE ├── README.md ├── enclosure ├── B.B. Link enclosure.jpg ├── B.B. Link v3 - Enclosure.stl ├── B.B. Link v3 - Lid.stl └── contribs │ └── F4LFJ │ ├── BB-Link_case_01.jpeg │ ├── BB-Link_case_02.jpeg │ ├── BB-Link_case_03.jpeg │ ├── BB-Link_case_04.jpeg │ ├── BB-Link_case_05.jpeg │ ├── BB-Link_case_06.jpeg │ ├── BB-link part A v5.stl │ └── BB-link part B v5.stl ├── scripts ├── .ruby-gemset ├── .ruby-version ├── flash.sh └── post_flash.rb ├── src └── bb-link │ ├── Adapter.cpp │ ├── Adapter.h │ ├── Bridge.cpp │ ├── Bridge.h │ ├── FiniteStateMachine.cpp │ ├── FiniteStateMachine.h │ ├── KISSInterceptor.cpp │ ├── KISSInterceptor.h │ ├── MockBLEDevice.h │ ├── MockBluetoothSerial.h │ ├── StatusIndicator.h │ ├── StatusIndicatorBase.h │ ├── StatusIndicatorDummy.h │ ├── THD7x.cpp │ ├── THD7x.h │ ├── TouchButton.h │ ├── TouchButtonBase.h │ ├── TouchButtonDummy.h │ └── bb-link.ino └── tests ├── KISSInterceptorTest ├── KISSInterceptorTest.ino └── Makefile ├── Makefile └── THD7xTest ├── Makefile └── THD7xTest.ino /.github/workflows/arduino.yml: -------------------------------------------------------------------------------- 1 | name: Build and Release 2 | on: 3 | push: 4 | tags: 5 | - v* 6 | 7 | jobs: 8 | build: 9 | strategy: 10 | matrix: 11 | board: [tinypico, pico32] 12 | include: 13 | - board: tinypico 14 | arduino-platform: esp32:esp32 15 | arduino-platform-version: 2.0.15 16 | arduino-board: esp32:esp32:tinypico 17 | - board: pico32 18 | arduino-platform: esp32:esp32 19 | arduino-platform-version: 2.0.15 20 | arduino-board: esp32:esp32:pico32 21 | runs-on: ubuntu-latest 22 | steps: 23 | - name: Install dependencies 24 | run: | 25 | sudo apt-get update 26 | sudo apt-get install -y python3-pip 27 | pip3 install pyserial 28 | - name: Checkout 29 | uses: actions/checkout@v3 30 | - name: Set up Arduino CLI 31 | uses: arduino/setup-arduino-cli@v1 32 | - name: Install core 33 | run: | 34 | arduino-cli core update-index 35 | arduino-cli core install --additional-urls "https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json" ${{matrix.arduino-platform}}@${{matrix.arduino-platform-version}} 36 | - name: Install libraries 37 | run: | 38 | arduino-cli lib install "TinyPICO Helper Library"@1.4.0 39 | arduino-cli lib install "FreeRTOS"@11.0.1-5 40 | arduino-cli lib install "ArduinoQueue"@1.2.5 41 | arduino-cli lib install "ArduinoLog"@1.1.1 42 | arduino-cli lib install "AUnit"@1.7.1 43 | - name: Compile 44 | run: | 45 | arduino-cli compile --fqbn ${{matrix.arduino-board}} --export-binaries src/bb-link/bb-link.ino 46 | - name: Define version 47 | run: | 48 | VERSION=${GITHUB_REF#refs/tags/} 49 | VERSION=${VERSION#v} 50 | echo "VERSION=${VERSION}" >> $GITHUB_ENV 51 | - name: Rename binary 52 | run: | 53 | fqbnpath=$(echo ${{matrix.arduino-board}} | tr ':' '.') 54 | cp src/bb-link/build/$fqbnpath/bb-link.ino.bin src/bb-link/build/bb-link-${{matrix.board}}-${{env.VERSION}}.bin 55 | - name: Calculate checksum 56 | run: | 57 | sha256sum src/bb-link/build/bb-link-${{matrix.board}}-${{env.VERSION}}.bin | cut -d ' ' -f 1 > src/bb-link/build/bb-link-${{matrix.board}}-${{env.VERSION}}.bin.sha256.txt 58 | - name: Create OTA manifest 59 | run: | 60 | mkdir -p src/bb-link/build/ota/${{matrix.board}} 61 | echo "{ 62 | \"version\": \"${{env.VERSION}}\", 63 | \"url\": \"https://github.com/islandmagic/bb-link/releases/download/v${{env.VERSION}}/bb-link-${{matrix.board}}-${{env.VERSION}}.bin\", 64 | \"sha256\": \"$(cat src/bb-link/build/bb-link-${{matrix.board}}-${{env.VERSION}}.bin.sha256.txt)\" 65 | }" > src/bb-link/build/ota/${{matrix.board}}/beta.json 66 | - name: Upload binaries artifacts 67 | uses: actions/upload-artifact@v4 68 | with: 69 | name: bin-${{matrix.board}} 70 | path: src/bb-link/build/bb-link-${{matrix.board}}* 71 | if-no-files-found: error 72 | - name: Upload ota artifacts 73 | uses: actions/upload-artifact@v4 74 | with: 75 | name: ota-${{matrix.board}} 76 | path: src/bb-link/build/ota/*/beta.json 77 | if-no-files-found: error 78 | release: 79 | needs: build 80 | runs-on: ubuntu-latest 81 | steps: 82 | - name: Checkout code 83 | uses: actions/checkout@v3 84 | 85 | - name: Create Release 86 | id: create_release 87 | uses: actions/create-release@v1 88 | env: 89 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 90 | with: 91 | tag_name: ${{ github.ref }} 92 | release_name: Release ${{ github.ref }} 93 | draft: true 94 | prerelease: true 95 | 96 | - name: Download artifacts 97 | uses: actions/download-artifact@v4 98 | with: 99 | path: artifacts 100 | pattern: bin-* 101 | merge-multiple: true 102 | - name: Upload Release Assets 103 | id: upload_release_assets 104 | uses: dwenegar/upload-release-assets@v1 105 | env: 106 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 107 | with: 108 | release_id: ${{ steps.create_release.outputs.id }} 109 | assets_path: "./artifacts/*" 110 | publish-ota: 111 | needs: release 112 | runs-on: ubuntu-latest 113 | steps: 114 | - name: Checkout code 115 | uses: actions/checkout@v3 116 | - name: Download artifacts 117 | uses: actions/download-artifact@v4 118 | with: 119 | path: artifacts 120 | pattern: ota-* 121 | merge-multiple: true 122 | - name: Setup git user/email 123 | run: | 124 | git config --global user.name github-actions 125 | git config --global user.email github-actions@github.com 126 | - name: Checkout 127 | uses: actions/checkout@v3 128 | with: 129 | ref: ota-firmware 130 | path: ota-firmware 131 | - name: Publish OTA 132 | run: | 133 | cp -r artifacts/* ota-firmware/ 134 | cd ota-firmware 135 | [ -z "$(git status -s -- .)" ] && echo "No changes to be committed. Exiting." && exit 0 136 | git add -- . 137 | git commit -m "Add new beta firmware" 138 | git push origin ota-firmware 139 | echo "Done." -------------------------------------------------------------------------------- /.github/workflows/ota-publisher.yml: -------------------------------------------------------------------------------- 1 | name: OTA publish 2 | on: 3 | workflow_dispatch: 4 | 5 | jobs: 6 | promote-beta-to-release: 7 | runs-on: ubuntu-latest 8 | steps: 9 | - uses: actions/checkout@v3 10 | 11 | - name: Setup git user/email 12 | run: | 13 | git config --global user.name github-actions 14 | git config --global user.email github-actions@github.com 15 | 16 | - name: Checkout 17 | uses: actions/checkout@v3 18 | with: 19 | ref: ota-firmware 20 | path: ota-firmware 21 | 22 | - name: Promote beta to release 23 | run: | 24 | cd ota-firmware 25 | for dir in */; do 26 | if [[ -f "${dir}beta.json" ]]; then 27 | cp "${dir}beta.json" "${dir}latest.json" 28 | fi 29 | done 30 | [ -z "$(git status -s -- .)" ] && echo "No changes to be committed. Exiting." && exit 0 31 | git add -- . 32 | git commit -m "Promoted beta to release." 33 | git push origin ota-firmware 34 | echo "Done." -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # These are some examples of commonly ignored file patterns. 2 | # You should customize this list as applicable to your project. 3 | # Learn more about .gitignore: 4 | # https://www.atlassian.com/git/tutorials/saving-changes/gitignore 5 | 6 | # Node artifact files 7 | node_modules/ 8 | dist/ 9 | 10 | # Compiled Java class files 11 | *.class 12 | 13 | # Compiled Python bytecode 14 | *.py[cod] 15 | 16 | # Log files 17 | *.log 18 | 19 | # Package files 20 | *.jar 21 | 22 | # Maven 23 | target/ 24 | dist/ 25 | 26 | # JetBrains IDE 27 | .idea/ 28 | 29 | # Unit test reports 30 | TEST*.xml 31 | 32 | # Generated by MacOS 33 | .DS_Store 34 | 35 | # Generated by Windows 36 | Thumbs.db 37 | 38 | # Applications 39 | *.app 40 | *.exe 41 | *.war 42 | 43 | # Large media files 44 | *.mp4 45 | *.tiff 46 | *.avi 47 | *.flv 48 | *.mov 49 | *.wmv 50 | 51 | .vscode/ 52 | 53 | src/bb-link/build/ 54 | 55 | *.o 56 | *.out 57 | sketch.yaml -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | ### Psst… skip the soldering. 4 | 5 | 6 | 7 | 8 |
9 | 10 | ### 👉 Check out the sleek ready-made version that plugs directly into USB-C! 11 | 12 |
13 | 14 | # B.B. Link, the BLE to Bluetooth Classic adapter for Kenwood TH-D74/5 Radios 15 | 16 | Some devices, like the Kenwood TH-D75 radio only support Bluetooth Classic serial profile. iOS devices only support Bluetooth Low Energy (BLE). They are not compatible and as such, you can't pair those devices together. This code provides a way to create an adapter that can interface a device that exposes a serial profile over Bluetooth Classic, to an iOS device via BLE. Its main purpose is to enable iOS app that supports AX.25 packet like RadioMail or APRS.fi to use the TNC built in the radio as a modem. 17 | 18 | For a detailed "how-to build" this adapter, watch this video: 19 | 20 | [![Watch the video](https://image.mux.com/SZQsZnBJDJf4GMUrTRxJ386tSpsIlRP02yfmXZr79TKg/thumbnail.png?time=1200)](https://player.mux.com/SZQsZnBJDJf4GMUrTRxJ386tSpsIlRP02yfmXZr79TKg) 21 | 22 | After you're done, come back and follow the instructions here as they are continually updated. 23 | 24 | ## Hardware 25 | 26 | The adapter is based on the ESP32 microcontroller, which provides support for both Bluetooth Classic and Bluetooth Low Energy (BLE). There is specialized code tailored for the [TinyPICO](https://www.tinypico.com) development board, which serves as the standard implementation. This code can be altered to work with other ESP32-based boards as needed. 27 | 28 | **Note: Compatibility is limited to ESP32 microcontroller. Boards like the TinyS3, which use the ESP32-S3 chip, do not support Bluetooth Classic. If you don't use the TinyPICO, make sure to choose a board that features the ESP32 microcontroller.** 29 | 30 | ### Material 31 | 32 | 1. TinyPICO [Buy](https://unexpectedmaker.com/shop.html#!/TinyPICO/p/577111313/category=154494282) 33 | 2. 600 mAh LiPo Battery model 602248 (6x22x48mm) [Buy](https://www.aliexpress.us/item/2251832520607268.html) 34 | 3. 3D Printed case 35 | 4. Brad fastener as touch button (8mm head) 36 | 37 | ### Power Options 38 | 39 | The adapter can be powered via USB, such as through a USB adapter or a portable power bank, or alternatively, it can be connected to a LiPo battery for use on the go. The TinyPICO will charge the battery when plugged into USB. 40 | 41 | ### Capacitive Touch Button 42 | 43 | The installation of a capacitive touch button is not required but recommended if you need an on/off switch while using a LiPo battery. To install, connect a wire to pin number 4 on the TinyPICO board; this will serve as the on/off control. 44 | 45 | ### Cases 46 | 47 | You can 3D print a case to house the battery and the board. Here are a couple of option that attach via the mounting holes for the belt clip. 48 | 49 | 1. Horizontal 50 | 51 | This is the orignal design from WH6AZ, functional but primitive. Can work as a stand alone box if you don't feel like attaching to the radio. 52 | 53 | https://github.com/islandmagic/bb-link/tree/master/enclosure 54 | 55 | 2. Vertical 56 | 57 | This design is a beautiful contribution from F4LFJ. It features a slick design that allows the case to attach vertically. There is enough clearance to insert and remove the battery from the radio. 58 | 59 | https://github.com/islandmagic/bb-link/tree/master/enclosure/contribs/F4LFJ 60 | 61 | ## Software 62 | 63 | 1. Install Arduino IDE 2.x [https://www.arduino.cc](https://www.arduino.cc) 64 | 1. Add additional library source in Arduino IDE. Settings > Additional board manager URLs: `https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json` 65 | 1. Install the esp32 by Espressif Systems board library. This code has been tested with version 2.0.15. 66 | 1. Install the TinyPICO helper library 67 | 1. Install FreeRTOS library 68 | 1. Install ArduinoQueue library 69 | 1. Install ArduinoLog library 70 | 1. Clone this repo 71 | 1. Flash the code to the TinyPICO board 72 | 1. Download [B.B. Link Configurator](https://apps.apple.com/us/app/b-b-link-configurator/id6476163710) app on your phone 73 | 1. Download RadioMail on your phone [https://radiomail.app](https://radiomail.app) 74 | 75 | ### Rig Control 76 | 77 | By default, the adapter will set the radio to KISS mode and automatically respond to RadioMail's instructions to switch frequencies, enabling seamless operation. If you prefer the adapter not to alter radio settings during use, toggle off the 'Control Frequency' option in the configurator app. 78 | 79 | ## Operating Instructions 80 | 81 | ### Powering On 82 | 83 | 1. Wake the adapter by briefly pressing the touch button. An amber light will indicate that it is awake. 84 | 85 | ### Pairing with a Radio (one time only) 86 | 87 | 1. Turn on adapter 88 | 1. Open B.B. Link Configurator app on your phone 89 | 1. After a few seconds, `B.B. Link` appears in the list of nearby adapters. Select it. 90 | 1. Set the radio in Bluetooth discovery mode. Navigate to 'Menu -> Bluetooth -> Pairing Mode' on the radio. 91 | 1. Tap 'Paired Radio' on B.B. Link app 92 | 1. Wait a few seconds, the name of your radio should appear in the list. Select it. 93 | 1. After a few seconds a PIN prompt should appear on the radio. Press 'OK' to accept. This step is only necessary once; afterwards, the adapter will automatically try to reconnect with the radio. 94 | 1. Successful pairing is indicated by a breathing blue LED on the adapter. 95 | 96 | ### Pairing with iPhone or iPad 97 | 98 | 1. Make sure B.B. Link Configurator app is fully closed 99 | 1. Open the RadioMail app. Proceed to 'Settings -> KISS TNC Modem -> Default TNC'. 100 | 1. `B.B. Link` should be visible in the discovery screen. 101 | 1. Select `B.B. Link` and tap 'Done'. 102 | 1. Navigate to the connection screen and choose a packet station. 103 | 1. A solid blue LED on the adapter signals that RadioMail has connected. Red and green LEDs will flash to indicate data transmission and reception. 104 | 105 | ### Powering Off 106 | 107 | - The adapter will shut off automatically after 5 minutes when not in use on battery power. It stays on indefinitely if USB power is detected. 108 | - To manually turn off the adapter, press and hold the touch button until the LED blinks amber, then release. 109 | 110 | ### User Interface 111 | 112 | #### Touch Button Functions 113 | 114 | - **Short Press**: Wake the adapter or check the battery status when idle. 115 | - **Long Press**: Turn off the adapter. 116 | 117 | #### LED Indicator 118 | 119 | The dotstar tri-color LED is used to indicate various states: 120 | 121 | - 🟠: Idle, adapter waiting to pair 122 | - 🔵 (slow flash): Adapter scanning for radio 123 | - 🔵 (breathing): Idle, paired with radio 124 | - 🔵: Ready, radio and iOS device paired 125 | - 🟠 (fast blink): Shutting down 126 | 127 | Data Activity: 128 | 129 | - 🟢: Rx (Receiving) 130 | - 🔴: Tx (Transmitting) 131 | - 🟣: Rx/Tx (Both Receiving and Transmitting) 132 | 133 | Error Conditions: 134 | 135 | - 🔴 (fast blink): Low battery immediate shutdown 136 | - 🔴 (slow flash): Fatal error, must reset 137 | 138 | Battery Status Indicators: 139 | 140 | - 🟢: Battery full 141 | - 🟢 (fast blink): Battery low 142 | 143 | #### Battery Indicator 144 | 145 | The charge level of a LiPO battery can be difficult to determine without additional circuitry due to their non-linear discharge curve. A basic battery indicator is provided based on the battery voltage level: 146 | 147 | 1. Upon waking up, the adapter displays the battery level for a few seconds. A solid green light indicates the battery is considered full, while a flashing green light suggests the battery needs charging. 148 | 1. When the adapter is idle (indicated by an amber LED), a short tap will activate the battery level display. 149 | 150 | ### Battery Saver 151 | 152 | To save energy, the adapter automatically enters a low-power sleep mode after a certain period of not being used, for instance, when no phone is connected, during which it consumes approximately 40 µA. While active, the adapter's power consumption is around 140 mA, allowing for continuous operation for up to 4 hours on a 600 mAh battery. In standby mode, with no active bluetooth connection, it uses about 80 mA. Additionally, the sleep feature is disabled when the adapter is connected to USB power, ensuring that the adapter can stay on for longer durations and can be used while it is being charged. 153 | 154 | If the battery voltage falls to a critical level, the adapter will automatically shut down to prevent damage to the circuit. 155 | 156 | ### Factory Reset 157 | 158 | You can reset the adapter to its default configuration. This will clear the list of previously paired devices and restoring default settings. Simply tap 'Reset Adapter' in the configurator app. 159 | 160 | Alternatively, you can reset the adapter by connecting it to a computer. Here's how to do it: 161 | 162 | 1. Launch the Arduino IDE on your PC. 163 | 1. Connect the adapter to your PC using a USB cable. 164 | 1. Navigate to the Serial Monitor within the IDE. 165 | 1. Type `R` into the Serial Monitor and send the command. 166 | 1. Monitor the response in the Serial Monitor which will confirm the clearing of the previously paired devices. 167 | 1. After the process is complete, disconnect the adapter from your PC. 168 | 169 | ## Troubleshooting 170 | 171 | * If the adapter connects to the radio but the radio does not transmit, check the TNC settings. Go to Menu > Configuration > Interface > KISS (983) and set it to Bluetooth. 172 | 173 | ## Known Issues 174 | 175 | 1. The ESP32 library is limited to discovering Bluetooth Classic devices exclusively prior to establishing any connections. After connecting with a device, the discovery capability is no longer available. To initiate a new scan, the adapter must be rebooted. If you intend to pair with a different radio, ensure that the radio previously paired with is turned off before powering on the adapter. If not, the adapter will automatically re-establish a connection with the previously paired radio, preventing it from discovering new radios. 176 | 177 | ## How to Contribute 178 | 179 | This project is open source, so everyone's contribution is welcome. Here's a quick guide to get started: 180 | 181 | * **Share**: If you build your own adapter, share it online! Post photos, write a blog post, or create a tutorial video to show others how it's done. 182 | * **Update Documentation**: Help improve or correct the documentation. Fork the repo, make your updates, and submit a pull request. 183 | * **Submit Change Requests**: If you're developing a new feature or bug fix, fork the repository, create a new branch for your changes, and submit a pull request with a clear description of your modifications. 184 | * **Write Good Issue Reports**: If you encounter bugs or have feature suggestions, please submit an issue report with a clear title, a detailed description, and steps to reproduce the issue if it's a bug. 185 | 186 | The source code for the [Configurator](https://github.com/islandmagic/ios-bblink-config) app is available as well. 187 | 188 | -------------------------------------------------------------------------------- /enclosure/B.B. Link enclosure.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/B.B. Link enclosure.jpg -------------------------------------------------------------------------------- /enclosure/B.B. Link v3 - Enclosure.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/B.B. Link v3 - Enclosure.stl -------------------------------------------------------------------------------- /enclosure/B.B. Link v3 - Lid.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/B.B. Link v3 - Lid.stl -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-Link_case_01.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-Link_case_01.jpeg -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-Link_case_02.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-Link_case_02.jpeg -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-Link_case_03.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-Link_case_03.jpeg -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-Link_case_04.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-Link_case_04.jpeg -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-Link_case_05.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-Link_case_05.jpeg -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-Link_case_06.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-Link_case_06.jpeg -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-link part A v5.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-link part A v5.stl -------------------------------------------------------------------------------- /enclosure/contribs/F4LFJ/BB-link part B v5.stl: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/islandmagic/bb-link/07dfc8eda9e38fc48479fea0ba70667c4a115c8d/enclosure/contribs/F4LFJ/BB-link part B v5.stl -------------------------------------------------------------------------------- /scripts/.ruby-gemset: -------------------------------------------------------------------------------- 1 | bblink -------------------------------------------------------------------------------- /scripts/.ruby-version: -------------------------------------------------------------------------------- 1 | ruby-3.3.2 -------------------------------------------------------------------------------- /scripts/flash.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | echo "*******************************************************" 3 | echo "*** Flashing BB-Link to all connected ESP32 devices ***" 4 | echo "*******************************************************" 5 | devices=$(arduino-cli board list | grep 'wchusbserial' | awk '{print $1}') 6 | device_count=$(echo "$devices" | wc -l) 7 | echo "Devices found: $device_count" 8 | for device in $devices; do 9 | echo "Flashing BB-Link to $device" 10 | arduino-cli board attach -b esp32:esp32:pico32 -p $device ../src/bb-link/bb-link.ino 11 | arduino-cli compile -u ../src/bb-link/bb-link.ino 12 | ruby post_flash.rb $device 13 | done 14 | echo "*******************************************************" 15 | echo "*** Done ***" 16 | echo "*******************************************************" -------------------------------------------------------------------------------- /scripts/post_flash.rb: -------------------------------------------------------------------------------- 1 | require 'rubyserial' 2 | 3 | def send_command(port, command) 4 | serial_port = Serial.new(port, 115200) 5 | serial_port.write(command) 6 | serial_port.write("\n") 7 | serial_port.close 8 | end 9 | 10 | if __FILE__ == $0 11 | port = ARGV[0] 12 | command = ENV['POST_FLASH_CMD'] 13 | if port.nil? || command.nil? 14 | puts "Nothing to do" 15 | exit 16 | end 17 | puts "Sending command: #{command} to port: #{port}" 18 | send_command(port, command) 19 | end -------------------------------------------------------------------------------- /src/bb-link/Adapter.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "Adapter.h" 3 | 4 | #define IDLE_TIME_TO_SLEEP 5 * 60 * 1000 // 5 min, time before shutting down when neither devices are connected 5 | #define ACTION_FEEDBACK_DURATION 2000 // Duration for action feedback 6 | #define LINGER_TIME_BEFORE_SHUTDOWN 2000 // Grace time for user to untouch button before sleeping, since touch would wake up device again 7 | #define BATTERY_FULL_VOLTAGE 3.750 // Voltage above which to consider LiPo battery charged 8 | #define BATTERY_MIN_VOLTAGE 3.500 // Voltage below which esp32 should go to sleep as battery is going to rapidely drop its charge 9 | #define SHOW_BATTERY_DURATION 3000 // Duration for battery indicator to stay on 10 | #define BATTERY_WATCHGUARD_INTERVAL 3 * 60 * 1000 // Interval between battery check 11 | 12 | #define VBUS_SENSE_GPIO 9 13 | 14 | #define SERVICE_UUID_OTA "1A68D2B0-C2E4-453F-A2BB-B659D66CF442" 15 | #define CHARACTERISTIC_UUID_OTA_FLASH "1A68D2B1-C2E4-453F-A2BB-B659D66CF442" 16 | #define CHARACTERISTIC_UUID_OTA_IDENTITY "1A68D2B2-C2E4-453F-A2BB-B659D66CF442" 17 | 18 | extern const char *logLevels[]; 19 | 20 | // AdapterState 21 | Adapter::Adapter() : idleState( 22 | [this] 23 | { this->idleEnter(); }, 24 | [this] 25 | { this->idleUpdate(); }, 26 | [this] 27 | { this->idleExit(); }), 28 | inUseState( 29 | [this] 30 | { this->inUseEnter(); }, 31 | [this] 32 | { this->inUseUpdate(); }, 33 | [this] 34 | { this->inUseExit(); }), 35 | shutdownState( 36 | [this] 37 | { this->shutdownEnter(); }, 38 | [this] 39 | { this->shutdownUpdate(); }, 40 | [this] 41 | { this->shutdownExit(); }), 42 | showBatteryState( 43 | [this] 44 | { this->showBatteryEnter(); }, 45 | [this] 46 | { this->showBatteryUpdate(); }, 47 | [this] 48 | { this->showBatteryExit(); }), 49 | otaFlashState( 50 | [this] 51 | { this->otaFlashEnter(); }, 52 | [this] 53 | { this->otaFlashUpdate(); }, 54 | [this] 55 | { this->otaFlashExit(); }), 56 | adapterStateMachine(idleState), 57 | bridge(fetchAdapterName()) 58 | { 59 | } 60 | 61 | String Adapter::fetchAdapterName() 62 | { 63 | String name = ADAPTER_NAME; 64 | Preferences preferences; 65 | 66 | if (preferences.begin(DEVICE_NAMESPACE, true)) 67 | { 68 | name = preferences.getString(IDENTITY_KEY, ADAPTER_NAME); 69 | preferences.end(); 70 | } 71 | return name; 72 | } 73 | 74 | String Adapter::getAdapterName() 75 | { 76 | return bridge.getAdapterName(); 77 | } 78 | 79 | void Adapter::init() 80 | { 81 | Log.traceln("Adapter: init"); 82 | pinMode(VBUS_SENSE_GPIO, INPUT); 83 | 84 | statusIndicator.init(); 85 | touchButton.init(); 86 | 87 | touchButton.setOnLongPressedCallback(std::bind(&Adapter::onLongPressed, this)); 88 | touchButton.setOnShortPressedCallback(std::bind(&Adapter::onShortPressed, this)); 89 | 90 | #if defined(ARDUINO_TINYPICO) 91 | touchSleepWakeUpEnable(CAPACITIVE_TOUCH_INPUT_PIN, TOUCH_THRESHOLD); 92 | #endif 93 | 94 | if (!bridge.init()) 95 | { 96 | Log.fatalln("FATAL: Bridge init failed !!!!!"); 97 | statusIndicator.set(error); 98 | while (true) 99 | { 100 | statusIndicator.render(); 101 | delay(10); 102 | } 103 | } 104 | 105 | // Make sure bridge is initialized first 106 | initBLEOtaService(); 107 | 108 | verifyFirmware(); 109 | } 110 | 111 | void Adapter::verifyFirmware() 112 | { 113 | Log.traceln("Checking firmware..."); 114 | const esp_partition_t *running = esp_ota_get_running_partition(); 115 | esp_ota_img_states_t ota_state; 116 | if (esp_ota_get_state_partition(running, &ota_state) == ESP_OK) 117 | { 118 | const char *otaState = ota_state == ESP_OTA_IMG_NEW ? "ESP_OTA_IMG_NEW" 119 | : ota_state == ESP_OTA_IMG_PENDING_VERIFY ? "ESP_OTA_IMG_PENDING_VERIFY" 120 | : ota_state == ESP_OTA_IMG_VALID ? "ESP_OTA_IMG_VALID" 121 | : ota_state == ESP_OTA_IMG_INVALID ? "ESP_OTA_IMG_INVALID" 122 | : ota_state == ESP_OTA_IMG_ABORTED ? "ESP_OTA_IMG_ABORTED" 123 | : "ESP_OTA_IMG_UNDEFINED"; 124 | Log.infoln("OTA state: %s", otaState); 125 | 126 | if (ota_state == ESP_OTA_IMG_PENDING_VERIFY) 127 | { 128 | if (esp_ota_mark_app_valid_cancel_rollback() == ESP_OK) 129 | { 130 | Log.infoln("App is valid, rollback cancelled successfully"); 131 | } 132 | else 133 | { 134 | Log.errorln("Failed to cancel rollback"); 135 | } 136 | } 137 | } 138 | else 139 | { 140 | Log.warningln("OTA partition has no record in OTA data"); 141 | } 142 | } 143 | 144 | void Adapter::initBLEOtaService() 145 | { 146 | Log.traceln("Adapter: init BLE OTA service"); 147 | 148 | // Create the BLE Service for OTA 149 | BLEService *pOtaService = bridge.getBLEServer()->createService(SERVICE_UUID_OTA); 150 | 151 | pOtaFlash = pOtaService->createCharacteristic( 152 | CHARACTERISTIC_UUID_OTA_FLASH, 153 | BLECharacteristic::PROPERTY_WRITE); 154 | 155 | pOtaIdentity = pOtaService->createCharacteristic( 156 | CHARACTERISTIC_UUID_OTA_IDENTITY, 157 | BLECharacteristic::PROPERTY_READ); 158 | 159 | pOtaFlash->addDescriptor(new BLE2902()); 160 | 161 | pOtaFlash->setAccessPermissions(ESP_GATT_PERM_WRITE); 162 | pOtaIdentity->setAccessPermissions(ESP_GATT_PERM_READ); 163 | 164 | pOtaFlash->setCallbacks(this); 165 | 166 | uint8_t identity[6] = {HARDWARE_BOARD, HARDWARE_VERSION_MAJOR, HARDWARE_VERSION_MINOR, FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, FIRMWARE_VERSION_PATCH}; 167 | pOtaIdentity->setValue(identity, 6); 168 | 169 | pOtaService->start(); 170 | } 171 | 172 | void Adapter::perform() 173 | { 174 | statusIndicator.render(); 175 | if (!adapterStateMachine.isInState(otaFlashState)) 176 | { 177 | touchButton.process(); 178 | lowBatteryWatchguard(); 179 | } 180 | adapterStateMachine.update(); 181 | } 182 | 183 | void Adapter::updateSendReceiveStatus() 184 | { 185 | if (bridge.isTx() && bridge.isRx()) 186 | { 187 | // The adapter is full duplex and can receive and send at same time. 188 | statusIndicator.set(duplex); 189 | } 190 | else if (bridge.isRx()) 191 | { 192 | statusIndicator.set(rx); 193 | } 194 | else if (bridge.isTx()) 195 | { 196 | statusIndicator.set(tx); 197 | } 198 | else 199 | { 200 | statusIndicator.set(ready); 201 | } 202 | } 203 | 204 | void Adapter::lowBatteryWatchguard() 205 | { 206 | #if defined(ARDUINO_TINYPICO) 207 | unsigned long now = millis(); 208 | if (now - lastBatteryCheck > BATTERY_WATCHGUARD_INTERVAL) 209 | { 210 | lastBatteryCheck = now; 211 | float level = tp.GetBatteryVoltage(); 212 | Log.infoln("Battery voltage %F V", level); 213 | if (level < BATTERY_MIN_VOLTAGE) 214 | { 215 | Log.warningln("Voltage too low, initiating shutdown"); 216 | shutdownReason = lowBattery; 217 | adapterStateMachine.transitionTo(shutdownState); 218 | } 219 | } 220 | #endif 221 | } 222 | 223 | bool Adapter::isUSBPower() 224 | { 225 | #if defined(ARDUINO_TINYPICO) 226 | // TinyPICO has a resistor divider on USB power line 227 | return (digitalRead(VBUS_SENSE_GPIO) != 0); 228 | #else 229 | return true; 230 | #endif 231 | } 232 | 233 | void Adapter::doShutdown() 234 | { 235 | Log.infoln("Going to deep sleep..."); 236 | bridge.disconnect(); 237 | statusIndicator.sleep(); 238 | esp_deep_sleep_start(); 239 | } 240 | 241 | /* 242 | Touch button Callbacks 243 | */ 244 | void Adapter::onLongPressed() 245 | { 246 | Log.infoln("Long pressed button, shutdown"); 247 | shutdownReason = userInitiated; 248 | statusIndicator.set(actionRegistered); 249 | unsigned long now = millis(); 250 | while (millis() - now < ACTION_FEEDBACK_DURATION) 251 | { 252 | statusIndicator.render(); 253 | delay(10); 254 | } 255 | adapterStateMachine.transitionTo(shutdownState); 256 | } 257 | 258 | void Adapter::onShortPressed() 259 | { 260 | Log.infoln("Short pressed button"); 261 | // Only show status when idle 262 | if (adapterStateMachine.isInState(idleState)) 263 | { 264 | Log.infoln("Showing battery status"); 265 | adapterStateMachine.transitionTo(showBatteryState); 266 | } 267 | } 268 | 269 | /* 270 | BLECharacteristicCallbacks 271 | */ 272 | void Adapter::onWrite(BLECharacteristic *pCharacteristic) 273 | { 274 | std::string rxData = pCharacteristic->getValue(); 275 | 276 | if (!adapterStateMachine.isInState(otaFlashState)) 277 | { 278 | Log.infoln("OTA: begin flash"); 279 | adapterStateMachine.immediateTransitionTo(otaFlashState); 280 | esp_ota_begin(esp_ota_get_next_update_partition(NULL), OTA_SIZE_UNKNOWN, &otaHandle); 281 | } 282 | 283 | if (rxData.length() > 0) 284 | { 285 | esp_ota_write(otaHandle, rxData.c_str(), rxData.length()); 286 | Log.infoln("OTA: written %i bytes", rxData.length()); 287 | } 288 | else 289 | { 290 | Log.infoln("OTA: end flash"); 291 | esp_ota_end(otaHandle); 292 | if (esp_ota_set_boot_partition(esp_ota_get_next_update_partition(NULL)) == ESP_OK) 293 | { 294 | Log.infoln("OTA: success, rebooting"); 295 | delay(2000); 296 | esp_restart(); 297 | } 298 | else 299 | { 300 | Log.errorln("OTA: failed"); 301 | } 302 | adapterStateMachine.transitionTo(idleState); 303 | } 304 | } 305 | 306 | void Adapter::onRead(BLECharacteristic *pCharacteristic) 307 | { 308 | Log.errorln("OTA: onRead!!!!"); 309 | } 310 | 311 | /* 312 | Adapter state machine 313 | */ 314 | void Adapter::idleEnter() 315 | { 316 | Log.traceln("Adapter: idle"); 317 | statusIndicator.set(disconnected); 318 | } 319 | 320 | void Adapter::idleUpdate() 321 | { 322 | 323 | bridge.perform(); 324 | 325 | if (bridge.isReady()) 326 | { 327 | adapterStateMachine.transitionTo(inUseState); 328 | } 329 | else if (bridge.btcConnected()) 330 | { 331 | statusIndicator.set(connected); 332 | } 333 | else if (bridge.btcDiscovery()) 334 | { 335 | statusIndicator.set(scanning); 336 | } 337 | else 338 | { 339 | statusIndicator.set(disconnected); 340 | } 341 | 342 | unsigned int idleTime = adapterStateMachine.timeInCurrentState(); 343 | if (idleTime > IDLE_TIME_TO_SLEEP) 344 | { 345 | Log.infoln("Idle for %i s", idleTime / 1000); 346 | 347 | // Do not auto shutdown when on USB power 348 | if (isUSBPower()) 349 | { 350 | Log.infoln("On USB power, stay awake"); 351 | // Reset the time in state 352 | adapterStateMachine.transitionTo(idleState); 353 | } 354 | else 355 | { 356 | Log.infoln("On battery power, initiating shutdown"); 357 | shutdownReason = idleTimeout; 358 | adapterStateMachine.transitionTo(shutdownState); 359 | } 360 | } 361 | 362 | if (Serial.available()) 363 | { 364 | char ch = Serial.read(); 365 | switch (ch) 366 | { 367 | case 'r': 368 | // Reboot device 369 | Serial.println("Rebooting..."); 370 | delay(2000); 371 | esp_restart(); 372 | break; 373 | case 'R': 374 | // Factory reset, clear paired radio 375 | Serial.println("Perform factory reset"); 376 | bridge.factoryReset(); 377 | adapterStateMachine.transitionTo(idleState); 378 | break; 379 | case 'v': 380 | // Decrease log verbosity by one level 381 | if (Log.getLevel() > LOG_LEVEL_SILENT) 382 | { 383 | Log.setLevel(Log.getLevel() - 1); 384 | } 385 | Serial.printf("Log level: %s\n", logLevels[Log.getLevel()]); 386 | break; 387 | case 'V': 388 | // Increase log verbosity by one level 389 | if (Log.getLevel() < LOG_LEVEL_VERBOSE) 390 | { 391 | Log.setLevel(Log.getLevel() + 1); 392 | } 393 | Serial.printf("Log level: %s\n", logLevels[Log.getLevel()]); 394 | break; 395 | case 'i': 396 | // Print identity 397 | Serial.printf("Identity: %s\n", getAdapterName().c_str()); 398 | break; 399 | case 'I': 400 | // Set new identity 401 | char buffer[32]; 402 | Preferences preferences; 403 | Serial.setTimeout(5000); 404 | int count = 0; 405 | count = Serial.readBytesUntil('\n', buffer, sizeof(buffer)-1); 406 | if (count == 0) 407 | { 408 | Serial.println("No identity provided"); 409 | if (preferences.begin(DEVICE_NAMESPACE, false)) 410 | { 411 | preferences.remove(IDENTITY_KEY); 412 | preferences.end(); 413 | Serial.println("Identity removed, rebooting..."); 414 | delay(2000); 415 | esp_restart(); 416 | } 417 | else 418 | { 419 | Serial.println("Failed to open preferences"); 420 | } 421 | } 422 | else 423 | { 424 | Serial.printf("Read %d characters\n", count); 425 | buffer[count] = '\0'; 426 | Serial.printf("New identity: %s\n", buffer); 427 | if (preferences.begin(DEVICE_NAMESPACE, false)) 428 | { 429 | int result = preferences.putString(IDENTITY_KEY, buffer); 430 | preferences.end(); 431 | if (result) 432 | { 433 | Serial.println("Saved, rebooting..."); 434 | delay(2000); 435 | esp_restart(); 436 | } 437 | else 438 | { 439 | Serial.println("Failed to save identity"); 440 | } 441 | } 442 | else 443 | { 444 | Serial.println("Failed to open preferences"); 445 | } 446 | } 447 | break; 448 | } 449 | } 450 | } 451 | 452 | void Adapter::idleExit() 453 | { 454 | } 455 | 456 | void Adapter::inUseEnter() 457 | { 458 | Log.traceln("Adapter: ready for use"); 459 | statusIndicator.set(ready); 460 | } 461 | 462 | void Adapter::inUseUpdate() 463 | { 464 | bridge.perform(); 465 | 466 | if (!bridge.isReady()) 467 | { 468 | adapterStateMachine.transitionTo(idleState); 469 | } 470 | else 471 | { 472 | updateSendReceiveStatus(); 473 | } 474 | } 475 | 476 | void Adapter::inUseExit() 477 | { 478 | } 479 | 480 | void Adapter::shutdownEnter() 481 | { 482 | Log.traceln("Adapter: shutdown"); 483 | switch (shutdownReason) 484 | { 485 | case userInitiated: 486 | case idleTimeout: 487 | statusIndicator.set(shutdown); 488 | break; 489 | 490 | case lowBattery: 491 | statusIndicator.set(batteryShutdown); 492 | break; 493 | } 494 | } 495 | 496 | void Adapter::shutdownUpdate() 497 | { 498 | if (adapterStateMachine.timeInCurrentState() > LINGER_TIME_BEFORE_SHUTDOWN) 499 | { 500 | doShutdown(); 501 | } 502 | } 503 | 504 | void Adapter::shutdownExit() 505 | { 506 | } 507 | 508 | void Adapter::showBatteryEnter() 509 | { 510 | #if defined(ARDUINO_TINYPICO) 511 | float level = tp.GetBatteryVoltage(); 512 | Log.infoln("Battery voltage %F V", level); 513 | if (level > BATTERY_FULL_VOLTAGE) 514 | { 515 | statusIndicator.set(batteryFull); 516 | } 517 | else 518 | { 519 | statusIndicator.set(batteryLow); 520 | } 521 | #endif 522 | } 523 | 524 | void Adapter::showBatteryUpdate() 525 | { 526 | if (adapterStateMachine.timeInCurrentState() >= SHOW_BATTERY_DURATION) 527 | { 528 | adapterStateMachine.transitionTo(idleState); 529 | } 530 | } 531 | 532 | void Adapter::showBatteryExit() 533 | { 534 | } 535 | 536 | void Adapter::otaFlashEnter() 537 | { 538 | Log.traceln("Adapter: OTA flash"); 539 | statusIndicator.set(otaFlash); 540 | bridge.disconnect(); 541 | } 542 | 543 | void Adapter::otaFlashUpdate() 544 | { 545 | // Do nothing, OTA is handled by BLECharacteristicCallbacks 546 | } 547 | 548 | void Adapter::otaFlashExit() 549 | { 550 | // If OTA flash was successful, the device will reboot 551 | } 552 | -------------------------------------------------------------------------------- /src/bb-link/Adapter.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #ifndef ADAPTER_H 3 | #define ADAPTER_H 4 | 5 | #include "Arduino.h" 6 | 7 | #if defined(ARDUINO_TINYPICO) 8 | #include 9 | #endif 10 | 11 | #include "StatusIndicatorBase.h" 12 | #include "StatusIndicatorDummy.h" 13 | #if defined(ARDUINO_TINYPICO) 14 | #include "StatusIndicator.h" 15 | #endif 16 | 17 | #include "TouchButtonBase.h" 18 | #include "TouchButtonDummy.h" 19 | #if defined(ARDUINO_TINYPICO) 20 | #include "TouchButton.h" 21 | #endif 22 | 23 | #include "Bridge.h" 24 | #include "FiniteStateMachine.h" 25 | 26 | #include 27 | 28 | #define CAPACITIVE_TOUCH_INPUT_PIN T0 // Pin 4 29 | #define ADAPTER_NAME "B.B. Link" // Changing this will prevent RadioMail to know that QSY is supported. 30 | 31 | #define FIRMWARE_VERSION_MAJOR 0 32 | #define FIRMWARE_VERSION_MINOR 7 33 | #define FIRMWARE_VERSION_PATCH 8 34 | 35 | #define DEVICE_NAMESPACE "bb-link-hw" 36 | #define IDENTITY_KEY "identity" 37 | 38 | enum hardware_board_t { 39 | hardware_board_unknown = 0, 40 | hardware_board_tinypico = 1, 41 | hardware_board_pico32 = 2 42 | }; 43 | 44 | #if defined(ARDUINO_TINYPICO) 45 | #define HARDWARE_BOARD hardware_board_tinypico 46 | #define HARDWARE_VERSION_MAJOR 3 47 | #define HARDWARE_VERSION_MINOR 0 48 | #endif 49 | 50 | #if defined(ARDUINO_ESP32_PICO) 51 | #define HARDWARE_BOARD hardware_board_pico32 52 | #define HARDWARE_VERSION_MAJOR 1 53 | #define HARDWARE_VERSION_MINOR 0 54 | #endif 55 | 56 | #if !defined(HARDWARE_BOARD) 57 | #error "Unknown hardware board. Please define HARDWARE_BOARD so that OTA updater knows what to do." 58 | #endif 59 | 60 | DECLARE_STATE(AdapterState); 61 | 62 | enum shutdown_reason_t { 63 | userInitiated = 0x00, 64 | idleTimeout = 0x01, 65 | lowBattery = 0x02 66 | }; 67 | 68 | class Adapter : public BLECharacteristicCallbacks { 69 | public: 70 | Adapter(); 71 | void init(); 72 | void perform(); 73 | Bridge bridge; 74 | String getAdapterName(); 75 | 76 | private: 77 | #if defined(ARDUINO_TINYPICO) 78 | TinyPICO tp = TinyPICO(); 79 | StatusIndicator statusIndicator = StatusIndicator(tp); 80 | TouchButton touchButton = TouchButton(CAPACITIVE_TOUCH_INPUT_PIN); 81 | #else 82 | StatusIndicatorDummy statusIndicator = StatusIndicatorDummy(); 83 | TouchButtonDummy touchButton = TouchButtonDummy(); 84 | #endif 85 | 86 | unsigned long lastBatteryCheck = 0; 87 | shutdown_reason_t shutdownReason; 88 | 89 | AdapterState idleState; 90 | AdapterState inUseState; 91 | AdapterState shutdownState; 92 | AdapterState showBatteryState; 93 | AdapterState otaFlashState; 94 | FSMT adapterStateMachine; 95 | 96 | BLECharacteristic *pOtaFlash; 97 | BLECharacteristic *pOtaIdentity; 98 | esp_ota_handle_t otaHandle = 0; 99 | 100 | void verifyFirmware(); 101 | void onLongPressed(); 102 | void onShortPressed(); 103 | void lowBatteryWatchguard(); 104 | void updateSendReceiveStatus(); 105 | bool isUSBPower(); 106 | void doShutdown(); 107 | 108 | void shutdownEnter(); 109 | void shutdownUpdate(); 110 | void shutdownExit(); 111 | void idleEnter(); 112 | void idleUpdate(); 113 | void idleExit(); 114 | void inUseEnter(); 115 | void inUseUpdate(); 116 | void inUseExit(); 117 | void showBatteryEnter(); 118 | void showBatteryUpdate(); 119 | void showBatteryExit(); 120 | void otaFlashEnter(); 121 | void otaFlashUpdate(); 122 | void otaFlashExit(); 123 | 124 | void initBLEOtaService(); 125 | 126 | void onWrite(BLECharacteristic *pCharacteristic); 127 | void onRead(BLECharacteristic *pCharacteristic); 128 | 129 | String fetchAdapterName(); 130 | }; 131 | 132 | #endif -------------------------------------------------------------------------------- /src/bb-link/Bridge.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "Bridge.h" 3 | #include "Adapter.h" 4 | #include 5 | 6 | /* 7 | More info about those magic numbers 8 | https://github.com/hessu/aprs-specs/blob/master/BLE-KISS-API.md 9 | */ 10 | #define SERVICE_UUID "00000001-ba2a-46c9-ae49-01b0961f68bb" 11 | #define TX_UUID "00000002-ba2a-46c9-ae49-01b0961f68bb" // From the perspective of the BLE app 12 | #define RX_UUID "00000003-ba2a-46c9-ae49-01b0961f68bb" // From the perspective of the BLE app 13 | 14 | #define BYTE_TRANSMIT_TIME 7 // Aprox time in ms to transmit a byte at 1200 baud 15 | #define RETRY_BTC_CONNECT_INTERVAL 15000 // Try to connect to radio Bluetooth Classic interface every x ms 16 | const size_t RX_BUF_SIZE = 1024; // BLE 4.2 supports up to 512. MTU is negotiated by client. 17 | 18 | const char PREF_RADIO_NAME[] = "radioName"; 19 | const char PREF_RADIO_ADDRESS[] = "radioAddress"; 20 | const char PREF_RIG_CTRL[] = "rigCtrl"; 21 | 22 | extern char _remote_name[ESP_BT_GAP_MAX_BDNAME_LEN + 1]; 23 | extern bool _isRemoteAddressSet; 24 | 25 | extern Adapter adapter; 26 | 27 | void connectToBluetooth(void *address) 28 | { 29 | Log.traceln("BTC: connecting to Bluetooth Classic interface"); 30 | adapter.bridge.btSerial.connect((uint8_t *)address, 0, ESP_SPP_SEC_NONE, ESP_SPP_ROLE_MASTER); 31 | vTaskDelete(NULL); 32 | } 33 | 34 | Bridge::Bridge(String adapterName) : bleDisconnectedState( 35 | [this] 36 | { this->bleDisconnectedEnter(); }, 37 | [this] 38 | { this->bleDisconnectedUpdate(); }, 39 | [this] 40 | { this->bleDisconnectedExit(); }), 41 | bleConnectedState( 42 | [this] 43 | { this->bleConnectedEnter(); }, 44 | [this] 45 | { this->bleConnectedUpdate(); }, 46 | [this] 47 | { this->bleConnectedExit(); }), 48 | bleStateMachine(bleDisconnectedState), 49 | btcDisconnectedState( 50 | [this] 51 | { this->btcDisconnectedEnter(); }, 52 | [this] 53 | { this->btcDisconnectedUpdate(); }, 54 | [this] 55 | { this->btcDisconnectedExit(); }), 56 | btcConnectedState( 57 | [this] 58 | { this->btcConnectedEnter(); }, 59 | [this] 60 | { this->btcConnectedUpdate(); }, 61 | [this] 62 | { this->btcConnectedExit(); }), 63 | btcDiscoveryState( 64 | [this] 65 | { this->btcDiscoveryEnter(); }, 66 | [this] 67 | { this->btcDiscoveryUpdate(); }, 68 | [this] 69 | { this->btcDiscoveryExit(); }), 70 | btcStateMachine(btcDisconnectedState), 71 | adapterName(adapterName), 72 | cmdQueue(10) 73 | { 74 | } 75 | 76 | bool Bridge::init() 77 | { 78 | Log.traceln("Bridge: init"); 79 | rxLingerUntil = millis(); 80 | txLingerUntil = millis(); 81 | 82 | preferences.begin(PREFERENCES_NAMESPACE, false); 83 | useRigControl = preferences.getBool(PREF_RIG_CTRL, true); 84 | preferences.end(); 85 | 86 | Log.infoln("Use rig control: %s", useRigControl ? "true" : "false"); 87 | 88 | bool ok = initBTC(); 89 | if (ok) 90 | { 91 | lookUpLastPairedDevice(); 92 | } 93 | 94 | return (initBLE() && ok); 95 | } 96 | 97 | void Bridge::perform() 98 | { 99 | bleStateMachine.update(); 100 | btcStateMachine.update(); 101 | 102 | uint8_t rxBuf[RX_BUF_SIZE]; 103 | size_t rxLen = 0; 104 | 105 | // Process any command received from BLE 106 | while (!cmdQueue.isEmpty()) 107 | { 108 | Log.traceln("BLE: dequeueing extended hardware command"); 109 | processingCmdQueue = true; 110 | extended_hw_cmd_t cmd = cmdQueue.dequeue(); 111 | processExtendedHardwareCommand(&cmd); 112 | } 113 | processingCmdQueue = false; 114 | 115 | if (isReady()) 116 | { 117 | // Buffer data available from BTC 118 | while (btSerial.available() && rxLen < mtuSize) 119 | { 120 | rxBuf[rxLen++] = btSerial.read(); 121 | } 122 | // Send data to BLE 123 | if (rxLen > 0) 124 | { 125 | Log.traceln("BLE < BTC: %i", rxLen); 126 | setRxLinger(BYTE_TRANSMIT_TIME * rxLen); 127 | pRx->setValue(rxBuf, rxLen); 128 | pRx->notify(); 129 | } 130 | } 131 | } 132 | 133 | void Bridge::disconnect() 134 | { 135 | clearAllPendingBTCData(); 136 | connectToPairedDevice = false; 137 | btSerial.disconnect(); 138 | } 139 | 140 | void Bridge::factoryReset() 141 | { 142 | disconnect(); 143 | clearPairedDevices(); 144 | preferences.begin(PREFERENCES_NAMESPACE, false); 145 | preferences.clear(); 146 | preferences.end(); 147 | useRigControl = true; 148 | connectToPairedDevice = false; 149 | 150 | // Restart the device 151 | esp_restart(); 152 | } 153 | 154 | String Bridge::getAdapterName() 155 | { 156 | return adapterName; 157 | } 158 | 159 | bool Bridge::isReady() 160 | { 161 | return (bleStateMachine.isInState(bleConnectedState) && btcStateMachine.isInState(btcConnectedState)); 162 | } 163 | 164 | bool Bridge::btcConnected() 165 | { 166 | return (btcStateMachine.isInState(btcConnectedState)); 167 | } 168 | 169 | bool Bridge::btcDiscovery() 170 | { 171 | return (btcStateMachine.isInState(btcDiscoveryState)); 172 | } 173 | 174 | bool Bridge::initBTC() 175 | { 176 | Log.traceln("Bridge: initBTC"); 177 | btSerial.enableSSP(); 178 | btSerial.setPin("0000"); 179 | 180 | btSerial.onConfirmRequest([this](uint32_t num) 181 | { this->onBTConfirmRequestCallback(num); }); 182 | 183 | btSerial.onAuthComplete([this](bool success) 184 | { this->onBTAuthCompleteCallback(success); }); 185 | 186 | if (!btSerial.begin(adapterName, true)) 187 | { 188 | Log.fatalln("FATAL: BTC init failed !!!!!"); 189 | return false; 190 | } 191 | else 192 | { 193 | return true; 194 | } 195 | } 196 | 197 | bool Bridge::isTx() 198 | { 199 | return (txLingerUntil > millis()); 200 | } 201 | 202 | bool Bridge::isRx() 203 | { 204 | return (rxLingerUntil > millis()); 205 | } 206 | 207 | bool Bridge::initBLE() 208 | { 209 | Log.traceln("Bridge: initBLE"); 210 | 211 | BLEDevice::init(adapterName.c_str()); 212 | pBLEServer = BLEDevice::createServer(); 213 | pBLEServer->setCallbacks(this); 214 | 215 | BLEService *pService = pBLEServer->createService(SERVICE_UUID); 216 | 217 | pTx = pService->createCharacteristic( 218 | TX_UUID, 219 | BLECharacteristic::PROPERTY_WRITE_NR); 220 | 221 | pRx = pService->createCharacteristic( 222 | RX_UUID, 223 | BLECharacteristic::PROPERTY_NOTIFY); 224 | 225 | pRx->addDescriptor(new BLE2902()); 226 | 227 | pRx->setAccessPermissions(ESP_GATT_PERM_READ); 228 | pTx->setAccessPermissions(ESP_GATT_PERM_WRITE); 229 | 230 | pTx->setCallbacks(this); 231 | pRx->setCallbacks(this); 232 | 233 | pService->start(); 234 | 235 | return true; 236 | } 237 | 238 | BLEServer *Bridge::getBLEServer() 239 | { 240 | return pBLEServer; 241 | } 242 | 243 | void Bridge::startAdvertisingBLE() 244 | { 245 | BLEAdvertising *pAdvertising = BLEDevice::getAdvertising(); 246 | pAdvertising->addServiceUUID(SERVICE_UUID); 247 | pAdvertising->setScanResponse(true); 248 | pAdvertising->setMinPreferred(0x06); // functions that help with iPhone connections issue 249 | BLEDevice::startAdvertising(); 250 | } 251 | 252 | void Bridge::stopAdvertisingBLE() 253 | { 254 | BLEDevice::stopAdvertising(); 255 | } 256 | 257 | void Bridge::clearAllPendingBTCData() 258 | { 259 | // Purge anything that may be pending 260 | if (btSerial.connected()) 261 | { 262 | btSerial.flush(); 263 | while (btSerial.available()) 264 | { 265 | btSerial.read(); 266 | } 267 | } 268 | } 269 | 270 | void Bridge::lookUpLastPairedDevice() 271 | { 272 | int count = esp_bt_gap_get_bond_device_num(); 273 | 274 | clearRemoteDeviceInfo(); 275 | 276 | if (!count) 277 | { 278 | Log.infoln("No paired device found"); 279 | clearStoredPairedDeviceInfo(); 280 | } 281 | else 282 | { 283 | Log.infoln("Found %i paired device", count); 284 | if (PAIR_MAX_DEVICES < count) 285 | { 286 | count = PAIR_MAX_DEVICES; 287 | } 288 | 289 | esp_err_t tError = esp_bt_gap_get_bond_device_list(&count, pairedDeviceBtAddr); 290 | 291 | if (ESP_OK == tError) 292 | { 293 | for (int i = 0; i < count; i++) 294 | { 295 | Log.infoln("Device %i, address: %s", i, BTAddress(pairedDeviceBtAddr[i]).toString().c_str()); 296 | 297 | // Normally there should only be one paired device at a time. Check the address matches 298 | // what was stored in preferences. 299 | preferences.begin(PREFERENCES_NAMESPACE, false); 300 | String radioName = preferences.getString(PREF_RADIO_NAME); 301 | u_int8_t radioAddress[ESP_BD_ADDR_LEN]; 302 | preferences.getBytes(PREF_RADIO_ADDRESS, radioAddress, ESP_BD_ADDR_LEN); 303 | preferences.end(); 304 | 305 | // Check if address match 306 | if (BTAddress(radioAddress).equals(BTAddress(pairedDeviceBtAddr[i]))) 307 | { 308 | Log.infoln("Found paired device name: %s", radioName); 309 | memcpy(remoteAddress, pairedDeviceBtAddr[i], ESP_BD_ADDR_LEN); 310 | strcpy(remoteName, radioName.c_str()); 311 | connectToPairedDevice = true; 312 | break; 313 | } 314 | else 315 | { 316 | Log.infoln("Found paired device name does not match saved, name: %s address: %s", radioName, BTAddress(radioAddress).toString().c_str()); 317 | clearPairedDevices(); 318 | break; 319 | } 320 | } 321 | } 322 | } 323 | } 324 | 325 | void Bridge::clearStoredPairedDeviceInfo() 326 | { 327 | preferences.begin(PREFERENCES_NAMESPACE, false); 328 | preferences.remove(PREF_RADIO_NAME); 329 | preferences.remove(PREF_RADIO_ADDRESS); 330 | preferences.end(); 331 | } 332 | 333 | void Bridge::clearRemoteDeviceInfo() 334 | { 335 | remoteName[0] = '\0'; 336 | memset(remoteAddress, 0, ESP_BD_ADDR_LEN); 337 | connectToPairedDevice = false; 338 | } 339 | 340 | void Bridge::clearPairedDevices() 341 | { 342 | int count = esp_bt_gap_get_bond_device_num(); 343 | 344 | clearStoredPairedDeviceInfo(); 345 | clearRemoteDeviceInfo(); 346 | 347 | Log.traceln("Clear paired devices"); 348 | 349 | if (!count) 350 | { 351 | Log.infoln("No paired device found"); 352 | } 353 | else 354 | { 355 | Log.infoln("Found %i paired device(s)", count); 356 | if (PAIR_MAX_DEVICES < count) 357 | { 358 | count = PAIR_MAX_DEVICES; 359 | } 360 | 361 | esp_err_t tError = esp_bt_gap_get_bond_device_list(&count, pairedDeviceBtAddr); 362 | 363 | if (ESP_OK == tError) 364 | { 365 | for (int i = 0; i < count; i++) 366 | { 367 | Log.infoln("Device %i, address: %s", i, BTAddress(pairedDeviceBtAddr[i]).toString().c_str()); 368 | 369 | esp_err_t tError = esp_bt_gap_remove_bond_device(pairedDeviceBtAddr[i]); 370 | if (ESP_OK == tError) 371 | { 372 | Log.traceln("Removed paired device"); 373 | } 374 | else 375 | { 376 | Log.errorln("Failed to remove paired device"); 377 | } 378 | } 379 | } 380 | } 381 | } 382 | 383 | void Bridge::setTxLinger(int linger) 384 | { 385 | unsigned long now = millis(); 386 | if (txLingerUntil < now) 387 | { 388 | txLingerUntil = now; 389 | } 390 | txLingerUntil += linger; 391 | } 392 | 393 | void Bridge::setRxLinger(int linger) 394 | { 395 | unsigned long now = millis(); 396 | if (rxLingerUntil < now) 397 | { 398 | rxLingerUntil = now; 399 | } 400 | rxLingerUntil += linger; 401 | } 402 | 403 | void Bridge::processExtendedHardwareCommand(extended_hw_cmd_t *cmd) 404 | { 405 | switch (cmd->action) 406 | { 407 | case extended_hw_set_frequency: 408 | { 409 | if (useRigControl) 410 | { 411 | Log.traceln("BTC: extended_hw_set_frequency"); 412 | previousFrequency = 0; 413 | 414 | if (vfo != vfoUnknown) 415 | { 416 | // At this point, we should always be in KISS mode. Exit KISS mode first so we don't have to wait for a timeout 417 | thd7x.exitKISS(); 418 | 419 | // Just to be sure 420 | if (thd7x.isKISSMode()) 421 | { 422 | Log.warningln("BTC: still in KISS mode?"); 423 | thd7x.exitKISS(); 424 | } 425 | 426 | Log.infoln("BTC: try to get baud rate"); 427 | if (thd7x.getBaudRate(&previousBaudRate)) 428 | { 429 | Log.infoln("BTC: previous baud rate: %d", previousBaudRate); 430 | } 431 | 432 | if (desiredBaudRate != baudRateUnknown && previousBaudRate != desiredBaudRate) 433 | { 434 | Log.infoln("BTC: set baud rate"); 435 | thd7x.setBaudRate(desiredBaudRate); 436 | } 437 | 438 | Log.infoln("BTC: try to get mode"); 439 | if (thd7x.getMode(vfo, &previousMode)) 440 | { 441 | Log.infoln("BTC: previous mode: %d", previousMode); 442 | if (previousMode != modeFM) 443 | { 444 | thd7x.setMode(vfo, modeFM); 445 | } 446 | } 447 | else 448 | { 449 | previousMode = modeUnknown; 450 | Log.errorln("BTC: failed to get previous mode"); 451 | } 452 | 453 | Log.infoln("BTC: try to set frequency: %d", cmd->data.uint32); 454 | 455 | if (thd7x.getFrequency(vfo, &previousFrequency)) 456 | { 457 | Log.infoln("BTC: previousFrequency: %l", previousFrequency); 458 | thd7x.setFrequency(vfo, cmd->data.uint32); 459 | } 460 | else 461 | { 462 | previousFrequency = 0; 463 | Log.errorln("BTC: failed to get previous frequency"); 464 | } 465 | 466 | // Show time 467 | thd7x.setTNC(vfo, tncKISS); 468 | } 469 | else 470 | { 471 | Log.warningln("BTC: VFO is unknown! Cowardly refusing to set frequency"); 472 | } 473 | } 474 | break; 475 | } 476 | case extended_hw_restore_frequency: 477 | { 478 | if (useRigControl) 479 | { 480 | Log.traceln("BTC: extended_hw_restore_frequency"); 481 | 482 | if (vfo != vfoUnknown && previousFrequency > 0) 483 | { 484 | // Always exit KISS mode first so we don't have to wait for a timeout 485 | thd7x.exitKISS(); 486 | 487 | // Just to be sure 488 | if (thd7x.isKISSMode()) 489 | { 490 | Log.warningln("BTC: still in KISS mode?"); 491 | thd7x.exitKISS(); 492 | } 493 | 494 | Log.infoln("BTC: try to restore frequency to %i", previousFrequency); 495 | thd7x.setFrequency(vfo, previousFrequency); 496 | previousFrequency = 0; 497 | 498 | if (previousMode != modeUnknown && previousMode != modeFM) 499 | { 500 | thd7x.setMode(vfo, previousMode); 501 | } 502 | 503 | if (desiredBaudRate != baudRateUnknown && previousBaudRate != desiredBaudRate) 504 | { 505 | Log.infoln("BTC: restore baud rate"); 506 | thd7x.setBaudRate(previousBaudRate); 507 | } 508 | 509 | // As long as BLE is connected, we want the radio to be in KISS mode 510 | thd7x.setTNC(vfo, tncKISS); 511 | } 512 | else 513 | { 514 | Log.infoln("BTC: no previous frequency to restore"); 515 | } 516 | } 517 | break; 518 | } 519 | case extended_hw_set_baud_rate: 520 | { 521 | Log.traceln("BTC: extended_hw_set_baud_rate"); 522 | /* 523 | Save the desired baud rate for now. We could set the radio right away 524 | but that would require getting out of KISS mode which is an expensive operation 525 | and leads to the radio beeping. It's also expected to be seldome as there are not 526 | many 9600 stations. 527 | Defeer setting the baud rate when changing frequency. This assumes that the host 528 | application sets the baud rate first. 529 | */ 530 | desiredBaudRate = static_cast(cmd->data.uint8); 531 | break; 532 | } 533 | case extended_hw_start_scan: 534 | { 535 | Log.traceln("BTC: extended_hw_start_scan"); 536 | btcStateMachine.transitionTo(btcDiscoveryState); 537 | break; 538 | } 539 | case extended_hw_stop_scan: 540 | { 541 | Log.traceln("BTC: extended_hw_stop_scan"); 542 | btcStateMachine.transitionTo(btcDisconnectedState); 543 | break; 544 | } 545 | case extended_hw_pair_with_device: 546 | { 547 | Log.traceln("BTC: extended_hw_pair_with_device"); 548 | btSerial.disconnect(); 549 | clearPairedDevices(); 550 | 551 | // iterate thru the list of devices found during scan 552 | // check if the device address is in the list and get its name 553 | btDeviceList = btSerial.getScanResults(); 554 | for (int i = 0; i < btDeviceList->getCount(); i++) 555 | { 556 | BTAdvertisedDevice *device = btDeviceList->getDevice(i); 557 | if (device->getAddress().equals(BTAddress(cmd->data.bytes))) 558 | { 559 | Log.infoln("BTC: Pairing with: %s %s", device->getName().c_str(), device->getAddress().toString().c_str()); 560 | memcpy(remoteAddress, device->getAddress().getNative(), sizeof(esp_bd_addr_t)); 561 | strcpy(remoteName, device->getName().c_str()); 562 | connectToPairedDevice = true; 563 | // force connections 564 | btcStateMachine.immediateTransitionTo(btcDisconnectedState); 565 | break; 566 | } 567 | } 568 | break; 569 | } 570 | case extended_hw_clear_paired_device: 571 | { 572 | Log.traceln("BTC: extended_hw_clear_paired_device"); 573 | btSerial.disconnect(); 574 | clearPairedDevices(); 575 | break; 576 | } 577 | case extended_hw_api_version: 578 | { 579 | Log.traceln("BTC: extended_hw_api_version"); 580 | reply16(EXTENDED_HW_CMD_API_VERSION, API_VERSION); 581 | break; 582 | } 583 | case extended_hw_firmware_version: 584 | { 585 | Log.traceln("BTC: extended_hw_firmware_version"); 586 | // create period delimited version string 587 | String version = String(FIRMWARE_VERSION_MAJOR) + "." + String(FIRMWARE_VERSION_MINOR) + "." + String(FIRMWARE_VERSION_PATCH); 588 | reply(EXTENDED_HW_CMD_FIRMWARE_VERSION, (uint8_t *)version.c_str(), strlen(version.c_str())); 589 | break; 590 | } 591 | case extended_hw_capabilities: 592 | { 593 | Log.traceln("BTC: extended_hw_capabilities"); 594 | uint16_t caps; 595 | caps = useRigControl ? CAP_RIG_CTRL : 0 | CAP_FIRMWARE_VERSION; 596 | reply16(EXTENDED_HW_CMD_CAPABILITIES, caps); 597 | break; 598 | } 599 | case extended_hw_get_paired_device: 600 | { 601 | Log.traceln("BTC: extended_hw_get_paired_device"); 602 | found_device_t paired; 603 | paired.connected = btcConnected() ? 0x01 : 0x00; 604 | memcpy(paired.address, remoteAddress, sizeof(esp_bd_addr_t)); 605 | strcpy(paired.name, remoteName); 606 | reply(EXTENDED_HW_CMD_GET_PAIRED_DEVICE, reinterpret_cast(&paired), 1 + sizeof(esp_bd_addr_t) + strlen(paired.name)); 607 | break; 608 | } 609 | case extended_hw_set_rig_ctrl: 610 | { 611 | Log.traceln("BTC: extended_hw_set_rig_ctrl"); 612 | if (cmd->data.uint8 == 0x00) 613 | { 614 | Log.infoln("BTC: set rig control off"); 615 | useRigControl = false; 616 | } 617 | else 618 | { 619 | Log.infoln("BTC: set rig control on"); 620 | useRigControl = true; 621 | } 622 | preferences.begin(PREFERENCES_NAMESPACE, false); 623 | preferences.putBool(PREF_RIG_CTRL, useRigControl); 624 | preferences.end(); 625 | break; 626 | } 627 | case extended_hw_factory_reset: 628 | { 629 | Log.traceln("BTC: extended_hw_factory_reset"); 630 | factoryReset(); 631 | break; 632 | } 633 | default: 634 | Log.errorln("BTC: unknown extended hardware command"); 635 | break; 636 | } 637 | } 638 | 639 | void Bridge::reply8(uint8_t cmd, uint8_t data) 640 | { 641 | uint8_t buffer[3] = {CMD_HARDWARE, cmd, data}; 642 | reply(buffer, 3); 643 | } 644 | 645 | void Bridge::reply16(uint8_t cmd, uint16_t data) 646 | { 647 | // Big endian 648 | uint8_t buffer[4] = {CMD_HARDWARE, cmd, uint8_t((data >> 8) & 0xFF), uint8_t(data & 0xFF)}; 649 | reply(buffer, 4); 650 | } 651 | 652 | void Bridge::reply(uint8_t cmd, uint8_t *data, size_t size) 653 | { 654 | uint8_t buffer[size + 2]; 655 | buffer[0] = CMD_HARDWARE; 656 | buffer[1] = cmd; 657 | memcpy(buffer + 2, data, size); 658 | reply(buffer, size + 2); 659 | } 660 | 661 | void Bridge::reply(uint8_t *response, size_t size) 662 | { 663 | uint8_t buffer[size * 2 + 2]; 664 | size_t bufferSize = sizeof(buffer); 665 | 666 | if (kissInterceptor.escape(response, size, buffer, &bufferSize)) 667 | { 668 | Log.infoln("BLE < (adapter): %i", bufferSize); 669 | pRx->setValue(buffer, bufferSize); 670 | pRx->notify(); 671 | } 672 | else 673 | { 674 | Log.errorln("Failed to escape response"); 675 | } 676 | } 677 | 678 | /* 679 | BLEServerCallbacks 680 | */ 681 | void Bridge::onConnect(BLEServer *pServer, esp_ble_gatts_cb_param_t *param) 682 | { 683 | Log.traceln("BLE: onConnect"); 684 | 685 | esp_ble_conn_update_params_t conn_params = {}; 686 | memcpy(conn_params.bda, param->connect.remote_bda, sizeof(esp_bd_addr_t)); 687 | conn_params.latency = 0; 688 | conn_params.max_int = 32; // *1.25ms = 40ms 689 | conn_params.min_int = 16; // *1.25ms = 20ms 690 | conn_params.timeout = 500; // *10ms = 5000ms 691 | // Start the update process 692 | esp_ble_gap_update_conn_params(&conn_params); 693 | 694 | bleStateMachine.transitionTo(bleConnectedState); 695 | } 696 | 697 | void Bridge::onDisconnect(BLEServer *pServer) 698 | { 699 | Log.traceln("BLE: onDisconnect"); 700 | bleStateMachine.transitionTo(bleDisconnectedState); 701 | } 702 | 703 | void Bridge::onMtuChanged(BLEServer *pServer, esp_ble_gatts_cb_param_t *param) 704 | { 705 | Log.traceln("BLE: onMtuChanged"); 706 | mtuSize = param->mtu.mtu; 707 | Log.infoln("New MTU size: %d", mtuSize); 708 | } 709 | 710 | /* 711 | BLECharacteristicCallbacks 712 | */ 713 | void Bridge::onWrite(BLECharacteristic *pCharacteristic) 714 | { 715 | std::string txValue = pCharacteristic->getValue(); 716 | 717 | if (txValue.length() > 0) 718 | { 719 | Log.traceln("BLE Rx: %i", txValue.length()); 720 | 721 | extended_hw_cmd_t cmd; 722 | if (kissInterceptor.extractExtendedHardwareCommand((uint8_t *)pCharacteristic->getData(), txValue.length(), &cmd)) 723 | { 724 | Log.traceln("BLE: queueing extended hardware command"); 725 | cmdQueue.enqueue(cmd); 726 | } 727 | else if (btcStateMachine.isInState(btcConnectedState)) 728 | { 729 | // Drop data if we're still processing cmds 730 | // This is to avoid sending data to the radio while it may not have changed frequency yet 731 | if (processingCmdQueue || !cmdQueue.isEmpty()) 732 | { 733 | Log.traceln("BLE: dropping data while still processing hw commands"); 734 | return; 735 | } 736 | 737 | Log.traceln("BLE > BTC: %i", txValue.length()); 738 | btSerial.write(pCharacteristic->getData(), txValue.length()); 739 | setTxLinger(BYTE_TRANSMIT_TIME * txValue.length()); 740 | } 741 | } 742 | } 743 | 744 | void Bridge::onRead(BLECharacteristic *pCharacteristic) 745 | { 746 | Log.errorln("BLE: onRead!!!!"); 747 | } 748 | 749 | /* 750 | BTC callbacks 751 | */ 752 | void Bridge::onBTConfirmRequestCallback(uint32_t numVal) 753 | { 754 | Log.infoln("Pairing pin: %l", numVal); 755 | btSerial.confirmReply(true); 756 | } 757 | 758 | void Bridge::onBTAuthCompleteCallback(boolean success) 759 | { 760 | if (success) 761 | { 762 | Log.infoln("Pairing success"); 763 | /* 764 | Save the name and address of the radio we just paired 765 | This so we can connect to it next time we start the device and 766 | display its name in the configuration app 767 | */ 768 | preferences.begin(PREFERENCES_NAMESPACE, false); 769 | preferences.putString(PREF_RADIO_NAME, remoteName); 770 | preferences.putBytes(PREF_RADIO_ADDRESS, remoteAddress, ESP_BD_ADDR_LEN); 771 | preferences.end(); 772 | } 773 | else 774 | { 775 | Log.warningln("Pairing failed, rejected by user"); 776 | } 777 | } 778 | 779 | /* 780 | BTC states 781 | */ 782 | void Bridge::btcDisconnectedEnter() 783 | { 784 | Log.infoln("BTC: disconnected"); 785 | if (connectToPairedDevice) 786 | { 787 | // The connect method in BT serial is blocking. Use a task to connect 788 | Log.infoln("BTC: attempt to connect to %s at %s", remoteName, BTAddress(remoteAddress).toString().c_str()); 789 | btSerial.disconnect(); // Just in case. If radio is already connected, reconnecting could lead to crash 790 | xTaskCreate( 791 | connectToBluetooth, // Task function 792 | "connectBT", // Task name 793 | 4096, // Stack size 794 | (void *)remoteAddress, // Task input parameter 795 | 1, // Priority of the task 796 | NULL // Task handle 797 | ); 798 | } 799 | } 800 | 801 | void Bridge::btcDisconnectedUpdate() 802 | { 803 | if (btSerial.connected()) 804 | { 805 | btcStateMachine.transitionTo(btcConnectedState); 806 | } 807 | 808 | if (btcStateMachine.timeInCurrentState() > RETRY_BTC_CONNECT_INTERVAL) 809 | { 810 | // Retry connection 811 | btcStateMachine.immediateTransitionTo(btcDisconnectedState); 812 | } 813 | } 814 | 815 | void Bridge::btcDisconnectedExit() 816 | { 817 | } 818 | 819 | void Bridge::btcConnectedEnter() 820 | { 821 | Log.infoln("BTC: connected"); 822 | clearAllPendingBTCData(); 823 | } 824 | 825 | void Bridge::btcConnectedUpdate() 826 | { 827 | if (!btSerial.connected()) 828 | { 829 | btcStateMachine.transitionTo(btcDisconnectedState); 830 | } 831 | } 832 | 833 | void Bridge::btcConnectedExit() 834 | { 835 | } 836 | 837 | void Bridge::btcDiscoveryEnter() 838 | { 839 | Log.traceln("BTC: discovery"); 840 | btSerial.disconnect(); 841 | 842 | btDeviceList = btSerial.getScanResults(); 843 | if (btSerial.discoverAsync([this](BTAdvertisedDevice *pDevice) 844 | { 845 | Log.infoln("Found device: %s", pDevice->toString().c_str()); 846 | /* 847 | Name: TH-D74, Address: 04:ee:03:61:2d:b0, cod: 0x620204, rssi: -55 848 | Name: TNC4 Mobilinkd, Address: 34:81:f4:aa:b2:dd, cod: 0x4c0300, rssi: -24 849 | Name: PicoAPRS, Address: 4c:75:25:65:29:82, cod: 0x001f00, rssi: -64 850 | Name: TH-D75, Address: 40:79:12:e4:65:44, cod: 0x620204, rssi: -62 851 | */ 852 | // Filter list to known Kenwood handsets capabilities signature 853 | // https://www.ampedrftech.com/cod.htm?result=620204 854 | if (pDevice->getCOD() == 0x620204) 855 | { 856 | found_device_t found; 857 | found.connected = 0x00; 858 | memcpy(found.address, pDevice->getAddress().getNative(), sizeof(esp_bd_addr_t)); 859 | strcpy(found.name, pDevice->getName().c_str()); 860 | reply(EXTENDED_HW_CMD_FOUND_DEVICE, reinterpret_cast(&found), 1 + sizeof(esp_bd_addr_t) + strlen(found.name)); 861 | } })) 862 | { 863 | Log.traceln("BTC: started scan"); 864 | } 865 | else 866 | { 867 | Log.errorln("BTC: failed to start scan"); 868 | } 869 | } 870 | 871 | void Bridge::btcDiscoveryUpdate() 872 | { 873 | } 874 | 875 | void Bridge::btcDiscoveryExit() 876 | { 877 | btSerial.discoverAsyncStop(); 878 | // Give time for the scan to stop and seems that sometimes the device 879 | // names don't come thru 880 | delay(500); 881 | } 882 | 883 | /* 884 | BLE states 885 | */ 886 | 887 | void Bridge::bleDisconnectedEnter() 888 | { 889 | Log.infoln("BLE: disconnected"); 890 | startAdvertisingBLE(); 891 | } 892 | 893 | void Bridge::bleDisconnectedUpdate() 894 | { 895 | } 896 | 897 | void Bridge::bleDisconnectedExit() 898 | { 899 | stopAdvertisingBLE(); 900 | } 901 | 902 | void Bridge::bleConnectedEnter() 903 | { 904 | Log.infoln("BLE: connected"); 905 | clearAllPendingBTCData(); 906 | 907 | if (useRigControl) 908 | { 909 | vfo = vfoUnknown; 910 | previousTNCMode = tncUnknown; 911 | 912 | // Make sure there is a radio to talk to 913 | if (btcStateMachine.isInState(btcConnectedState)) 914 | { 915 | /* 916 | * We don't know what TNC mode the radio is in. If the KISS TNC is already on, 917 | * we can't send any commands to the radio, so we have to exit it first. 918 | */ 919 | if (thd7x.isKISSMode()) 920 | { 921 | Log.traceln("BLE: already in KISS mode"); 922 | previousTNCMode = tncKISS; 923 | thd7x.exitKISS(); 924 | } 925 | 926 | // Figure out which VFO is active for KISS mode 927 | tnc_mode_t mode; 928 | if (thd7x.getTNC(&vfo, &mode)) 929 | { 930 | Log.infoln("BLE: vfo: %d", vfo); 931 | Log.infoln("BLE: mode: %d", mode); 932 | 933 | if (previousTNCMode == tncUnknown) 934 | { 935 | previousTNCMode = mode; 936 | } 937 | 938 | // As long as BLE is connected, we want the radio to be in KISS mode so application 939 | // can send data to the radio 940 | thd7x.setTNC(vfo, tncKISS); 941 | } 942 | else 943 | { 944 | Log.errorln("BLE: failed to get TNC mode and VFO!!!"); 945 | vfo = vfoUnknown; 946 | previousTNCMode = tncUnknown; 947 | } 948 | } 949 | } 950 | } 951 | 952 | void Bridge::bleConnectedUpdate() 953 | { 954 | } 955 | 956 | void Bridge::bleConnectedExit() 957 | { 958 | if (useRigControl) 959 | { 960 | // Make sure there is a radio to talk to 961 | if (btcStateMachine.isInState(btcConnectedState)) 962 | { 963 | if (previousTNCMode != tncKISS && previousTNCMode != tncUnknown && vfo != vfoUnknown) 964 | { 965 | Log.traceln("BLE: restoring initial KISS mode"); 966 | 967 | // Always exit KISS mode first so we don't have to wait for a timeout 968 | thd7x.exitKISS(); 969 | 970 | // Just to be sure 971 | if (thd7x.isKISSMode()) 972 | { 973 | Log.warningln("BLE: still in KISS mode?"); 974 | thd7x.exitKISS(); 975 | } 976 | 977 | thd7x.setTNC(vfo, previousTNCMode); 978 | } 979 | } 980 | } 981 | } -------------------------------------------------------------------------------- /src/bb-link/Bridge.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #ifndef BRIDGE_H 3 | #define BRIDGE_H 4 | 5 | #include "BluetoothSerial.h" 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | 13 | #include "THD7x.h" 14 | #include "FiniteStateMachine.h" 15 | #include "KISSInterceptor.h" 16 | 17 | #if !defined(CONFIG_BT_ENABLED) || !defined(CONFIG_BLUEDROID_ENABLED) 18 | #error Bluetooth is not enabled! Please run `make menuconfig` to and enable it 19 | #endif 20 | 21 | const uint16_t API_VERSION = 0x0100; // Used to check compatibility between adapter and config app 22 | const char PREFERENCES_NAMESPACE[] = "bb-link"; 23 | 24 | const uint16_t CAP_RIG_CTRL = 0x0010; 25 | const uint16_t CAP_FIRMWARE_VERSION = 0x0800; 26 | 27 | DECLARE_STATE(BLEState); 28 | DECLARE_STATE(BTCState); 29 | 30 | #define PAIR_MAX_DEVICES 10 31 | #define MAX_BTC_DEVICE_NAME_LEN 248 32 | 33 | class Bridge : public BLECharacteristicCallbacks, public BLEServerCallbacks 34 | { 35 | public: 36 | Bridge(String adapterName); 37 | bool init(); 38 | void perform(); 39 | bool isReady(); 40 | bool btcConnected(); 41 | bool btcDiscovery(); 42 | bool isTx(); 43 | bool isRx(); 44 | void clearPairedDevices(); 45 | void disconnect(); 46 | void factoryReset(); 47 | BLEServer * getBLEServer(); 48 | String getAdapterName(); 49 | 50 | BluetoothSerial btSerial; 51 | 52 | private: 53 | String adapterName; 54 | BTScanResults *btDeviceList; 55 | BLEServer *pBLEServer; 56 | 57 | BLECharacteristic *pTx; 58 | BLECharacteristic *pRx; 59 | uint16_t mtuSize = 512; 60 | 61 | THD7x thd7x = THD7x(btSerial); 62 | vfo_t vfo = vfoUnknown; 63 | uint32_t previousFrequency = 0; 64 | tnc_mode_t previousTNCMode = tncUnknown; 65 | baud_rate_t previousBaudRate = baudRateUnknown; 66 | baud_rate_t desiredBaudRate = baudRateUnknown; 67 | vfo_mode_t previousMode = modeUnknown; 68 | 69 | KISSInterceptor kissInterceptor = KISSInterceptor(); 70 | 71 | BLEState bleDisconnectedState; 72 | BLEState bleConnectedState; 73 | FSMT bleStateMachine; 74 | BTCState btcDisconnectedState; 75 | BTCState btcConnectedState; 76 | BTCState btcDiscoveryState; 77 | FSMT btcStateMachine; 78 | unsigned int txLingerUntil = 0; 79 | unsigned int rxLingerUntil = 0; 80 | unsigned int lastDeviceLookup = 0; 81 | 82 | uint8_t pairedDeviceBtAddr[PAIR_MAX_DEVICES][ESP_BD_ADDR_LEN]; 83 | uint8_t remoteAddress[ESP_BD_ADDR_LEN]; 84 | char remoteName[MAX_BTC_DEVICE_NAME_LEN]; 85 | bool connectToPairedDevice = false; 86 | bool useRigControl = true; 87 | 88 | Preferences preferences; 89 | ArduinoQueue cmdQueue; 90 | bool processingCmdQueue = false; 91 | 92 | bool initBTC(); 93 | bool initBLE(); 94 | void startAdvertisingBLE(); 95 | void stopAdvertisingBLE(); 96 | void clearAllPendingBTCData(); 97 | void setTxLinger(int linger); 98 | void setRxLinger(int linger); 99 | void lookUpLastPairedDevice(); 100 | void processExtendedHardwareCommand(extended_hw_cmd_t *cmd); 101 | void clearStoredPairedDeviceInfo(); 102 | void clearRemoteDeviceInfo(); 103 | 104 | void reply8(uint8_t cmd, uint8_t data); 105 | void reply16(uint8_t cmd, uint16_t data); 106 | void reply(uint8_t cmd, uint8_t *data, size_t size); 107 | void reply(uint8_t *response, size_t size); 108 | 109 | void onRead(BLECharacteristic *pCharacteristic); 110 | void onWrite(BLECharacteristic *pCharacteristic); 111 | 112 | void onBTConfirmRequestCallback(uint32_t numVal); 113 | void onBTAuthCompleteCallback(bool success); 114 | 115 | void onMtuChanged(BLEServer *pServer, esp_ble_gatts_cb_param_t *param); 116 | void onConnect(BLEServer *pServer, esp_ble_gatts_cb_param_t *param); 117 | void onDisconnect(BLEServer *pServer); 118 | 119 | void bleDisconnectedEnter(); 120 | void bleDisconnectedUpdate(); 121 | void bleDisconnectedExit(); 122 | void bleConnectedEnter(); 123 | void bleConnectedUpdate(); 124 | void bleConnectedExit(); 125 | 126 | void btcDisconnectedEnter(); 127 | void btcDisconnectedUpdate(); 128 | void btcDisconnectedExit(); 129 | void btcConnectedEnter(); 130 | void btcConnectedUpdate(); 131 | void btcConnectedExit(); 132 | void btcDiscoveryEnter(); 133 | void btcDiscoveryUpdate(); 134 | void btcDiscoveryExit(); 135 | }; 136 | 137 | #endif -------------------------------------------------------------------------------- /src/bb-link/FiniteStateMachine.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | || 3 | || @file FiniteStateMachine.cpp 4 | || @version 1.9 5 | || @original author Alexander Brevig 6 | || @contact alexanderbrevig@gmail.com 7 | || @Ported to Particle by Gustavo Gonnet 8 | || @contact gusgonnet@gmail.com 9 | || 10 | || @description 11 | || | Provide an easy way of making finite state machines 12 | || # 13 | || 14 | || @license 15 | || | This library is free software; you can redistribute it and/or 16 | || | modify it under the terms of the GNU Lesser General Public 17 | || | License as published by the Free Software Foundation; version 18 | || | 2.1 of the License. 19 | || | 20 | || | This library is distributed in the hope that it will be useful, 21 | || | but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | || | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 23 | || | Lesser General Public License for more details. 24 | || | 25 | || | You should have received a copy of the GNU Lesser General Public 26 | || | License along with this library; if not, write to the Free Software 27 | || | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 28 | || # 29 | || 30 | */ 31 | 32 | #include "FiniteStateMachine.h" 33 | #include 34 | 35 | // FINITE STATE 36 | State::State(StateFunction enterFunction, 37 | StateFunction updateFunction, 38 | StateFunction exitFunction) 39 | : userEnter(enterFunction), userUpdate(updateFunction), userExit(exitFunction) 40 | { 41 | } 42 | 43 | // what to do when entering this state 44 | void State::enter() 45 | { 46 | if (userEnter) 47 | { 48 | userEnter(); 49 | } 50 | } 51 | 52 | // what to do when this state updates 53 | void State::update() 54 | { 55 | if (userUpdate) 56 | { 57 | userUpdate(); 58 | } 59 | } 60 | 61 | // what to do when exiting this state 62 | void State::exit() 63 | { 64 | if (userExit) 65 | { 66 | userExit(); 67 | } 68 | } 69 | // END FINITE STATE 70 | 71 | // FINITE STATE MACHINE 72 | FiniteStateMachine::FiniteStateMachine(State ¤t) 73 | { 74 | needToTriggerEnter = true; 75 | currentState = nextState = ¤t; 76 | stateChangeTime = 0; 77 | } 78 | 79 | FiniteStateMachine &FiniteStateMachine::update() 80 | { 81 | // simulate a transition to the first state 82 | // this only happens the first time update is called 83 | if (needToTriggerEnter) 84 | { 85 | currentState->enter(); 86 | needToTriggerEnter = false; 87 | } 88 | else 89 | { 90 | if (currentState != nextState) 91 | { 92 | immediateTransitionTo(*nextState); 93 | } 94 | else 95 | { 96 | currentState->update(); 97 | } 98 | } 99 | return *this; 100 | } 101 | 102 | FiniteStateMachine &FiniteStateMachine::transitionTo(State &state) 103 | { 104 | nextState = &state; 105 | stateChangeTime = millis(); 106 | return *this; 107 | } 108 | 109 | FiniteStateMachine &FiniteStateMachine::immediateTransitionTo(State &state) 110 | { 111 | currentState->exit(); 112 | currentState = nextState = &state; 113 | currentState->enter(); 114 | stateChangeTime = millis(); 115 | return *this; 116 | } 117 | 118 | // return the current state 119 | State &FiniteStateMachine::getCurrentState() 120 | { 121 | return *currentState; 122 | } 123 | 124 | // check if state is equal to the currentState 125 | bool FiniteStateMachine::isInState(State &state) const 126 | { 127 | if (&state == currentState) 128 | { 129 | return true; 130 | } 131 | else 132 | { 133 | return false; 134 | } 135 | } 136 | 137 | unsigned long FiniteStateMachine::timeInCurrentState() 138 | { 139 | return millis() - stateChangeTime; 140 | } 141 | // END FINITE STATE MACHINE 142 | -------------------------------------------------------------------------------- /src/bb-link/FiniteStateMachine.h: -------------------------------------------------------------------------------- 1 | /* 2 | || 3 | || @file FiniteStateMachine.h 4 | || @version 1.9.0 5 | || @original author Alexander Brevig 6 | || @contact alexanderbrevig@gmail.com 7 | || @Ported to Particle by Gustavo Gonnet 8 | || @contact gusgonnet@gmail.com 9 | || 10 | || @description 11 | || | Provide an easy way of making finite state machines 12 | || # 13 | || 14 | || @changelog 15 | || | 1.9.0 2019-11-03- Julien Vanier : Add strongly typed variant 16 | || | 1.8.1 2016-01-07- Gustavo Gonnet : Pull request from Julien Vanier 17 | || | 1.8.0 2016-01-07- Gustavo Gonnet : Ported to Particle 18 | || | 1.7 2010-03-08- Alexander Brevig : Fixed a bug, constructor ran update, thanks to Ren? Press? 19 | || | 1.6 2010-03-08- Alexander Brevig : Added timeInCurrentState() , requested by sendhb 20 | || | 1.5 2009-11-29- Alexander Brevig : Fixed a bug, introduced by the below fix, thanks to Jon Hylands again... 21 | || | 1.4 2009-11-29- Alexander Brevig : Fixed a bug, enter gets triggered on the first state. Big thanks to Jon Hylands who pointed this out. 22 | || | 1.3 2009-11-01 - Alexander Brevig : Added getCurrentState : &State 23 | || | 1.3 2009-11-01 - Alexander Brevig : Added isInState : boolean, requested by Henry Herman 24 | || | 1.2 2009-05-18 - Alexander Brevig : enter and exit bug fix 25 | || | 1.1 2009-05-18 - Alexander Brevig : Added support for cascaded calls 26 | || | 1.0 2009-04-13 - Alexander Brevig : Initial Release 27 | || # 28 | || 29 | || @license 30 | || | This library is free software; you can redistribute it and/or 31 | || | modify it under the terms of the GNU Lesser General Public 32 | || | License as published by the Free Software Foundation; version 33 | || | 2.1 of the License. 34 | || | 35 | || | This library is distributed in the hope that it will be useful, 36 | || | but WITHOUT ANY WARRANTY; without even the implied warranty of 37 | || | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 38 | || | Lesser General Public License for more details. 39 | || | 40 | || | You should have received a copy of the GNU Lesser General Public 41 | || | License along with this library; if not, write to the Free Software 42 | || | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 43 | || # 44 | ---------------------( COPY )--------------------- 45 | This libraries .h file has been updated by Terry King to make it compatible with Ardino 1.0x 46 | 47 | (Example 1.03) and also earlier versions like 0023 48 | 49 | #include "WProgram.h" 50 | ...has been replaced by: 51 | 52 | #if defined(ARDUINO) && ARDUINO >= 100 53 | #include "Arduino.h" 54 | #else 55 | #include "WProgram.h" 56 | #endif 57 | 58 | terry@yourduino.com 59 | 02/07/2012 60 | -----------------( END COPY )---------------------- 61 | || 62 | */ 63 | 64 | #ifndef FINITESTATEMACHINE_H 65 | #define FINITESTATEMACHINE_H 66 | 67 | // #include "application.h" 68 | #include "Arduino.h" 69 | 70 | #define NO_ENTER (0) 71 | #define NO_UPDATE (0) 72 | #define NO_EXIT (0) 73 | 74 | #define FSM FiniteStateMachine 75 | 76 | typedef std::function StateFunction; 77 | 78 | // define the functionality of the states 79 | class State 80 | { 81 | public: 82 | State(StateFunction enterFunction = nullptr, 83 | StateFunction updateFunction = nullptr, 84 | StateFunction exitFunction = nullptr); 85 | 86 | void enter(); 87 | void update(); 88 | void exit(); 89 | 90 | private: 91 | StateFunction userEnter; 92 | StateFunction userUpdate; 93 | StateFunction userExit; 94 | }; 95 | 96 | // define the finite state machine functionality 97 | class FiniteStateMachine 98 | { 99 | public: 100 | FiniteStateMachine(State ¤t); 101 | 102 | FiniteStateMachine &update(); 103 | FiniteStateMachine &transitionTo(State &state); 104 | FiniteStateMachine &immediateTransitionTo(State &state); 105 | 106 | State &getCurrentState(); 107 | bool isInState(State &state) const; 108 | 109 | unsigned long timeInCurrentState(); 110 | 111 | private: 112 | bool needToTriggerEnter; 113 | State *currentState; 114 | State *nextState; 115 | unsigned long stateChangeTime; 116 | }; 117 | 118 | // Strongly typed variant 119 | 120 | #define DECLARE_STATE(StateT) \ 121 | class StateT : public State \ 122 | { \ 123 | public: \ 124 | StateT(StateFunction enterFunction, StateFunction updateFunction, StateFunction exitFunction) \ 125 | : State(enterFunction, updateFunction, exitFunction) {} \ 126 | } 127 | 128 | #define FSMT FiniteStateMachineTyped 129 | 130 | template 131 | class FiniteStateMachineTyped 132 | { 133 | public: 134 | FiniteStateMachineTyped(StateT ¤t) 135 | : stateMachine(current) {} 136 | 137 | FiniteStateMachineTyped &update() 138 | { 139 | return (FiniteStateMachineTyped &)stateMachine.update(); 140 | } 141 | FiniteStateMachineTyped &transitionTo(StateT &state) 142 | { 143 | return (FiniteStateMachineTyped &)stateMachine.transitionTo(state); 144 | } 145 | FiniteStateMachineTyped &immediateTransitionTo(StateT &state) 146 | { 147 | return (FiniteStateMachineTyped &)stateMachine.immediateTransitionTo(state); 148 | } 149 | 150 | StateT &getCurrentState() 151 | { 152 | return (StateT &)stateMachine.getCurrentState(); 153 | } 154 | bool isInState(StateT &state) const 155 | { 156 | return stateMachine.isInState(state); 157 | } 158 | 159 | unsigned long timeInCurrentState() 160 | { 161 | return stateMachine.timeInCurrentState(); 162 | } 163 | 164 | private: 165 | FiniteStateMachine stateMachine; 166 | }; 167 | 168 | #endif 169 | -------------------------------------------------------------------------------- /src/bb-link/KISSInterceptor.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "KISSInterceptor.h" 3 | 4 | static const uint8_t FEND = 0xC0; 5 | static const uint8_t FESC = 0xDB; 6 | static const uint8_t TFEND = 0xDC; 7 | static const uint8_t TFESC = 0xDD; 8 | 9 | KISSInterceptor::KISSInterceptor() 10 | { 11 | } 12 | 13 | bool KISSInterceptor::extractExtendedHardwareCommand(uint8_t *buffer, size_t size, extended_hw_cmd_t *cmd) 14 | { 15 | // Look for frame start 16 | for (int i = 0; i < size; i++) 17 | { 18 | if (buffer[i] == FEND) 19 | { 20 | // Fast check for hardware command 21 | if (buffer[i + 1] != CMD_HARDWARE) 22 | { 23 | break; 24 | } 25 | 26 | Log.traceln("Found SET HW KISS frame start at index %d", i); 27 | // Look for frame end 28 | for (int j = i + 1; j < size; j++) 29 | { 30 | if (buffer[j] == FEND) 31 | { 32 | Log.traceln("Found frame end at index %d", j); 33 | 34 | // Copy frame to new buffer 35 | uint8_t frame[j - i + 1]; 36 | memcpy(frame, &buffer[i], j - i + 1); 37 | 38 | // Unescape frame 39 | uint8_t unescapedBuffer[size]; 40 | size_t unescapedSize; 41 | if (!unescape(&buffer[i], size - i, unescapedBuffer, &unescapedSize)) 42 | { 43 | Log.errorln("Failed to unescape frame"); 44 | return false; 45 | } 46 | 47 | Log.traceln("Found valid hardware cmd"); 48 | 49 | char hexString[3 * unescapedSize + 1]; 50 | for (int k = 0; k < unescapedSize; k++) 51 | { 52 | sprintf(&hexString[3 * k], "%02X ", unescapedBuffer[k]); 53 | } 54 | 55 | // Display hex content of buffer 56 | Log.traceln("Frame: %s", hexString); 57 | 58 | switch (unescapedBuffer[i + 2]) 59 | { 60 | case EXTENDED_HW_CMD_SET_FREQUENCY: 61 | { 62 | uint32_t frequency = (unescapedBuffer[i + 3] << 24) | (unescapedBuffer[i + 4] << 16) | 63 | (unescapedBuffer[i + 5] << 8) | unescapedBuffer[i + 6]; 64 | Log.infoln("Set frequency cmd: %d", frequency); 65 | cmd->action = extended_hw_set_frequency; 66 | cmd->data.uint32 = frequency; 67 | return true; 68 | } 69 | case EXTENDED_HW_CMD_RESTORE_FREQUENCY: 70 | Log.infoln("Restore frequency cmd"); 71 | cmd->action = extended_hw_restore_frequency; 72 | return true; 73 | 74 | case EXTENDED_HW_CMD_SET_BAUD_RATE: 75 | { 76 | uint8_t baud_rate = unescapedBuffer[i + 3]; 77 | Log.infoln("Set baud rate cmd: %d", baud_rate); 78 | cmd->action = extended_hw_set_baud_rate; 79 | cmd->data.uint8 = baud_rate; 80 | return true; 81 | } 82 | case EXTENDED_HW_CMD_START_SCAN: 83 | Log.infoln("Start scan cmd"); 84 | cmd->action = extended_hw_start_scan; 85 | return true; 86 | 87 | case EXTENDED_HW_CMD_STOP_SCAN: 88 | Log.infoln("Stop scan cmd"); 89 | cmd->action = extended_hw_stop_scan; 90 | return true; 91 | 92 | case EXTENDED_HW_CMD_PAIR_WITH_DEVICE: 93 | Log.infoln("Pair with device cmd"); 94 | cmd->action = extended_hw_pair_with_device; 95 | memcpy(cmd->data.bytes, &unescapedBuffer[i + 3], ESP_BD_ADDR_LEN); 96 | return true; 97 | 98 | case EXTENDED_HW_CMD_CLEAR_PAIRED_DEVICE: 99 | Log.infoln("Clear paired device cmd"); 100 | cmd->action = extended_hw_clear_paired_device; 101 | return true; 102 | 103 | case EXTENDED_HW_CMD_FIRMWARE_VERSION: 104 | Log.infoln("Firmware version cmd"); 105 | cmd->action = extended_hw_firmware_version; 106 | return true; 107 | 108 | case EXTENDED_HW_CMD_CAPABILITIES: 109 | Log.infoln("Capabilities cmd"); 110 | cmd->action = extended_hw_capabilities; 111 | return true; 112 | 113 | case EXTENDED_HW_CMD_API_VERSION: 114 | Log.infoln("API version cmd"); 115 | cmd->action = extended_hw_api_version; 116 | return true; 117 | 118 | case EXTENDED_HW_CMD_GET_PAIRED_DEVICE: 119 | Log.infoln("Get paired device cmd"); 120 | cmd->action = extended_hw_get_paired_device; 121 | return true; 122 | 123 | case EXTENDED_HW_CMD_SET_RIG_CTRL: 124 | Log.infoln("Set rig control cmd"); 125 | cmd->action = extended_hw_set_rig_ctrl; 126 | cmd->data.uint8 = unescapedBuffer[i + 3]; 127 | return true; 128 | 129 | case EXTENDED_HW_CMD_FACTORY_RESET: 130 | Log.infoln("Factory reset cmd"); 131 | cmd->action = extended_hw_factory_reset; 132 | return true; 133 | 134 | default: 135 | Log.errorln("Unknown hardware cmd"); 136 | return false; 137 | } 138 | } 139 | } 140 | } 141 | } 142 | 143 | return false; 144 | } 145 | 146 | bool KISSInterceptor::unescape(uint8_t *buffer, size_t size, uint8_t *result, size_t *resultSize) 147 | { 148 | uint8_t *src = buffer; 149 | uint8_t *dst = result; 150 | while(src < buffer + size) 151 | { 152 | if (*src == FESC) 153 | { 154 | src++; 155 | if (*src == TFEND) 156 | { 157 | *dst = FEND; 158 | } 159 | else if (*src == TFESC) 160 | { 161 | *dst = FESC; 162 | } 163 | else 164 | { 165 | // Invalid escape sequence 166 | return false; 167 | } 168 | } 169 | else 170 | { 171 | *dst = *src; 172 | } 173 | src++; 174 | dst++; 175 | } 176 | *resultSize = dst - result; 177 | return true; 178 | } 179 | 180 | // Output buffer is assumed to be large enough to hold the escaped data 181 | bool KISSInterceptor::escape(uint8_t *buffer, size_t size, uint8_t *result, size_t *resultSize) 182 | { 183 | uint8_t *src = buffer; 184 | uint8_t *dst = result; 185 | size_t dstSize = *resultSize; 186 | 187 | if (dstSize < size * 2 + 2) 188 | { 189 | return false; 190 | } 191 | 192 | *dst = FEND; 193 | dst++; 194 | 195 | for (int i = 0; i < size; i++) 196 | { 197 | if (*src == FEND) 198 | { 199 | *dst = FESC; 200 | dst++; 201 | *dst = TFEND; 202 | } 203 | else if (*src == FESC) 204 | { 205 | *dst = FESC; 206 | dst++; 207 | *dst = TFESC; 208 | } 209 | else 210 | { 211 | *dst = *src; 212 | } 213 | src++; 214 | dst++; 215 | } 216 | 217 | *dst = FEND; 218 | dst++; 219 | 220 | *resultSize = dst - result; 221 | return true; 222 | } -------------------------------------------------------------------------------- /src/bb-link/KISSInterceptor.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #ifndef KISSINTERCEPTOR_H 3 | #define KISSINTERCEPTOR_H 4 | 5 | #include "Arduino.h" 6 | #ifndef EPOXY_DUINO 7 | #include "BLEDevice.h" 8 | #else 9 | #include "MockBLEDevice.h" 10 | #endif 11 | 12 | static const uint8_t CMD_HARDWARE = 0x06; 13 | 14 | static const uint8_t EXTENDED_HW_CMD_FIRMWARE_VERSION = 0x28; 15 | static const uint8_t EXTENDED_HW_CMD_CAPABILITIES = 0x7E; 16 | static const uint8_t EXTENDED_HW_CMD_API_VERSION = 0x7B; 17 | 18 | static const uint8_t EXTENDED_HW_CMD_SET_FREQUENCY = 0xEA; 19 | static const uint8_t EXTENDED_HW_CMD_RESTORE_FREQUENCY = 0xEB; 20 | 21 | static const uint8_t EXTENDED_HW_CMD_START_SCAN = 0xEC; 22 | static const uint8_t EXTENDED_HW_CMD_STOP_SCAN = 0xED; 23 | static const uint8_t EXTENDED_HW_CMD_FOUND_DEVICE = 0xEE; 24 | static const uint8_t EXTENDED_HW_CMD_PAIR_WITH_DEVICE = 0xEF; 25 | static const uint8_t EXTENDED_HW_CMD_CLEAR_PAIRED_DEVICE = 0xF0; 26 | static const uint8_t EXTENDED_HW_CMD_GET_PAIRED_DEVICE = 0xF1; 27 | static const uint8_t EXTENDED_HW_CMD_SET_RIG_CTRL = 0xF2; 28 | static const uint8_t EXTENDED_HW_CMD_FACTORY_RESET = 0xF3; 29 | 30 | static const uint8_t EXTENDED_HW_CMD_SET_BAUD_RATE = 0xF4; 31 | 32 | enum extended_hw_action_t : uint8_t 33 | { 34 | extended_hw_set_frequency = 0x00, 35 | extended_hw_restore_frequency = 0x01, 36 | extended_hw_start_scan = 0x02, 37 | extended_hw_stop_scan = 0x03, 38 | extended_hw_pair_with_device = 0x04, 39 | extended_hw_clear_paired_device = 0x05, 40 | extended_hw_found_device = 0x06, 41 | extended_hw_firmware_version = 0x07, 42 | extended_hw_capabilities = 0x08, 43 | extended_hw_api_version = 0x09, 44 | extended_hw_get_paired_device = 0x0A, 45 | extended_hw_set_rig_ctrl = 0x0B, 46 | extended_hw_factory_reset = 0x0C, 47 | extended_hw_set_baud_rate = 0x0D, 48 | extended_hw_unknown = 0xFF 49 | }; 50 | 51 | typedef union { 52 | uint32_t uint32; // 32-bit access 53 | uint8_t bytes[8]; // array access 54 | uint8_t uint8; 55 | } data_union_t; 56 | 57 | struct extended_hw_cmd_t { 58 | extended_hw_action_t action; 59 | data_union_t data; 60 | }; 61 | 62 | struct found_device_t 63 | { 64 | uint8_t connected; 65 | esp_bd_addr_t address; 66 | char name[32]; 67 | }; 68 | class KISSInterceptor 69 | { 70 | public: 71 | KISSInterceptor(); 72 | bool extractExtendedHardwareCommand(uint8_t *buffer, size_t size, extended_hw_cmd_t *cmd); 73 | bool escape(uint8_t *buffer, size_t size, uint8_t *result, size_t *resultSize); 74 | bool unescape(uint8_t *buffer, size_t size, uint8_t *unescapedBuffer, size_t *unescapedSize); 75 | 76 | private: 77 | }; 78 | 79 | #endif -------------------------------------------------------------------------------- /src/bb-link/MockBLEDevice.h: -------------------------------------------------------------------------------- 1 | #ifdef EPOXY_DUINO 2 | 3 | /// Bluetooth address length 4 | #define ESP_BD_ADDR_LEN 6 5 | 6 | /// Bluetooth device address 7 | typedef uint8_t esp_bd_addr_t[ESP_BD_ADDR_LEN]; 8 | 9 | #endif -------------------------------------------------------------------------------- /src/bb-link/MockBluetoothSerial.h: -------------------------------------------------------------------------------- 1 | #ifdef EPOXY_DUINO 2 | 3 | class MockBluetoothSerial 4 | { 5 | private: 6 | char readBuffer[256]; 7 | size_t readBufferLength = 0; 8 | char writeBuffer[256]; 9 | size_t writeBufferLength = 0; 10 | 11 | public: 12 | MockBluetoothSerial() 13 | { 14 | } 15 | 16 | void begin(const char * /* name */) 17 | { 18 | } 19 | 20 | int available() 21 | { 22 | return 0; 23 | } 24 | 25 | size_t write(uint8_t byte) 26 | { 27 | writeBuffer[writeBufferLength] = byte; 28 | writeBufferLength++; 29 | return 1; 30 | } 31 | 32 | int read() 33 | { 34 | return -1; // Example value, -1 indicates no data 35 | } 36 | 37 | int readBytesUntil(char /*terminator*/, char *buffer, size_t length) 38 | { 39 | if (readBufferLength > 0 && length > readBufferLength) 40 | { 41 | memcpy(buffer, readBuffer, readBufferLength); 42 | int result = readBufferLength; 43 | readBufferLength = 0; 44 | return result; 45 | } 46 | else 47 | { 48 | return 0; 49 | } 50 | } 51 | 52 | void flush() 53 | { 54 | } 55 | 56 | void setTimeout(unsigned long /*timeout*/) 57 | { 58 | } 59 | 60 | void print(const char *message) 61 | { 62 | memcpy(writeBuffer+writeBufferLength, message, strlen(message)); 63 | writeBufferLength += strlen(message); 64 | } 65 | 66 | size_t getWriteBuffer(char *buffer, size_t length) 67 | { 68 | if (writeBufferLength > length) 69 | { 70 | return -1; 71 | } 72 | memcpy(buffer, writeBuffer, writeBufferLength); 73 | int result = writeBufferLength; 74 | writeBufferLength = 0; 75 | return result; 76 | } 77 | 78 | void setMockReadValue(const char *value, size_t length) 79 | { 80 | memcpy(readBuffer, value, length); 81 | readBufferLength = length; 82 | } 83 | 84 | void setMockReadValue(const char *value) 85 | { 86 | setMockReadValue(value, strlen(value)); 87 | } 88 | }; 89 | 90 | #define BluetoothSerial MockBluetoothSerial 91 | 92 | #endif -------------------------------------------------------------------------------- /src/bb-link/StatusIndicator.h: -------------------------------------------------------------------------------- 1 | #include "StatusIndicatorBase.h" 2 | 3 | #include 4 | 5 | #include "math.h" 6 | 7 | #define STATUS_INDICATOR_DEFAULT_BRIGHTNESS 24 8 | 9 | #define FLASH_LED_ON_PERIOD_MS 60 10 | #define FLASH_LED_OFF_PERIOD_MS 600 11 | #define FAST_BLINK_LED_ON_PERIOD_MS 60 12 | #define FAST_BLINK_LED_OFF_PERIOD_MS 40 13 | 14 | class StatusIndicator : public StatusIndicatorBase 15 | { 16 | public: 17 | StatusIndicator(TinyPICO tp) : tp(tp) 18 | { 19 | } 20 | 21 | void init() 22 | { 23 | tp.DotStar_Clear(); 24 | tp.DotStar_SetPower(true); 25 | tp.DotStar_SetBrightness(STATUS_INDICATOR_DEFAULT_BRIGHTNESS); 26 | 27 | status = disconnected; 28 | lastUpdate = millis(); 29 | ledOn = false; 30 | currentColor = 0; 31 | currentBrightness = 0; 32 | } 33 | 34 | void set(status_t new_status) 35 | { 36 | status = new_status; 37 | } 38 | 39 | void setBrightnessMaybe(int brightness) 40 | { 41 | if (currentBrightness != brightness) 42 | { 43 | currentBrightness = brightness; 44 | tp.DotStar_SetBrightness(currentBrightness); 45 | tp.DotStar_Show(); // Setting brightness does not trigger show 46 | } 47 | } 48 | 49 | void setColorMaybe(u_int32_t color) 50 | { 51 | if (currentColor != color) 52 | { 53 | currentColor = color; 54 | tp.DotStar_SetPixelColor(currentColor); 55 | } 56 | } 57 | 58 | void render() 59 | { 60 | setColorMaybe(colorForStatus()); 61 | 62 | switch (modeForStatus()) 63 | { 64 | case fixed: 65 | setBrightnessMaybe(STATUS_INDICATOR_DEFAULT_BRIGHTNESS); 66 | ledOn = true; 67 | break; 68 | 69 | case breathe: 70 | { 71 | // https://thingpulse.com/breathing-leds-cracking-the-algorithm-behind-our-breathing-pattern/ 72 | float ledBreatheValue = (exp(sin(millis() / 2000.0 * PI)) - 0.36787944) * 108.0; 73 | setBrightnessMaybe(ledBreatheValue); 74 | } 75 | break; 76 | 77 | case flash: 78 | { 79 | unsigned long now = millis(); 80 | unsigned long delta = now - lastUpdate; 81 | if (ledOn) 82 | { 83 | if (delta >= FLASH_LED_ON_PERIOD_MS) 84 | { 85 | setBrightnessMaybe(0); 86 | ledOn = false; 87 | lastUpdate = now; 88 | } 89 | } 90 | else 91 | { 92 | if (delta >= FLASH_LED_OFF_PERIOD_MS) 93 | { 94 | setBrightnessMaybe(STATUS_INDICATOR_DEFAULT_BRIGHTNESS); 95 | ledOn = true; 96 | lastUpdate = now; 97 | } 98 | } 99 | } 100 | break; 101 | 102 | case fastBlink: 103 | { 104 | unsigned long now = millis(); 105 | unsigned long delta = now - lastUpdate; 106 | if (ledOn) 107 | { 108 | if (delta >= FAST_BLINK_LED_ON_PERIOD_MS) 109 | { 110 | setBrightnessMaybe(0); 111 | ledOn = false; 112 | lastUpdate = now; 113 | } 114 | } 115 | else 116 | { 117 | if (delta >= FAST_BLINK_LED_OFF_PERIOD_MS) 118 | { 119 | setBrightnessMaybe(STATUS_INDICATOR_DEFAULT_BRIGHTNESS); 120 | ledOn = true; 121 | lastUpdate = now; 122 | } 123 | } 124 | } 125 | break; 126 | 127 | case fadeOut: 128 | { 129 | unsigned long now = millis(); 130 | unsigned long delta = now - lastUpdate; 131 | if (delta >= 80) 132 | { 133 | if (currentBrightness == 0) 134 | { 135 | return; 136 | } 137 | setBrightnessMaybe(currentBrightness - 1); 138 | lastUpdate = now; 139 | } 140 | } 141 | break; 142 | } 143 | } 144 | 145 | void sleep() 146 | { 147 | tp.DotStar_Clear(); 148 | tp.DotStar_SetPower(false); 149 | } 150 | 151 | u_int32_t colorForStatus() 152 | { 153 | switch (status) 154 | { 155 | case disconnected: 156 | case shutdown: 157 | case actionRegistered: 158 | return 0xff8503; // Amber 159 | case batteryFull: 160 | case batteryLow: 161 | return 0x00FF00; 162 | case batteryShutdown: 163 | return 0xFF0000; 164 | case connected: 165 | case ready: 166 | case scanning: 167 | return 0x0000FF; 168 | case tx: 169 | return 0xFF0000; 170 | case rx: 171 | return 0x00FF00; 172 | case duplex: 173 | case otaFlash: 174 | return 0xA020F0; // Purple 175 | case error: 176 | return 0xFF0000; 177 | } 178 | } 179 | 180 | led_mode_t modeForStatus() 181 | { 182 | switch (status) 183 | { 184 | case connected: 185 | return breathe; 186 | case error: 187 | case scanning: 188 | return flash; 189 | case batteryLow: 190 | case batteryShutdown: 191 | case actionRegistered: 192 | case otaFlash: 193 | return fastBlink; 194 | case shutdown: 195 | return fadeOut; 196 | default: 197 | return fixed; 198 | } 199 | } 200 | 201 | private: 202 | TinyPICO tp; 203 | status_t status; 204 | bool ledOn; 205 | unsigned long lastUpdate; 206 | u_int32_t currentColor; 207 | int currentBrightness; 208 | }; -------------------------------------------------------------------------------- /src/bb-link/StatusIndicatorBase.h: -------------------------------------------------------------------------------- 1 | #ifndef STATUS_INDICATOR_BASE_H 2 | #define STATUS_INDICATOR_BASE_H 3 | 4 | enum status_t 5 | { 6 | disconnected = 0x00, 7 | connected = 0x01, 8 | ready = 0x02, 9 | tx = 0x03, 10 | rx = 0x04, 11 | duplex = 0x05, 12 | error = 0x06, 13 | shutdown = 0x07, 14 | batteryFull = 0x08, 15 | batteryLow = 0x09, 16 | batteryShutdown = 0x0A, 17 | actionRegistered = 0x0B, 18 | scanning = 0x0C, 19 | otaFlash = 0x0D 20 | }; 21 | 22 | enum led_mode_t 23 | { 24 | fixed = 0x00, 25 | breathe = 0x01, 26 | flash = 0x02, 27 | fastBlink = 0x03, 28 | fadeOut = 0x04 29 | }; 30 | 31 | class StatusIndicatorBase 32 | { 33 | public: 34 | virtual ~StatusIndicatorBase() {} 35 | 36 | virtual void init() = 0; 37 | virtual void set(status_t status) = 0; 38 | virtual void render() = 0; 39 | virtual void sleep() = 0; 40 | }; 41 | 42 | #endif -------------------------------------------------------------------------------- /src/bb-link/StatusIndicatorDummy.h: -------------------------------------------------------------------------------- 1 | 2 | #include "StatusIndicatorBase.h" 3 | 4 | class StatusIndicatorDummy : public StatusIndicatorBase 5 | { 6 | public: 7 | StatusIndicatorDummy() {} 8 | 9 | // Override init with an empty body 10 | void init() override {} 11 | 12 | // Override set with an empty body 13 | void set(status_t status) override {} 14 | 15 | // Override render with an empty body 16 | void render() override {} 17 | 18 | // Override sleep with an empty body 19 | void sleep() override {} 20 | }; 21 | -------------------------------------------------------------------------------- /src/bb-link/THD7x.cpp: -------------------------------------------------------------------------------- 1 | #include 2 | #include "THD7x.h" 3 | 4 | /* 5 | Commands: https://github.com/LA3QMA/TH-D74-Kenwood 6 | */ 7 | #define CMD_BUFFER_SIZE 32 8 | 9 | THD7x::THD7x(BluetoothSerial &btSerial) 10 | : btSerial(btSerial) { 11 | } 12 | 13 | /* 14 | https://github.com/LA3QMA/TH-D74-Kenwood/blob/master/commands/FQ.md 15 | */ 16 | 17 | void THD7x::setFrequency(vfo_t vfo, uint32_t frequency) { 18 | char command[CMD_BUFFER_SIZE]; 19 | sprintf(command, "FQ %d,%010d", vfo, frequency); 20 | char response[CMD_BUFFER_SIZE]; 21 | sendCmd(command, response, CMD_BUFFER_SIZE); 22 | } 23 | 24 | bool THD7x::getFrequency(vfo_t vfo, uint32_t *frequency) { 25 | char command[CMD_BUFFER_SIZE]; 26 | sprintf(command, "FQ %1d", vfo); 27 | char response[CMD_BUFFER_SIZE]; 28 | 29 | if (sendCmd(command, response, CMD_BUFFER_SIZE)) { 30 | // convert 10 digit ascii string value to int 31 | *frequency = atoi(&response[5]); 32 | return true; 33 | } 34 | return false; 35 | } 36 | 37 | /* 38 | https://github.com/LA3QMA/TH-D74-Kenwood/blob/master/commands/AS.md 39 | */ 40 | void THD7x::setBaudRate(baud_rate_t baud_rate) 41 | { 42 | char command[CMD_BUFFER_SIZE]; 43 | sprintf(command, "AS %1d", baud_rate); 44 | char response[CMD_BUFFER_SIZE]; 45 | sendCmd(command, response, CMD_BUFFER_SIZE); 46 | } 47 | 48 | bool THD7x::getBaudRate(baud_rate_t *baud_rate) 49 | { 50 | char response[CMD_BUFFER_SIZE]; 51 | if (sendCmd("AS", response, CMD_BUFFER_SIZE)) { 52 | // convert ascii char to int 53 | *baud_rate = static_cast(response[3] - '0'); 54 | return true; 55 | } 56 | return false; 57 | } 58 | 59 | /* 60 | https://github.com/LA3QMA/TH-D74-Kenwood/blob/master/commands/TN.md 61 | */ 62 | 63 | void THD7x::setTNC(vfo_t vfo, tnc_mode_t mode) { 64 | char command[CMD_BUFFER_SIZE]; 65 | sprintf(command, "TN %d,%d", mode, vfo); 66 | char response[CMD_BUFFER_SIZE]; 67 | sendCmd(command, response, CMD_BUFFER_SIZE); 68 | } 69 | 70 | bool THD7x::getTNC(vfo_t *vfo, tnc_mode_t *mode) { 71 | char response[CMD_BUFFER_SIZE]; 72 | if (sendCmd("TN", response, CMD_BUFFER_SIZE)) { 73 | // convert ascii char to int 74 | *vfo = static_cast(response[5] - '0'); 75 | *mode = static_cast(response[3] - '0'); 76 | return true; 77 | } 78 | return false; 79 | } 80 | 81 | /* 82 | https://github.com/LA3QMA/TH-D74-Kenwood/blob/master/commands/MD.md 83 | */ 84 | void THD7x::setMode(vfo_t vfo, vfo_mode_t mode) { 85 | char command[CMD_BUFFER_SIZE]; 86 | sprintf(command, "MD %d,%d", vfo, mode); 87 | char response[CMD_BUFFER_SIZE]; 88 | sendCmd(command, response, CMD_BUFFER_SIZE); 89 | } 90 | 91 | bool THD7x::getMode(vfo_t vfo, vfo_mode_t *mode) { 92 | char response[CMD_BUFFER_SIZE]; 93 | char command[CMD_BUFFER_SIZE]; 94 | sprintf(command, "MD %d", vfo); 95 | if (sendCmd(command, response, CMD_BUFFER_SIZE)) { 96 | // convert ascii char to int 97 | *mode = static_cast(response[5] - '0'); 98 | return true; 99 | } 100 | return false; 101 | } 102 | 103 | /* 104 | https://github.com/LA3QMA/TH-D74-Kenwood/blob/master/commands/ID.md 105 | */ 106 | bool THD7x::getRadioId(char *radioId, int len) { 107 | char response[CMD_BUFFER_SIZE]; 108 | if (sendCmd("ID", response, CMD_BUFFER_SIZE)) { 109 | strncpy(radioId, (const char *)&response[3], len); 110 | return true; 111 | } 112 | return false; 113 | } 114 | 115 | void THD7x::exitKISS() { 116 | // https://www.ax25.net/kiss.aspx 117 | const unsigned char exitKISSSequence[] = { 0xC0, 0xFF, 0xC0 }; 118 | Log.traceln("(adapter) > BTC: KISS exit sequence"); 119 | for (unsigned char byte : exitKISSSequence) { 120 | btSerial.write(byte); 121 | } 122 | btSerial.flush(); 123 | } 124 | 125 | bool THD7x::isKISSMode() { 126 | // Send a simple command to see if we get a response. BT queries the 127 | // bluetooth mode, which should always be on since we're connected. 128 | char response[CMD_BUFFER_SIZE]; 129 | return !sendCmd("BT", response, CMD_BUFFER_SIZE); 130 | } 131 | 132 | bool THD7x::sendCmd(const char *cmd, char *response, size_t responseLen, int retry) { 133 | Log.traceln("(adapter) > BTC: %s", cmd); 134 | btSerial.flush(); 135 | btSerial.print(cmd); 136 | btSerial.print("\r"); 137 | btSerial.flush(); 138 | btSerial.setTimeout(1000); 139 | size_t lenRead = btSerial.readBytesUntil('\r', response, responseLen - 1); 140 | if (lenRead == 0) { 141 | Log.infoln("No response from command %s", cmd); 142 | return false; 143 | } 144 | if (response[0] == '?') { 145 | Log.warningln("Error response from command %s", cmd); 146 | if (retry--) { 147 | Log.infoln("Retry attempt left %i", retry); 148 | delay(200); 149 | return sendCmd(cmd, response, responseLen, retry); 150 | } else { 151 | Log.warningln("No more retries"); 152 | return false; 153 | } 154 | } 155 | response[lenRead] = '\0'; 156 | Log.traceln("(adapter) < BTC: %s", response); 157 | return (response[0] == cmd[0] && response[1] == cmd[1]); 158 | } 159 | -------------------------------------------------------------------------------- /src/bb-link/THD7x.h: -------------------------------------------------------------------------------- 1 | #pragma once 2 | #ifndef THD7x_H 3 | #define THD7x_H 4 | 5 | #ifndef EPOXY_DUINO 6 | #include "BluetoothSerial.h" 7 | #else 8 | #include "MockBluetoothSerial.h" 9 | #endif 10 | 11 | enum vfo_t : int 12 | { 13 | vfoA = 0x00, 14 | vfoB = 0x01, 15 | vfoUnknown = 0xFF 16 | }; 17 | 18 | enum tnc_mode_t : int 19 | { 20 | tncOff = 0x00, 21 | tncAPRS = 0x01, 22 | tncKISS = 0x02, 23 | tncUnknown = 0xFF 24 | }; 25 | 26 | enum baud_rate_t : int 27 | { 28 | baudRate1200 = 0x00, 29 | baudRate9600 = 0x01, 30 | baudRateUnknown = 0xFF 31 | }; 32 | 33 | enum vfo_mode_t : int 34 | { 35 | modeFM = 0x00, 36 | modeDV = 0x01, 37 | modeAM = 0x02, 38 | modeLSB = 0x03, 39 | modeUSB = 0x04, 40 | modeCW = 0x05, 41 | modeNFM = 0x06, 42 | modeDR = 0x07, 43 | modeWFM = 0x08, 44 | modeRCW = 0x09, 45 | modeUnknown = 0xFF 46 | }; 47 | 48 | class THD7x 49 | { 50 | public: 51 | THD7x(BluetoothSerial &btSerial); 52 | 53 | void setFrequency(vfo_t vfo, uint32_t frequency); 54 | bool getFrequency(vfo_t vfo, uint32_t *frequency); 55 | 56 | void setBaudRate(baud_rate_t baud_rate); 57 | bool getBaudRate(baud_rate_t *baud_rate); 58 | 59 | void setMode(vfo_t vfo, vfo_mode_t mode); 60 | bool getMode(vfo_t vfo, vfo_mode_t *mode); 61 | 62 | void setTNC(vfo_t vfo, tnc_mode_t mode); 63 | bool getTNC(vfo_t *vfo, tnc_mode_t *mode); 64 | 65 | bool getRadioId(char *radioId, int len); 66 | 67 | void exitKISS(); 68 | bool isKISSMode(); 69 | 70 | bool sendCmd(const char *command, char *response, size_t len, int retry=3); 71 | 72 | private: 73 | BluetoothSerial &btSerial; 74 | }; 75 | 76 | #endif -------------------------------------------------------------------------------- /src/bb-link/TouchButton.h: -------------------------------------------------------------------------------- 1 | #include "TouchButtonBase.h" 2 | #include "Arduino.h" 3 | 4 | #define LONG_PRESS_MS 2000 5 | #define SHORT_PRESS_MS 500 6 | class TouchButton : public TouchButtonBase 7 | { 8 | public: 9 | TouchButton(int buttonPin) : buttonPin(buttonPin), onLongPressedCallback(nullptr), onShortPressedCallback(nullptr), firstTouchMillis(0) {} 10 | 11 | void init() override 12 | { 13 | firstTouchMillis = 0; 14 | } 15 | 16 | void process() override 17 | { 18 | int touchValue = touchRead(buttonPin); 19 | // Log.infoln("Touch value %i", touchValue); 20 | if (touchValue < TOUCH_THRESHOLD) 21 | { 22 | // Button touched 23 | if (firstTouchMillis == 0) 24 | { 25 | firstTouchMillis = millis(); 26 | } 27 | else if (millis() - firstTouchMillis >= LONG_PRESS_MS) 28 | { 29 | firstTouchMillis = 0; 30 | 31 | // Fire long press 32 | if (onLongPressedCallback != nullptr) 33 | { 34 | onLongPressedCallback(); 35 | } 36 | } 37 | } 38 | else 39 | { 40 | if (firstTouchMillis > 0) 41 | { 42 | if (millis() - firstTouchMillis >= SHORT_PRESS_MS) 43 | if (onShortPressedCallback != nullptr) 44 | { 45 | onShortPressedCallback(); 46 | } 47 | } 48 | 49 | firstTouchMillis = 0; 50 | } 51 | } 52 | 53 | void setOnLongPressedCallback(std::function callback) override 54 | { 55 | onLongPressedCallback = callback; 56 | } 57 | 58 | void setOnShortPressedCallback(std::function callback) override 59 | { 60 | onShortPressedCallback = callback; 61 | } 62 | 63 | private: 64 | int buttonPin; 65 | std::function onLongPressedCallback; 66 | std::function onShortPressedCallback; 67 | unsigned long firstTouchMillis; 68 | }; -------------------------------------------------------------------------------- /src/bb-link/TouchButtonBase.h: -------------------------------------------------------------------------------- 1 | #ifndef BASE_TOUCH_BUTTON_H 2 | #define BASE_TOUCH_BUTTON_H 3 | 4 | #include 5 | 6 | /* 7 | Arrived at this by experimentation. On battery power, the lack of ground plane 8 | require a higher threshold to register 9 | */ 10 | #define TOUCH_THRESHOLD 75 11 | 12 | class TouchButtonBase { 13 | public: 14 | // Make the destructor virtual since we have virtual functions 15 | virtual ~TouchButtonBase() {} 16 | 17 | virtual void init() = 0; 18 | 19 | virtual void process() = 0; 20 | 21 | virtual void setOnLongPressedCallback(std::function callback) = 0; 22 | 23 | virtual void setOnShortPressedCallback(std::function callback) = 0; 24 | }; 25 | 26 | #endif // BASE_TOUCH_BUTTON_H -------------------------------------------------------------------------------- /src/bb-link/TouchButtonDummy.h: -------------------------------------------------------------------------------- 1 | #include "TouchButtonBase.h" 2 | 3 | class TouchButtonDummy : public TouchButtonBase { 4 | public: 5 | void init() override {} 6 | void process() override {} 7 | void setOnLongPressedCallback(std::function callback) override {} 8 | void setOnShortPressedCallback(std::function callback) override {} 9 | }; -------------------------------------------------------------------------------- /src/bb-link/bb-link.ino: -------------------------------------------------------------------------------- 1 | /* 2 | (c) 2024 Island Magic Co. All Rights Reserved. 3 | 4 | This program is free software: you can redistribute it and/or modify 5 | it under the terms of the GNU General Public License as published by 6 | the Free Software Foundation, either version 3 of the License, or 7 | (at your option) any later version. 8 | 9 | This program is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | GNU General Public License for more details. 13 | */ 14 | 15 | #include 16 | const char *logLevels[] = {"OFF", "FATAL", "ERROR", "WARNING", "INFO", "TRACE", "VERBOSE"}; 17 | 18 | #include "Adapter.h" 19 | Adapter *adapter = nullptr; 20 | 21 | void setup() 22 | { 23 | // Slow down to save power 24 | setCpuFrequencyMhz(80); // 240, 160, 80 25 | 26 | Serial.begin(115200); 27 | delay(1000); 28 | 29 | // LOG_LEVEL_FATAL, LOG_LEVEL_ERROR, LOG_LEVEL_WARNING, LOG_LEVEL_INFO, LOG_LEVEL_TRACE, LOG_LEVEL_VERBOSE 30 | Log.begin(LOG_LEVEL_INFO, &Serial); 31 | Log.setPrefix(logPrintPrefix); 32 | 33 | adapter = new Adapter(); 34 | 35 | Serial.println("\n ___ ___ _ _ _"); 36 | Serial.println("| _ ) | _ ) | | (_)_ _ | |__"); 37 | Serial.println("| _ \\_| _ \\_ | |__| | ' \\| / /"); 38 | Serial.println("|___(_)___(_) |____|_|_||_|_\\_\\\n"); 39 | 40 | Serial.printf("Booting up %s v%d.%d.%d on %s v%d.%d\n\n", adapter->getAdapterName().c_str(), FIRMWARE_VERSION_MAJOR, FIRMWARE_VERSION_MINOR, FIRMWARE_VERSION_PATCH, HARDWARE_BOARD == hardware_board_tinypico ? "TinyPICO" : "Pico32", HARDWARE_VERSION_MAJOR, HARDWARE_VERSION_MINOR); 41 | 42 | Serial.printf("Heap free: %d, usage: %d %%\n", ESP.getFreeHeap(), 100 - (ESP.getFreeHeap() * 100) / ESP.getHeapSize()); 43 | // ESP.getFreeSketchSpace() returns the total sketch space 44 | Serial.printf("Flash size: %d, total: %d, usage: %d %%\n", ESP.getSketchSize(), ESP.getFreeSketchSpace(), (ESP.getSketchSize() * 100) / ESP.getFreeSketchSpace()); 45 | Serial.printf("CPU clock: %d Mhz\n", getCpuFrequencyMhz()); 46 | Serial.printf("Log level: %s\n", logLevels[Log.getLevel()]); 47 | 48 | adapter->init(); 49 | } 50 | 51 | void loop() 52 | { 53 | adapter->perform(); 54 | } 55 | 56 | void logPrintPrefix(Print* _logOutput, int logLevel) 57 | { 58 | logPrintSetColor(_logOutput, logLevel); 59 | logPrintTimestamp(_logOutput); 60 | } 61 | 62 | void logPrintSetColor(Print* _logOutput, int logLevel) 63 | { 64 | switch (logLevel) 65 | { 66 | case LOG_LEVEL_FATAL: 67 | _logOutput->print("\033[31m"); // red 68 | break; 69 | case LOG_LEVEL_ERROR: 70 | _logOutput->print("\033[31m"); // red 71 | break; 72 | case LOG_LEVEL_WARNING: 73 | _logOutput->print("\033[33m"); // yellow 74 | break; 75 | case LOG_LEVEL_INFO: 76 | _logOutput->print("\033[0m"); // default 77 | break; 78 | case LOG_LEVEL_TRACE: 79 | _logOutput->print("\033[36m"); // cyan 80 | } 81 | } 82 | 83 | void logPrintTimestamp(Print* _logOutput) 84 | { 85 | const unsigned long MSECS_PER_SEC = 1000; 86 | const unsigned long SECS_PER_MIN = 60; 87 | const unsigned long SECS_PER_HOUR = 3600; 88 | const unsigned long SECS_PER_DAY = 86400; 89 | const unsigned long msecs = millis(); 90 | const unsigned long secs = msecs / MSECS_PER_SEC; 91 | const unsigned long milliseconds = msecs % MSECS_PER_SEC; 92 | const unsigned long seconds = secs % SECS_PER_MIN ; 93 | const unsigned long minutes = (secs / SECS_PER_MIN) % SECS_PER_MIN; 94 | const unsigned long hours = (secs % SECS_PER_DAY) / SECS_PER_HOUR; 95 | 96 | char timestamp[20]; 97 | sprintf(timestamp, "%02d:%02d:%02d.%03d ", hours, minutes, seconds, milliseconds); 98 | 99 | _logOutput->print(timestamp); 100 | } -------------------------------------------------------------------------------- /tests/KISSInterceptorTest/KISSInterceptorTest.ino: -------------------------------------------------------------------------------- 1 | #line 2 "KISSInterceptorTest.ino" 2 | 3 | #include 4 | #include 5 | #include "../../src/bb-link/KISSInterceptor.h" 6 | 7 | using aunit::TestRunner; 8 | 9 | test(extractExtendedHardwareCommandUnknown) 10 | { 11 | KISSInterceptor kissInterceptor; 12 | uint8_t frame[] = {0xC0, 0x00, 0xC0}; 13 | extended_hw_cmd_t cmd; 14 | assertFalse(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 15 | } 16 | 17 | test(extractExtendedHardwareCommandSetFrequency) 18 | { 19 | KISSInterceptor kissInterceptor; 20 | uint8_t frame[] = {0xC0, 0x06, 0xEA, 0x01, 0x02, 0x03, 0x04, 0xC0}; 21 | extended_hw_cmd_t cmd; 22 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 23 | assertEqual(extended_hw_set_frequency, cmd.action); 24 | assertEqual((uint32_t)0x01020304, cmd.data.uint32); 25 | } 26 | 27 | test(extractExtendedHardwareCommandRestoreFrequency) 28 | { 29 | KISSInterceptor kissInterceptor; 30 | uint8_t frame[] = {0xC0, 0x06, 0xEB, 0xC0}; 31 | extended_hw_cmd_t cmd; 32 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 33 | assertEqual(extended_hw_restore_frequency, cmd.action); 34 | } 35 | 36 | test(extractExtendedHardwareCommandSetBaudRate) 37 | { 38 | KISSInterceptor kissInterceptor; 39 | uint8_t frame[] = {0xC0, 0x06, 0xF4, 0x01, 0xC0}; 40 | extended_hw_cmd_t cmd; 41 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 42 | assertEqual(extended_hw_set_baud_rate, cmd.action); 43 | assertEqual((uint8_t)0x01, cmd.data.uint8); 44 | } 45 | 46 | test(extractExtendedHardwareCommandStartScan) 47 | { 48 | KISSInterceptor kissInterceptor; 49 | uint8_t frame[] = {0xC0, 0x06, 0xEC, 0xC0}; 50 | extended_hw_cmd_t cmd; 51 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 52 | assertEqual(extended_hw_start_scan, cmd.action); 53 | } 54 | 55 | test(extractExtendedHardwareCommandStopScan) 56 | { 57 | KISSInterceptor kissInterceptor; 58 | uint8_t frame[] = {0xC0, 0x06, 0xED, 0xC0}; 59 | extended_hw_cmd_t cmd; 60 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 61 | assertEqual(extended_hw_stop_scan, cmd.action); 62 | } 63 | 64 | test(extractExtendedHardwareCommandPairWithDevice) 65 | { 66 | KISSInterceptor kissInterceptor; 67 | uint8_t frame[] = {0xC0, 0x06, 0xEF, 0x01, 0x02, 0x03, 0x10, 0x20, 0x30, 0xC0}; 68 | extended_hw_cmd_t cmd; 69 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 70 | assertEqual(extended_hw_pair_with_device, cmd.action); 71 | assertEqual(0x01, cmd.data.bytes[0]); 72 | assertEqual(0x02, cmd.data.bytes[1]); 73 | assertEqual(0x03, cmd.data.bytes[2]); 74 | assertEqual(0x10, cmd.data.bytes[3]); 75 | assertEqual(0x20, cmd.data.bytes[4]); 76 | assertEqual(0x30, cmd.data.bytes[5]); 77 | } 78 | 79 | test(extractExtendedHardwareCommandClearPairedDevice) 80 | { 81 | KISSInterceptor kissInterceptor; 82 | uint8_t frame[] = {0xC0, 0x06, 0xF0, 0xC0}; 83 | extended_hw_cmd_t cmd; 84 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 85 | assertEqual(extended_hw_clear_paired_device, cmd.action); 86 | } 87 | 88 | test(extractExtendedHardwareCommandFirmwareVersion) 89 | { 90 | KISSInterceptor kissInterceptor; 91 | uint8_t frame[] = {0xC0, 0x06, 0x28, 0xC0}; 92 | extended_hw_cmd_t cmd; 93 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 94 | assertEqual(extended_hw_firmware_version, cmd.action); 95 | } 96 | 97 | test(extractExtendedHardwareCommandCapabilities) 98 | { 99 | KISSInterceptor kissInterceptor; 100 | uint8_t frame[] = {0xC0, 0x06, 0x7E, 0xC0}; 101 | extended_hw_cmd_t cmd; 102 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 103 | assertEqual(extended_hw_capabilities, cmd.action); 104 | } 105 | 106 | test(extractExtendedHardwareCommandApiVersion) 107 | { 108 | KISSInterceptor kissInterceptor; 109 | uint8_t frame[] = {0xC0, 0x06, 0x7B, 0xC0}; 110 | extended_hw_cmd_t cmd; 111 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 112 | assertEqual(extended_hw_api_version, cmd.action); 113 | } 114 | 115 | test(extractExtendedHardwareCommandSetRigCtrl) 116 | { 117 | KISSInterceptor kissInterceptor; 118 | uint8_t frame[] = {0xC0, 0x06, 0xF2, 0x01, 0xC0}; 119 | extended_hw_cmd_t cmd; 120 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 121 | assertEqual(extended_hw_set_rig_ctrl, cmd.action); 122 | assertEqual((uint8_t)0x01, cmd.data.uint8); 123 | 124 | } 125 | 126 | test(extractExtendedHardwareCommandFactoryReset) 127 | { 128 | KISSInterceptor kissInterceptor; 129 | uint8_t frame[] = {0xC0, 0x06, 0xF3, 0xC0}; 130 | extended_hw_cmd_t cmd; 131 | assertTrue(kissInterceptor.extractExtendedHardwareCommand(frame, sizeof(frame), &cmd)); 132 | assertEqual(extended_hw_factory_reset, cmd.action); 133 | } 134 | 135 | test(escape) 136 | { 137 | KISSInterceptor kissInterceptor; 138 | uint8_t frame[] = {0x01, 0xC0, 0x03, 0xDB}; 139 | uint8_t result[32]; 140 | size_t resultSize = 32; 141 | assertTrue(kissInterceptor.escape(frame, sizeof(frame), result, &resultSize)); 142 | assertEqual((size_t)8, resultSize); 143 | assertEqual(0xC0, result[0]); 144 | assertEqual(0x01, result[1]); 145 | assertEqual(0xDB, result[2]); 146 | assertEqual(0xDC, result[3]); 147 | assertEqual(0x03, result[4]); 148 | assertEqual(0xDB, result[5]); 149 | assertEqual(0xDD, result[6]); 150 | assertEqual(0xC0, result[7]); 151 | } 152 | 153 | test(unescape) 154 | { 155 | KISSInterceptor kissInterceptor; 156 | uint8_t frame[] = {0xC0, 0x01, 0xDB, 0xDC, 0x03, 0xDB, 0xDD, 0xC0}; 157 | uint8_t result[32]; 158 | size_t resultSize = 32; 159 | assertTrue(kissInterceptor.unescape(frame, sizeof(frame), result, &resultSize)); 160 | assertEqual((size_t)6, resultSize); 161 | assertEqual(0xC0, result[0]); 162 | assertEqual(0x01, result[1]); 163 | assertEqual(0xC0, result[2]); 164 | assertEqual(0x03, result[3]); 165 | assertEqual(0xDB, result[4]); 166 | assertEqual(0xC0, result[5]); 167 | } 168 | 169 | test(unescapeInvalidEscapeSequence) 170 | { 171 | KISSInterceptor kissInterceptor; 172 | uint8_t frame[] = {0xC0, 0x01, 0xDB, 0xDC, 0x03, 0xDB, 0x00, 0xC0}; 173 | uint8_t result[32]; 174 | size_t resultSize = 32; 175 | assertFalse(kissInterceptor.unescape(frame, sizeof(frame), result, &resultSize)); 176 | } 177 | 178 | void setup() 179 | { 180 | Serial.begin(115200); 181 | while (!Serial); 182 | delay(1000); 183 | Log.begin(LOG_LEVEL_SILENT, &Serial); 184 | } 185 | 186 | void loop() 187 | { 188 | TestRunner::run(); 189 | } -------------------------------------------------------------------------------- /tests/KISSInterceptorTest/Makefile: -------------------------------------------------------------------------------- 1 | # See https://github.com/bxparks/EpoxyDuino for documentation about this 2 | # Makefile to compile and run Arduino programs natively on Linux or MacOS. 3 | 4 | APP_SRC_PATH := $(CURDIR)/../../src/bb-link 5 | APP_CPP_FILES := $(wildcard $(APP_SRC_PATH)/KISSInterceptor.cpp) 6 | OBJS += $(APP_CPP_FILES:%.cpp=%.o) 7 | 8 | APP_NAME := KISSInterceptorTest 9 | DEPS += $(APP_SRC_PATH)/MockBluetoothSerial.h 10 | ARDUINO_LIBS := AUnit ArduinoLog EpoxyEsp32 11 | EPOXY_CORE := EPOXY_CORE_ESP32 12 | include ~/Documents/Arduino/libraries/EpoxyDuino/EpoxyDuino.mk 13 | -------------------------------------------------------------------------------- /tests/Makefile: -------------------------------------------------------------------------------- 1 | tests: 2 | set -e; \ 3 | for i in *Test/Makefile; do \ 4 | echo '==== Making:' $$(dirname $$i); \ 5 | $(MAKE) -C $$(dirname $$i); \ 6 | done 7 | 8 | runtests: 9 | set -e; \ 10 | for i in *Test/Makefile; do \ 11 | echo '==== Running:' $$(dirname $$i); \ 12 | $(MAKE) -C $$(dirname $$i) run; \ 13 | done 14 | 15 | clean: 16 | set -e; \ 17 | for i in *Test/Makefile; do \ 18 | echo '==== Cleaning:' $$(dirname $$i); \ 19 | $(MAKE) -C $$(dirname $$i) clean; \ 20 | done -------------------------------------------------------------------------------- /tests/THD7xTest/Makefile: -------------------------------------------------------------------------------- 1 | # See https://github.com/bxparks/EpoxyDuino for documentation about this 2 | # Makefile to compile and run Arduino programs natively on Linux or MacOS. 3 | 4 | APP_SRC_PATH := $(CURDIR)/../../src/bb-link 5 | APP_CPP_FILES := $(wildcard $(APP_SRC_PATH)/THD7x.cpp) 6 | OBJS += $(APP_CPP_FILES:%.cpp=%.o) 7 | 8 | APP_NAME := THD7xTest 9 | DEPS += $(APP_SRC_PATH)/MockBluetoothSerial.h 10 | ARDUINO_LIBS := AUnit ArduinoLog EpoxyEsp32 11 | EPOXY_CORE := EPOXY_CORE_ESP32 12 | include ~/Documents/Arduino/libraries/EpoxyDuino/EpoxyDuino.mk 13 | -------------------------------------------------------------------------------- /tests/THD7xTest/THD7xTest.ino: -------------------------------------------------------------------------------- 1 | #line 2 "THD7xTest.ino" 2 | 3 | #include 4 | #include 5 | #include "../../src/bb-link/THD7x.h" 6 | 7 | using aunit::TestRunner; 8 | 9 | test(setFrequency) 10 | { 11 | BluetoothSerial mockBluetoothSerial; 12 | THD7x thd7x = THD7x(mockBluetoothSerial); 13 | thd7x.setFrequency(vfoA, 145000000); 14 | char buffer[32]; 15 | int length = mockBluetoothSerial.getWriteBuffer(buffer, 32); 16 | assertEqual(16, length); 17 | buffer[length] = '\0'; 18 | assertEqual("FQ 0,0145000000\r", buffer); 19 | } 20 | 21 | test(getFrequency) 22 | { 23 | BluetoothSerial mockBluetoothSerial; 24 | THD7x thd7x = THD7x(mockBluetoothSerial); 25 | uint32_t frequency; 26 | mockBluetoothSerial.setMockReadValue("FQ 0,0145000000"); 27 | assertTrue(thd7x.getFrequency(vfoA, &frequency)); 28 | assertEqual((uint32_t)145000000L, frequency); 29 | } 30 | 31 | test(setBaudRate) 32 | { 33 | BluetoothSerial mockBluetoothSerial; 34 | THD7x thd7x = THD7x(mockBluetoothSerial); 35 | thd7x.setBaudRate(baudRate9600); 36 | char buffer[32]; 37 | int length = mockBluetoothSerial.getWriteBuffer(buffer, 32); 38 | assertEqual(5, length); 39 | buffer[length] = '\0'; 40 | assertEqual("AS 1\r", buffer); 41 | } 42 | 43 | test(getBaudRate) 44 | { 45 | BluetoothSerial mockBluetoothSerial; 46 | THD7x thd7x = THD7x(mockBluetoothSerial); 47 | baud_rate_t baud_rate; 48 | mockBluetoothSerial.setMockReadValue("AS 1"); 49 | assertTrue(thd7x.getBaudRate(&baud_rate)); 50 | assertEqual(baudRate9600, baud_rate); 51 | } 52 | 53 | test(setTNC) 54 | { 55 | BluetoothSerial mockBluetoothSerial; 56 | THD7x thd7x = THD7x(mockBluetoothSerial); 57 | thd7x.setTNC(vfoA, tncKISS); 58 | char buffer[32]; 59 | int length = mockBluetoothSerial.getWriteBuffer(buffer, 32); 60 | assertEqual(7, length); 61 | buffer[length] = '\0'; 62 | assertEqual("TN 2,0\r", buffer); 63 | } 64 | 65 | test(getTNC) 66 | { 67 | BluetoothSerial mockBluetoothSerial; 68 | THD7x thd7x = THD7x(mockBluetoothSerial); 69 | vfo_t vfo; 70 | tnc_mode_t mode; 71 | mockBluetoothSerial.setMockReadValue("TN 2,0"); 72 | assertTrue(thd7x.getTNC(&vfo, &mode)); 73 | assertEqual(vfoA, vfo); 74 | assertEqual(tncKISS, mode); 75 | } 76 | 77 | test(setMode) 78 | { 79 | BluetoothSerial mockBluetoothSerial; 80 | THD7x thd7x = THD7x(mockBluetoothSerial); 81 | thd7x.setMode(vfoA, modeFM); 82 | char buffer[32]; 83 | int length = mockBluetoothSerial.getWriteBuffer(buffer, 32); 84 | assertEqual(7, length); 85 | buffer[length] = '\0'; 86 | assertEqual("MD 0,0\r", buffer); 87 | } 88 | 89 | test(getMode) 90 | { 91 | BluetoothSerial mockBluetoothSerial; 92 | THD7x thd7x = THD7x(mockBluetoothSerial); 93 | vfo_mode_t mode; 94 | mockBluetoothSerial.setMockReadValue("MD 1,5"); 95 | assertTrue(thd7x.getMode(vfoB, &mode)); 96 | assertEqual(modeCW, mode); 97 | } 98 | 99 | test(getRadioId) 100 | { 101 | BluetoothSerial mockBluetoothSerial; 102 | THD7x thd7x = THD7x(mockBluetoothSerial); 103 | char radioId[32]; 104 | mockBluetoothSerial.setMockReadValue("ID TH-D74"); 105 | assertTrue(thd7x.getRadioId(radioId, 32)); 106 | assertEqual("TH-D74", radioId); 107 | } 108 | 109 | test(exitKISS) 110 | { 111 | BluetoothSerial mockBluetoothSerial; 112 | THD7x thd7x = THD7x(mockBluetoothSerial); 113 | char buffer[32]; 114 | thd7x.exitKISS(); 115 | int length = mockBluetoothSerial.getWriteBuffer(buffer, 32); 116 | assertEqual(3, length); 117 | assertEqual(0xccffcc, buffer); 118 | } 119 | 120 | test(isKISSMode) 121 | { 122 | BluetoothSerial mockBluetoothSerial; 123 | THD7x thd7x = THD7x(mockBluetoothSerial); 124 | mockBluetoothSerial.setMockReadValue("?"); 125 | assertTrue(thd7x.isKISSMode()); 126 | } 127 | 128 | test(sendCmdSuccess) 129 | { 130 | BluetoothSerial mockBluetoothSerial; 131 | THD7x thd7x = THD7x(mockBluetoothSerial); 132 | char buffer[32]; 133 | mockBluetoothSerial.setMockReadValue("TE 456"); 134 | assertTrue(thd7x.sendCmd("TE 123", buffer, 32)); 135 | assertEqual("TE 456", buffer); 136 | } 137 | 138 | test(sendCmdNoResponse) 139 | { 140 | BluetoothSerial mockBluetoothSerial; 141 | THD7x thd7x = THD7x(mockBluetoothSerial); 142 | char buffer[32]; 143 | assertFalse(thd7x.sendCmd("TE 123", buffer, 32)); 144 | } 145 | 146 | test(sendCmdRetry) 147 | { 148 | BluetoothSerial mockBluetoothSerial; 149 | THD7x thd7x = THD7x(mockBluetoothSerial); 150 | char buffer[32]; 151 | mockBluetoothSerial.setMockReadValue("?"); 152 | assertFalse(thd7x.sendCmd("TE 123", buffer, 32, 3)); 153 | char wbuffer[256]; 154 | int length = mockBluetoothSerial.getWriteBuffer(wbuffer, 256); 155 | wbuffer[length] = '\0'; 156 | assertEqual(14, length); 157 | // The mock read value reset after being read, so after the first retry, the buffer is empty 158 | // and it's detected as a no respone timeout situation and no more retries are attempted 159 | assertEqual("TE 123\rTE 123\r", wbuffer); 160 | } 161 | 162 | void setup() 163 | { 164 | Serial.begin(115200); 165 | while (!Serial); 166 | delay(1000); 167 | Log.begin(LOG_LEVEL_SILENT, &Serial); 168 | } 169 | 170 | void loop() 171 | { 172 | TestRunner::run(); 173 | } --------------------------------------------------------------------------------