diff --git a/.github/workflows/build-cordio-platform-docs.yml b/.github/workflows/build-cordio-platform-docs.yml new file mode 100644 index 0000000000..eaa21184cb --- /dev/null +++ b/.github/workflows/build-cordio-platform-docs.yml @@ -0,0 +1,60 @@ +name: Build & Deploy Cordio Platform Docs + +on: + workflow_dispatch: + + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/github-script@v3 + id: get-pr + with: + script: | + const request = { + owner: context.repo.owner, + repo: context.repo.repo, + pull_number: context.issue.number + } + core.info(`Getting PR #${request.pull_number} from ${request.owner}/${request.repo}`) + try { + const result = await github.pulls.get(request) + return result.data + } catch (err) { + core.setFailed(`Request failed with error ${err}`) + } + - uses: actions/checkout@v3 + with: + repository: ${{ fromJSON(steps.get-pr.outputs.result).head.repo.full_name }} + ref: ${{ fromJSON(steps.get-pr.outputs.result).head.ref }} + fetch-depth: 0 + + - name: Generate Docs (MAX32655) + uses: mattnotmitt/doxygen-action@v1.9.5 + with: + working-directory: Libraries/Cordio/docs + doxyfile-path: cordio_platform_doxyfile + enable-latex: true + + - name: Build PDF + run: | + echo "Building PDF..." + sudo apt-get install texlive-full + sudo make -C Libraries/Cordio/docs/latex + + echo "Copying PDF to Cordio/platform/Documentation" + sudo mv Libraries/Cordio/docs/latex/refman.pdf Libraries/Cordio/docs/latex/Cordio-Platform-Documentation.pdf + sudo mkdir -p Libraries/Cordio/platform/Documentation && sudo cp -r Libraries/Cordio/docs/latex/Cordio-Platform-Documentation.pdf Libraries/Cordio/platform/Documentation/ + + + - name: Push Documentation Files + uses: EndBug/add-and-commit@v9.0.1 + with: + add: 'Libraries/Cordio/platform/Documentation/Platform_ref.pdf' + message: 'Update documentation.' + push: true + + + + diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index e3aa3770ab..fc3ed0d400 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -131,9 +131,19 @@ jobs: mkdir -p $DEST/MAX78000 && cp -r $SOURCE/MAX78000 $DEST/ mkdir -p $DEST/MAX78002 && cp -r $SOURCE/MAX78002 $DEST/ + SOURCE=Libraries/Cordio + DEST=Documentation/$SOURCE + + echo "Copying Cordio documentation..." + mkdir -p $DEST/docs && cp -r $SOURCE/docs/*.md $DEST/docs + mkdir -p $DEST/docs/res && cp -r $SOURCE/docs/res/* $DEST/docs/res + mkdir -p $DEST/platform/Documentation && cp -r $SOURCE/platform/Documentation/*.pdf $DEST/platform/Documentation + echo "Copying any root markdown files into Documentation..." cp -r *.md Documentation/ + python3 Documentation/updateUSERGUIDE-Cordio.py + mkdocs build - name: Publish diff --git a/.github/workflows/scripts/updateUSERGUIDE-Cordio.py b/.github/workflows/scripts/updateUSERGUIDE-Cordio.py new file mode 100644 index 0000000000..5ac1cc1318 --- /dev/null +++ b/.github/workflows/scripts/updateUSERGUIDE-Cordio.py @@ -0,0 +1,72 @@ +from pathlib import Path +from os import listdir + + +TEMPLATE = "- [%s](%s/%s)\n" +repo = Path.cwd().parent.parent +cordio_docs_dir = repo / "Libraries" / "Cordio" / "docs" +platform_docs_dir = repo / "Libraries" / "Cordio" / "platform" / "Documentation" + +cordio_doc_files = [f for f in listdir(cordio_docs_dir) if f.endswith('.md')] +platform_doc_files = [f for f in listdir(platform_docs_dir) if f.endswith('.pdf')] + +with open(repo / "USERGUIDE.md", 'r') as f: + lines = f.readlines() + +idx = 0 +foundStart = False + +for line in lines: + if foundStart: + if line[0] == '#': + end_idx = idx + break + + if '#### Cordio Documentation' in line: + start_idx = idx + foundStart = True + + idx += 1 + +comp_lines = lines[start_idx+1:end_idx] + +for cfile in cordio_doc_files: + for line in lines: + if cfile in line: + cordio_doc_files.remove(cfile) + +for pfile in platform_doc_files: + for line in lines: + if pfile in line: + platform_doc_files.remove(pfile) + +if len(cordio_doc_files) > 0: + entries = [] + for f in cordio_doc_files: + if 'LICENSE' in f: + continue + nav_name = f.split('.')[0].replace("_", " ").title() + entries.append(TEMPLATE % (nav_name, cordio_docs_dir, f)) + +if len(platform_doc_files) > 0: + for f in platform_doc_files: + if 'LICENSE' in f: + continue + nav_name = f.split('.')[0].replace("-", " ").title() + entries.append(TEMPLATE % (nav_name, platform_docs_dir, f)) + + while True: + if lines[end_idx][0] == '-': + end_idx -= 1 + break + end_idx -= 1 + + idx = 0 + for entry in entries: + lines.insert(end_idx, entry) + end_idx += 1 + + content = "".join(lines) + + with open(repo / "USERGUIDE.md", 'w') as f: + f.write(content) diff --git a/Examples/MAX32655/BLE_datc/README.md b/Examples/MAX32655/BLE_datc/README.md index ce8d85db9c..fc6ecb52f4 100644 --- a/Examples/MAX32655/BLE_datc/README.md +++ b/Examples/MAX32655/BLE_datc/README.md @@ -1,578 +1,2 @@ -# Description - -Bluetooth data client that scans for and connects to advertisers with the name of "DATS". - -# Usage - -## LEDs - -The red LED will indicate that an error assertion has occurred. - -The green LED indicates CPU activity. When the LED is on, the CPU is active, when the LED -is off, the CPU is in sleep mode. - -## Setup - -### Board Selection - -Before building firmware you must select the correct value for BOARD in project.mk, e.g. "EvKit_V1". - -### Required Connections -- Connect a USB cable between the PC and the (USB/PWR - UART) connector. - -## Trace Serial Port -When TRACE is enabled in the project.mk, the on-board USB-to-UART adapter can -be used to view the trace messages and interact with the application. Open a serial port terminal with -the following settings. - -Baud : 115200 -Char size : 8 -Parity : None -Stop bits : 1 -HW Flow Control : No -SW Flow Control : No - -## Passkey input -Upon server dsicovery the user will be prompted to enter a passkey. -An arbitrary pin can be entered in the following format -``` -pin (connId) passkey -Eg: -pin 1 123456 - -``` -Next the server is expected to enter the same connId and passkey -to establish a secure connection and share bonding information -which for demonstration purposes,is echoed via the trace mechanism - -Note that either the client or server can enter the passkey first. -The peer device must then match. - - -### Expected Output - -On startup: -``` -terminal: init -32kHz trimmed to 0xF -DatcHandlerInit -Calculating database hash -Datc got evt 32 ->>> Reset complete <<< -Datc got evt 58 -Database hash calculation complete -Datc got evt 21 -Database hash updated -dmDevPassEvtToDevPriv: event: 13, param: 1, advHandle: 0 -Datc got evt 63 -Datc got evt 153 -dmDevPassEvtToDevPriv: event: 12, param: 36, advHandle: 0 -Datc got evt 36 ->>> Scanning started <<< -``` - -When a scan report has been received: -``` -Scan Report: - 55:CF:67:1F:6F:27 -Scan Report: - 00:05:8B:44:12:02 - Name: Fit -``` - -When server has been found: -``` -Scan Report: - 00:18:80:04:52:1F - Name: DATS -dmDevPassEvtToDevPriv: event: 13, param: 37, advHandle: 0 -Datc got evt 37 -Scan results: 4 -dmConnIdByBdAddr not found -dmConnCcbAlloc 1 ->>> Scanning stopped <<< -dmConnSmExecute event=24 state=0 -dmDevPassEvtToDevPriv: event: 14, param: 0, advHandle: 0 -dmConnSmExecute event=28 state=1 -dmDevPassEvtToDevPriv: event: 14, param: 1, advHandle: 0 -dmDevPassEvtToDevPriv: event: 12, param: 39, advHandle: 0 -smpDbGetRecord: connId: 1 type: 0 -smpDbAddDevice -SmpDbGetFailureCount: connId: 1 count: 0 -smpDbGetRecord: connId: 1 type: 0 -smpDbAddDevice -SmpDbGetPairingDisabledTime: connId: 1 period: 0 attemptMult: 0 -Datc got evt 39 ->>> Connection opened <<< -smpSmExecute event=1 state=0 -connId=1 idleMask=0x0001 -Datc got evt 65 -Datc got evt 22 -smpSmExecute event=6 state=1 -smpSmExecute event=17 state=2 -smpSmExecute event=4 state=3 -connId=1 idleMask=0x0001 -Datc got evt 87 -Datc got evt 4 -connId=1 idleMask=0x0009 -smpSmExecute event=6 state=4 -smpSmExecute event=20 state=5 -Datc got evt 46 ->>> Prompt user to enter passkey <<< -Datc got evt 3 -AttcDiscServiceCmpl status 0x00 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 2 -AttcDiscCharCmpl status 0x00 -connId=1 idleMask=0x0009 -Datc got evt 3 -AttcDiscServiceCmpl status 0x00 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 4 -AttcDiscCharCmpl status 0x00 -connId=1 idleMask=0x0009 -Datc got evt 3 -AttcDiscServiceCmpl status 0x00 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 2 -AttcDiscCharCmpl status 0x00 -connId=1 idleMask=0x0009 -Datc got evt 3 -AttcDiscServiceCmpl status 0x00 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 4 -AttcDiscCharCmpl status 0x79 -Datc got evt 2 -AttcDiscCharCmpl status 0x79 -Datc got evt 2 -AttcDiscCharCmpl status 0x00 -connId=1 idleMask=0x0001 -AppDiscComplete connId:1 status:0x04 -connId=1 idleMask=0x0009 -Datc got evt 9 -AttcDiscConfigCmpl status 0x79 -Datc got evt 9 -AttcDiscConfigCmpl status 0x79 -Datc got evt 9 -AttcDiscConfigCmpl status 0x79 -Datc got evt 9 -AttcDiscConfigCmpl status 0x00 -connId=1 idleMask=0x0001 -AppDiscComplete connId:1 status:0x08 -``` -After entering a pin -``` -pin 1 12345 -> smpSmExecute event=4 state=11 -Rand Na -[5fa96af9 f434b4de 3e452813 fef4f5eb] -smpSmExecute event=28 state=12 -Cai -[57964640 e18b1aa1 8ea7d8b2 2eb274c3] -connId=1 idleMask=0x0001 - -``` - -Once server enters a matching pin and encrypted connection is established -``` -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[7e2523a4 be6a8923 8ef900bf d4eaa458] -smpSmExecute event=26 state=16 -Rand Na -[efb856be 61bd11a8 2dff39c0 1f5d4d91] -smpSmExecute event=28 state=12 -Cai -[65f7c942 8c216010 cc73fdc9 bd21120e] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[db4858f8 33a964c1 e35ba27c 1f07e7db] -smpSmExecute event=26 state=16 -Rand Na -[9904fded 40ea2bb1 dfabe4be b9bcba45] -smpSmExecute event=28 state=12 -Cai -[1362d0db 074d32ea 32d0e79c 1155a20b] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[efd27c04 96ff72e0 c893bf54 9c524f0a] -smpSmExecute event=26 state=16 -Rand Na -[5ba16640 fd3af1ae afc6d035 d8eb1fa5] -smpSmExecute event=28 state=12 -Cai -[79603efa ad87d2cd bdc4c83b 17dcffe6] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[c1221276 73df3bf7 90e8df64 741909c1] -smpSmExecute event=26 state=16 -Rand Na -[59ea06d0 760407f7 87415144 fe234a1e] -smpSmExecute event=28 state=12 -Cai -[40b9915c af4a8712 c81e98f9 f197953a] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[325fe15b 5a6862e1 f4de459d 6c91c220] -smpSmExecute event=26 state=16 -Rand Na -[4c56f9f9 b1d91236 8dfb81f8 b0629bb7] -smpSmExecute event=28 state=12 -Cai -[c2fb6b18 63cb9311 d53c3333 0a2924cf] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[7725d42d 35f8e465 b3b6cfed 9bfe125a] -smpSmExecute event=26 state=16 -Rand Na -[3909e384 45979c24 c85d36d3 fc2bd4bf] -smpSmExecute event=28 state=12 -Cai -[9e570480 195412a0 07c84616 36cd6a06] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[1bce9472 21f7d6c4 4f8fe62b 91ac2271] -smpSmExecute event=26 state=16 -Rand Na -[fe57e223 78ca04e3 cd13bd82 ad43289c] -smpSmExecute event=28 state=12 -Cai -[42ba2b2e bd35ebe6 56c59b28 957639d2] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[a35acba5 00eba332 31442e10 aea9dacf] -smpSmExecute event=26 state=16 -Rand Na -[71aa44ad abe2d668 07b79f02 d2a974dc] -smpSmExecute event=28 state=12 -Cai -[5b02fce8 f92549ca 54bea290 c9fdfd1b] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[4a52c87c a504c8cf 49d9e8f0 1a69aca2] -smpSmExecute event=26 state=16 -Rand Na -[0f87eb54 83f4f78b 754d2f74 1b406c0d] -smpSmExecute event=28 state=12 -Cai -[16a9ba43 8c8b39d2 912f1f85 3f738170] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[b2aa1f53 802fa4ad 3e415844 4953c931] -smpSmExecute event=26 state=16 -Rand Na -[466db705 9fd2d031 35759a3f 45869950] -smpSmExecute event=28 state=12 -Cai -[004c8d5f 4413efb9 f60c10c2 8af82058] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[6b93dfa8 91d6bc27 fbb7142a 778d6eab] -smpSmExecute event=26 state=16 -Rand Na -[4d0cfaee 277f0959 ee9ad6b5 bf89e129] -smpSmExecute event=28 state=12 -Cai -[b977b373 4fdeb62d 4b9fc6dd 0cd58ccb] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[7d734f74 37d7575f 9a2176fe 9e0d7793] -smpSmExecute event=26 state=16 -Rand Na -[aa704717 22c5a505 922ea504 c8f32c21] -smpSmExecute event=28 state=12 -Cai -[b8db800a c2cfb643 0ad2127e 154b27e3] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[fb8bfb47 1db075d6 c10dfe20 275580a6] -smpSmExecute event=26 state=16 -Rand Na -[6715c20d 284d6526 c826990b c0266d4d] -smpSmExecute event=28 state=12 -Cai -[9a07bded 4652b3b3 04e58dd3 ddc41f5b] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[9b11572d 6ac46706 2a42ddf7 fa3f7eb6] -smpSmExecute event=26 state=16 -Rand Na -[276b1950 0160195c 2ca2749e 04cc0bba] -smpSmExecute event=28 state=12 -Cai -[7811b835 1ee6cd01 b35e0068 b0e995a2] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[febf4094 ccf93969 adc4d7e3 c3f26246] -smpSmExecute event=26 state=16 -Rand Na -[31c8d021 62bd5eb6 470c008d 0f9a8f69] -smpSmExecute event=28 state=12 -Cai -[6cc99436 0835e6bf b7ccd2a8 81eb7c2d] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[314f5edd e73e8b9e 865c3924 c438e032] -smpSmExecute event=26 state=16 -Rand Na -[4f46b9ce 57474f8d 8d00a000 74bdea15] -smpSmExecute event=28 state=12 -Cai -[baea7468 fabb299a 837bbbfb c47572e2] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[f8a46358 201aab0a ae9aae2c 0c32fb92] -smpSmExecute event=26 state=16 -Rand Na -[b80a6511 3c82e7e6 055243e6 a45202a6] -smpSmExecute event=28 state=12 -Cai -[24c084e8 e92b8e03 1a37f096 f4d5c31f] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[04aa43e8 dac7aa2a 490e6154 11b81966] -smpSmExecute event=26 state=16 -Rand Na -[16bc0b9f a93b2745 729a08b9 85682b0d] -smpSmExecute event=28 state=12 -Cai -[a5caa3a1 b7b66eaa f113972c 88645db6] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[831b8daf 7ae674d8 e2c5fbc3 9fc27be3] -smpSmExecute event=26 state=16 -Rand Na -[3a8e02cf 001e84b3 08d9a24e 19ff9b18] -smpSmExecute event=28 state=12 -Cai -[bf5345f1 299bca3f 0c99eac6 3ea96052] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=13 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=14 -smpSmExecute event=28 state=15 -Cbi -[0a4dec2e 6aebc804 7bb1a21b aadc18c1] -smpSmExecute event=27 state=16 -smpSmExecute event=25 state=19 -DHKey (Shared Secret) -[7cf8b651 6c0f5bff 7d66bbf6 d8d85abd] -[0ef6bf2d 85a594d2 f55dccc3 6f98dd1d] -smpSmExecute event=28 state=20 -T -[a02f2c9d 9a153f28 0bde8cb2 ab2a7b84] -smpSmExecute event=28 state=21 -MAC -[66ebd01a c4818e8b 1cec71bf f0644ed9] -smpSmExecute event=28 state=22 -LTK -[b4cad222 8324e2fb 71bbca0f 04bfc828] -smpSmExecute event=28 state=23 -DHKey Ea -[a2925a68 0b71e9c3 065a959d 39079b01] -smpSmExecute event=28 state=24 -DHKey Eb -[3ed3c373 5b99fc5e 16577603 7a1ba181] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=25 -connId=1 idleMask=0x0001 -smpSmExecute event=8 state=34 -Datc got evt 44 ->>> Connection encrypted <<< -smpSmExecute event=6 state=35 -smpSmExecute event=6 state=35 -smpSmExecute event=12 state=35 -Datc got evt 47 -Datc got evt 47 -smpSmExecute event=12 state=35 -smpSmExecute event=12 state=35 -smpSmExecute event=14 state=35 -connId=1 idleMask=0x0000 -Datc got evt 42 ->>> Pairing completed successfully <<< -dmDevPassEvtToDevPriv: event: 13, param: 1, advHandle: 0 -Datc got evt 58 -Datc got evt 63 -``` -Simple message passing to peer: -``` -btn 2 l -Long Button 2 Press -> Datc got evt 10 -Datc got evt 13 -hello back -``` -Secure message passing to peer: -``` -btn 2 m -Medium Button 2 Press -> Datc got evt 10 -Datc got evt 13 ->> Notification from secure data service <<< -Secure data received! - -``` - -On PHY change request: -``` -btn 1 x -XL Button 1 Press -2 MBit TX and RX PHY Requested -> Datc got evt 70 -DM_PHY_UPDATE_IND - RX: 2, TX: 2 -Datc got evt 65 -btn 1 x -XL Button 1 Press -LE Coded S2 TX and RX PHY Requested -> Datc got evt 70 -DM_PHY_UPDATE_IND - RX: 3, TX: 3 -Datc got evt 65 -btn 1 x -XL Button 1 Press -LE Coded S8 TX and RX PHY Requested -> Datc got evt 70 -DM_PHY_UPDATE_IND - RX: 3, TX: 3 -btn 1 x -XL Button 1 Press -1 MBit TX and RX PHY Requested -> Datc got evt 70 -DM_PHY_UPDATE_IND - RX: 1, TX: 1 -Datc got evt 65 -``` - -Data Transfer Speed test (1M PHY): -``` -btn 2 x -XL Button 2 Press -Starting speed test -... -flowDisabled=1 handle=0 -flowDisabled=0 handle=0 -9520000 bits transferred in 18823249 us -505757 bps -``` - -Data Transfer Speed test (2M PHY): -``` -btn 2 x -XL Button 2 Press -Starting speed test -... -flowDisabled=1 handle=0 -flowDisabled=0 handle=0 -9520000 bits transferred in 9413977 us -1011262 bps -``` - -### Commands -Type the desired command and parameter (if applicable) and press enter to execute the command. - -__help__ Displays the available commands. -__echo (on|off)__ Enables or disables the input echo. On by default. -__btn (ID) (s|m|l|x)__ Simulates button presses. Example: "btn 1 s" for a short button press on button 1. -__pin (ConnID) (Pin Code)__ Used to input the pairing pin code. - -## Push buttons -Push buttons can be used to interact with the application. - -__short__ : press is less than 200 ms -__medium__ : press is between 200 and 500 ms -__long__ : press is between 500 and 1000 ms -__extra long__ : press is greater than 1000 ms - -### When disconnected -1. Button 1 short: Start/Stop scanning -2. Button 1 medium: Cycle through the connection index (select connection) -3. Button 1 long: Clear all bonding info -4. Button 1 extra long: Add RPAO characteristic to GAP service -- needed only when DM Privacy enabled -5. Button 2 extra long: Enable device privacy -- start generating local RPAs every 15 minutes - -### When connected -1. Button 1 short: Start/Stop scanning -2. Button 1 medium: Cycle through connection index (select connection) -3. Button 1 long: Close selected connection -4. Button 2 short: Request PHY change (1M-2M-S2-S8) Only for BLE5 version. -5. Button 2 medium : Send secure message to peer -6. Button 2 long: Send short message to peer -7. Button 2 extra long: Start data transfer speed test +# BLE_datc +Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library. \ No newline at end of file diff --git a/Examples/MAX32655/BLE_dats/README.md b/Examples/MAX32655/BLE_dats/README.md index 110bbbce0e..21e710f844 100644 --- a/Examples/MAX32655/BLE_dats/README.md +++ b/Examples/MAX32655/BLE_dats/README.md @@ -1,513 +1,2 @@ -# Description - -Bluetooth data server that advertises as "DATS" and accepts connection requests. - -# Usage - -## LEDs - -The red LED will indicate that an error assertion has occurred. - -The green LED indicates CPU activity. When the LED is on, the CPU is active, when the LED -is off, the CPU is in sleep mode. - -## Setup - -### Board Selection - -Before building firmware you must select the correct value for BOARD in project.mk, e.g. "EvKit_V1". - -### Required Connections -- Connect a USB cable between the PC and the (USB/PWR - UART) connector. - -## Trace Serial Port -When TRACE is enabled in the project.mk, the on-board USB-to-UART adapter can -be used to view the trace messages and interact with the application. Open a serial port terminal with -the following settings. - -Baud : 115200 -Char size : 8 -Parity : None -Stop bits : 1 -HW Flow Control : No -SW Flow Control : No - -### Expected Output - -On startup: -``` -terminal: init -32kHz trimmed to 0x16 -DatsHandlerInit -Dats got evt 32 ->>> Reset complete <<< -dmAdvActConfig: state: 0 -dmAdvActSetData: state: 0 -dmAdvActSetData: state: 0 -dmAdvActStart: state: 0 -HCI_LE_ADV_ENABLE_CMD_CMPL_CBACK_EVT: state: 3 -dmDevPassEvtToDevPriv: event: 12, param: 33, advHandle: 0 -Dats got evt 33 ->>> Advertising started <<< -Dats got evt 21 -Database hash updated - -``` - -When a connection attempting to connect to the client. -``` -Dats got evt 21 -Database hash updated -Dats got evt 153 -dmConnIdByBdAddr not found -dmConnCcbAlloc 1 -dmConnSmExecute event=28 state=0 -dmAdvConnected: state: 1 -dmDevPassEvtToDevPriv: event: 13, param: 34, advHandle: 0 -smpDbGetRecord: connId: 1 type: 0 -smpDbAddDevice -SmpDbGetFailureCount: connId: 1 count: 0 -smpDbGetRecord: connId: 1 type: 0 -smpDbAddDevice -SmpDbGetPairingDisabledTime: connId: 1 period: 0 attemptMult: 0 -Dats got evt 39 ->>> Connection opened <<< -Dats got evt 65 -Dats got evt 22 -smpSmExecute event=6 state=0 -connId=1 idleMask=0x0001 -Dats got evt 49 -smpSmExecute event=2 state=2 -smpSmExecute event=17 state=3 -smpSmExecute event=4 state=5 -smpSmExecute event=6 state=4 -smpSmExecute event=20 state=6 -connId=1 idleMask=0x0001 -Dats got evt 46 ->>> Prompt user to enter passkey <<< -Dats got evt 87 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 -connId=1 idleMask=0x0005 - -``` -When matching pins have been entered -``` -> smpSmExecute event=4 state=13 -Rand Nb -[52730a1e 080e2b3f 6d010f4b 0d29b8ac] -smpSmExecute event=28 state=15 -Cbi -[520aab85 e23b56d5 70598231 64553242] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[634082f9 ae97841d 408a0609 d3149a0f] -Ca Peer -[634082f9 ae97841d 408a0609 d3149a0f] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[2b4f65e1 41465986 1732c49b 0779c049] -smpSmExecute event=28 state=15 -Cbi -[34b63e15 0a0b1d8a fbaac17d ae94c891] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[e7b74ec3 7bb660e0 fd3ffb69 a70fc1b5] -Ca Peer -[e7b74ec3 7bb660e0 fd3ffb69 a70fc1b5] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[cb42c521 d4edb9cd fe2a5777 526d153d] -smpSmExecute event=28 state=15 -Cbi -[58d9a8c4 c4710a1a bd41ed81 2e666953] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[d100648f ae87b3e0 850e96ef 3c2c9a47] -Ca Peer -[d100648f ae87b3e0 850e96ef 3c2c9a47] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[21a3cd36 613f1834 c6e3d6fa 337e3f6c] -smpSmExecute event=28 state=15 -Cbi -[314e5afe c5799362 0c3c7e01 54a62b7d] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[bc03c14d cf73fbab c64c8de8 65c9bd3f] -Ca Peer -[bc03c14d cf73fbab c64c8de8 65c9bd3f] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[3e0cb037 9edea6c2 dfdd238f eee47a18] -smpSmExecute event=28 state=15 -Cbi -[223876ac 32cfa06e 5764766f e655cfda] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[3a1dceac 4ed11dc5 60384042 5f625042] -Ca Peer -[3a1dceac 4ed11dc5 60384042 5f625042] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[23ca1caf 70a3ba5b fd40e6ca db907405] -smpSmExecute event=28 state=15 -Cbi -[0f969efc f159e4c6 588c68ae 5d1f9851] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[c34f8c33 3e16ee08 3cac6f79 1eea831f] -Ca Peer -[c34f8c33 3e16ee08 3cac6f79 1eea831f] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[840f704c 59845fc2 47d5463a 9c68159b] -smpSmExecute event=28 state=15 -Cbi -[f5a84dfe 36bdfc2d 410e133d 0c474039] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[e27af695 a9227a18 74c2ba3d 57ed5254] -Ca Peer -[e27af695 a9227a18 74c2ba3d 57ed5254] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[5558d557 ba639669 226f7665 98ba1755] -smpSmExecute event=28 state=15 -Cbi -[c8158453 c50a9448 236c7bd5 fe249a0d] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[530da1cb 834ec9fa 6076fd05 037dce54] -Ca Peer -[530da1cb 834ec9fa 6076fd05 037dce54] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[9f57fda8 897aac72 810475a4 eda95e4c] -smpSmExecute event=28 state=15 -Cbi -[12494fdf 83718797 5efa3ff7 4e230a9d] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[b9c97dbe 7a725ab4 20c59148 10821669] -Ca Peer -[b9c97dbe 7a725ab4 20c59148 10821669] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[564e5d0e 2605341f 4d5b6913 0c89c1aa] -smpSmExecute event=28 state=15 -Cbi -[a8b37963 eafdcaee ecbf62ab a23f686a] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[b1387cd1 054a3616 3a73b06d 085e74b7] -Ca Peer -[b1387cd1 054a3616 3a73b06d 085e74b7] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[fc4d0a4e 2e6ca8f1 65f242a8 88876d0e] -smpSmExecute event=28 state=15 -Cbi -[623c1256 7e20dba1 f5257b86 11b54ece] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[4540e3cd 77e8ac57 8024607c 0de42ce2] -Ca Peer -[4540e3cd 77e8ac57 8024607c 0de42ce2] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[144e1412 64996fa0 d686011f 7913327d] -smpSmExecute event=28 state=15 -Cbi -[b354740a 3d097abc e33af952 cffc0e8a] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[ba1e5505 2e488dda b984bd08 2d07fdeb] -Ca Peer -[ba1e5505 2e488dda b984bd08 2d07fdeb] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[2596e6cd 44929e11 9791ba02 62e3feef] -smpSmExecute event=28 state=15 -Cbi -[3790e2f7 96ca63b6 826bbf5c 077c3f31] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[fe05bd6a 1f277dee 124de8b0 02c03343] -Ca Peer -[fe05bd6a 1f277dee 124de8b0 02c03343] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[06175016 3aabb9f3 f3aa5925 c9b8a43d] -smpSmExecute event=28 state=15 -Cbi -[57d2399c 89fbc8f0 3ee71020 f66b45d5] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[c2dff69b 7ae8eba8 e92f3b57 ff3978c7] -Ca Peer -[c2dff69b 7ae8eba8 e92f3b57 ff3978c7] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[5c70daab 66fe0495 07d0e27d 824d9865] -smpSmExecute event=28 state=15 -Cbi -[f03928aa 2324a2ca 8c3c1fd8 9d589afe] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[9f8dec26 018dcea5 0cc56156 32b9107b] -Ca Peer -[9f8dec26 018dcea5 0cc56156 32b9107b] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[fd89b81d e2b3fdaf f22cf4c4 b39da763] -smpSmExecute event=28 state=15 -Cbi -[c005af08 39334b4a ac68cf0a ca5acc00] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[94681382 aa6a4d27 1b8eb879 a5ed8043] -Ca Peer -[94681382 aa6a4d27 1b8eb879 a5ed8043] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[5b0789ba 4bd1a9f8 10e15f9d 0dbd4ac2] -smpSmExecute event=28 state=15 -Cbi -[b719fe1d 02e6cc10 8776a1b4 0bc0fa6b] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[3f8a85da fad78d81 0c8e0733 876df6fb] -Ca Peer -[3f8a85da fad78d81 0c8e0733 876df6fb] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[c0c90b30 03659e86 a143abe4 ec289e73] -smpSmExecute event=28 state=15 -Cbi -[d02d6808 35888e79 55e04238 f0930c07] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[4efc0b02 bcd8bc6a ac93b70c effeaee1] -Ca Peer -[4efc0b02 bcd8bc6a ac93b70c effeaee1] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[96aab51d 5e627668 ba927ed6 d1192554] -smpSmExecute event=28 state=15 -Cbi -[49660e21 5b3e82cd 32e3ac9a d839ad2d] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[2db916d0 32b02469 1711edf5 812ae090] -Ca Peer -[2db916d0 32b02469 1711edf5 812ae090] -connId=1 idleMask=0x0001 -smpSmExecute event=26 state=18 -smpSmExecute event=6 state=14 -Rand Nb -[d9e874e4 9b02cb3f 9aac021d 7ad59561] -smpSmExecute event=28 state=15 -Cbi -[837b81cf 6c409caa c29a550b 649b2c46] -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=16 -smpSmExecute event=28 state=17 -Ca -[f3d0b1b5 76097bfb 14418e57 6d3c11ba] -Ca Peer -[f3d0b1b5 76097bfb 14418e57 6d3c11ba] -smpSmExecute event=27 state=18 -connId=1 idleMask=0x0001 -smpSmExecute event=6 state=21 -smpSmExecute event=25 state=22 -DHKey (Shared Secret) -[bf891259 97f62954 0f8d8934 5bcd585f] -[48fc2eb4 4c6f5c19 b8f817a9 907571b3] -smpSmExecute event=28 state=23 -T -[72c2ed8a fe1ae569 8237053f b5af654c] -smpSmExecute event=28 state=24 -MAC -[273eaeb4 163166a1 362c8773 888811aa] -smpSmExecute event=28 state=25 -LTK -[7eacbbfe 776de847 1b78effc 32e84ba5] -smpSmExecute event=28 state=26 -DHKey Ea -[e619e7cf 7d654f17 f621cb5c f6dd720b] -smpSmExecute event=28 state=27 -DHKey Eb -[1e72f16f dcab7a66 2787c1ce ee93d5ec] -connId=1 idleMask=0x0001 -connId=1 idleMask=0x0001 -smpSmExecute event=8 state=36 -Dats got evt 44 ->>> Connection encrypted <<< -Dats got evt 47 -smpSmExecute event=12 state=37 -smpSmExecute event=12 state=37 -smpSmExecute event=6 state=37 -smpSmExecute event=6 state=37 -smpSmExecute event=14 state=37 -connId=1 idleMask=0x0000 -Dats got evt 47 -Dats got evt 42 ->>> Pairing completed successfully <<< -dmDevPassEvtToDevPriv: event: 13, param: 1, advHandle: 0 -Dats got evt 58 -Dats got evt 63 -Dats got evt 153 - -``` -When PHY change performed -``` -> btn 2 s -Short Button 2 Press -2 MBit TX and RX PHY Requested -Dats got evt 70 -DM_PHY_UPDATE_IND - RX: 2, TX: 2 -Dats got evt 65 -App got evt 16 -App got evt 16 -connId=1 idleMask=0x0000 -> btn 2 s -Short Button 2 Press -LE Coded S2 TX and RX PHY Requested -Dats got evt 70 -DM_PHY_UPDATE_IND - RX: 3, TX: 3 -Dats got evt 65 -App got evt 16 -App got evt 16 -dmConnUpdExecute event=113 state=3 -dmConnSmExecute event=30 state=3 -Dats got evt 41 -> btn 2 s -Short Button 2 Press -LE Coded S8 TX and RX PHY Requested -Dats got evt 70 -DM_PHY_UPDATE_IND - RX: 3, TX: 3 -> btn 2 s -Short Button 2 Press -1 MBit TX and RX PHY Requested -Dats got evt 70 -DM_PHY_UPDATE_IND - RX: 1, TX: 1 -Dats got evt 65 -``` -When message received from peer -``` -hello world -hciCoreTxAclStart len=18 -Dats got evt 18 -``` -When secure message recevied from peer -``` ->> Received secure data << -Secret number is 0x42 -Dats got evt 18 - -``` -### Commands -Type the desired command and parameter (if applicable) and press enter to execute the command. - -__help__ Displays the available commands. -__echo (on|off)__ Enables or disables the input echo. On by default. -__btn (ID) (s|m|l|x)__ Simulates button presses. Example: "btn 1 s" for a short button press on button 1. -__pin (ConnID) (Pin Code)__ Used to input the pairing pin code. - -## Push buttons -Push buttons can be used to interact with the application. - -__short__ press is less than 200 ms -__medium__ press is between 200 and 500 ms -__long__ press is between 500 and 1000 ms -__extra long__ press is greater than 1000 ms - -### When disconnected -1. Button 1 short press: Start advertising -2. Button 1 medium press: Enter bondable mode -3. Button 1 long press: Clear all bonding info -4. Button 1 extra long press: Show version info -5. Button 2 short press: Stop advertising - -### When connected -1. Button 2 short press: Change PHY (1M-2M-Coded_S2-Coded_S8) +# BLE_dats +Refer to the [BLE_datc_dats](../../../Libraries/Cordio/docs/Applications/BLE_datc_dats.md) documentation in the Cordio Library. \ No newline at end of file diff --git a/Libraries/Cordio/CONTRIBUTING.md b/Libraries/Cordio/CONTRIBUTING.md deleted file mode 100644 index 6281ea6e43..0000000000 --- a/Libraries/Cordio/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -This repository does not support contribution. diff --git a/Libraries/Cordio/README.md b/Libraries/Cordio/README.md index 4006dd01ab..4ed13fd01b 100644 --- a/Libraries/Cordio/README.md +++ b/Libraries/Cordio/README.md @@ -1,84 +1,25 @@ -Packetcraft Protocol Software -============================= +# Cordio +This library implements the Bluetooth Low Energy stack , forked from [Packetcraft](https://github.com/packetcraft-inc/stacks). It depends on additional libraries within the msdk repository. All of the applications utilizing this library can be found in the [Examples](../../Examples) directory. -Packetcraft protocol software is a collection of embedded stacks implementing the Bluetooth Low Energy Link Layer, Host, Profile and Mesh specification (www.bluetooth.org). +## Getting Started +The best application to get started with is the [BLE_periph](docs/Applications/BLE_periph.md) application. It is a simple periphal application that will allow you to advertise and connect with a central device such as a smart phone. -This repository contains open source release of Packetcraft's software. This is a qualified release and may be used in products. Please consult the [Bluetooth Qualification Process](https://www.bluetooth.com/develop-with-bluetooth/qualification-listing) for further details regarding additional certification requirements. +Follow the MSDK [README](../../README.md) instructions to install the necessary tools and create a new project. Build and run the BLE_periph application for the appropriate target. +## ADI Attach +ADI Attach is a smart phone applicaiton that can be used for Bluetooth debugging and development. +* Scan for advertising peripherals. +* Connect to devices and discover profiles, services. +* Read and write charcteristics. +* Subscribe to noficiations. +* Perform over-the-air firmware updates with supporing devices. -Release notes -------------- +## BLE-PyDex +BLE-PyDex is a hardware agnostic Bluetooth device explorer designed to aid in the development and debugging of Bluetooth applications. -This latest release of the Packetcraft Host and Packetcraft Controller is Bluetooth 5.2 qualified and implements the following new Bluetooth 5.2 features: LE Isochronous Channels, Enhanced Attribute Protocol, and LE Power Control. +https://github.com/EdwinFairchild/BLE-PyDex -This release includes the following completed requirements for r20.05: - - FW-3340 Isochronous Demo: single BIS data stream - FW-3354 TCRL.2019-1 compliant - FW-3359 Core v5.2: LE Isochronous Channels (ISO) - FW-3360 Core v5.2: LE Power Control - FW-3361 Core v5.2: Enhanced ATT (EATT) - FW-3617 Core v5.2: Isochronous Abstraction Layer (ISOAL) - FW-3726 Core v5.2: Host Support for LE Isochronous Channels (ISO) - FW-3727 Nordic nRF5 SDK 16.0.0 - FW-3730 Compile BLE host for 64-bit platform - FW-3736 Light CTL Model - FW-3738 Mesh v1.0.1 compliant - FW-3739 TCRL.2019-2 qualification - FW-3750 Laird BL654 platform - FW-3767 SBC codec - FW-3803 GCC compiler support for gcc-arm-none-eabi-9-2019-q4-major - FW-3820 Protect against SweynTooth vulnerability - - -Getting Started ---------------- - -**1. Toolchain** - -If using a system with package manager such as Ubuntu, use the following command line to install dependent tools: - -``` -sudo apt-get install build-essential binutils-arm-none-eabi -``` - -Alternatively download and install the GNU Arm Embedded Toolchain from here and add the path to the `bin` folder to your PATH environment. - -* [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm) - - -**2. Build** - -Select a project to build. The following folders contains buildable projects: - -* Packetcraft Profile sample application: [ble-apps/build](ble-apps/build) -* Packetcraft Mesh sample application: [ble-mesh-apps/build](ble-mesh-apps/build) -* Packetcraft Controller sample application: [controller/build](controller/build) - -Consult the Sample App Developer's Guide (below) for more information about the application usage. - -For example, to build Packetcraft's sample Bluetooth Low Energy Tag device use the following make command from the root repo folder: - -``` -make -C ble-apps/build/tag/gcc -``` - -This command will build a complete device image including the Tag sample application, Profiles, Host, Link Layer and platform drivers for the Nordic nRF52840 / PCA10056 development board. The resulting image is located at `ble-apps/build/tag/gcc/bin/tag.bin`. - - -**3. Program** - -To install the firmware image on a Nordic PCA10056 developmnent board, plug a USB cable into your PCA10056. Drag-n-Drop the resulting image from the previous step onto the mass storage drive called "JLINK". - - -Documentation -------------- - -See the docs directory. - - -Certification -------------- +## Certification Bluetooth LE Mesh solution implementing of the Bluetooth Mesh Profile 1.0 and the Bluetooth Mesh Model 1.0 wireless technical specifications @@ -92,36 +33,111 @@ Bluetooth LE Link Layer protocol stack implementing Bluetooth 5.2 specification * [QDID 146281](https://launchstudio.bluetooth.com/ListingDetails/103599) +MAX32655 controller subsystem + +* [QDID 159701](https://launchstudio.bluetooth.com/ListingDetails/119468) + +MAX32665 controller subsystem + +* [QDID 142345](https://launchstudio.bluetooth.com/ListingDetails/98880) + +Consult the [Bluetooth Qualification Process](https://www.bluetooth.com/develop-with-bluetooth/qualification-listing) for further details regarding certification. -Verification ------------- +## Supported Features -Packetcraft Mesh is verified with the TCRL.2019-2 compliance tester using the following: +* **LE Dual Mode Topology:** Advertise/Scan while maintaining multiple adjacent connections. +* **2M PHY:** High speed PHY with 2 Mbps symbol rate. +* **Coded PHY:** Forward error correction, 125 kbps or 500 kbps symbol rate. +* **Extended Advertising:** Enhanced advertising and scanning. +* **Periodic Advertising:** Broadcasting and receiving periodic advertisements. +* **EATT:** Enhanced Attribute protocol. +* **LE Secure Connections:** LE Secure Connections is an enhanced security feature introduced in Bluetooth v4.2. It uses a Federal Information Processing Standards (FIPS) compliant algorithm called Elliptic Curve Diffie Hellman (ECDH) for key generation. +* **Data Length Extension:** Extend the maximum data length supported in a connection. +* **LE Power Control:** Dynamic TX power control. +* **\*OTA firmware update:** Over-the-air firmware update is not a standard Bluetooth feature. We have a wireless data exchange service that can be used for OTA firmware updates. See the BLE_otac_otas examples, the ADI Attach smart phone app, and [BLE-PyDex](https://github.com/EdwinFairchild/BLE-PyDex) for details. -* Bluetooth Profile Tuning Suites 7.6.1 +## Features in development +* **Direction finding:** Detect the direction of the incoming signal. Also known as Angle of Arrival (AoA) and Angle of Departure (AoD). Hardware support on MAX32655 and MAX32690, unavailable on MAX32665, software in development. +* **LE Audio:** Isochronous audio with Bluetooth LE. Hardare support on all platforms, software in development. -Packetcraft Host is verified with the TCRL.2019-2 compliance tester using the following: +## Frequently asked questions -* Bluetooth Profile Tuning Suites 7.6.1 +### How do I change the advertising parameters? +Peripheral applications will have a static structure that contains all of the advertising parameters. If run-time changes are desired, you must call ```AppAdvStop()``` before changing the parameters and ```AppAdvStart()``` to resume. -Packetcraft Profiles is verified with the TCRL.2018-2 compliance tester using the following: -* Bluetooth Profile Tuning Suites 7.3.0 +With this configuration, the device will advertise at a fast interval (300 * 0.625 = 187.5 ms) for 5 seconds. It will then advertise slowly (1600 * 0.625 = 1000 ms) indefinetly. +``` c +/*! configurable parameters for advertising */ +static const appAdvCfg_t datsAdvCfg = { + { 5000, 0}, /*! Advertising durations in ms, 0 is infinite */ + { 300, 1600} /*! Advertising intervals in 0.625 ms units */ +}; +``` + +### How do I change the connection parameters? +Only the master of the connection can change the connection parameters. Peripheral devices can request a change, but only the master can accept and set the connection parameters. Cell phones and mobile operatings systems have different restrictions on the connection parameters. + +Peripheral applications have the following structure that is used to request connection parameter updates. + +```c +/* iOS connection parameter update requirements + + The connection parameter request may be rejected if it does not meet the following guidelines: + * Peripheral Latency of up to 30 connection intervals. + * Supervision Timeout from 2 seconds to 6 seconds. + * Interval Min of at least 15 ms. + * Interval Min is a multiple of 15 ms. + * One of the following: + * Interval Max at least 15 ms greater than Interval Min. + * Interval Max and Interval Min both set to 15 ms. + * Interval Max * (Peripheral Latency + 1) of 2 seconds or less. + * Supervision Timeout greater than Interval Max * (Peripheral Latency + 1) * 3. +*/ + +/*! configurable parameters for connection parameter update */ +static const appUpdateCfg_t datsUpdateCfg = { + 0, + /*! ^ Connection idle period in ms before attempting + connection parameter update. set to zero to disable */ + (15 * 8 / 1.25), /*! Minimum connection interval in 1.25ms units */ + (15 * 12 / 1.25), /*! Maximum connection interval in 1.25ms units */ + 0, /*! Connection latency */ + 600, /*! Supervision timeout in 10ms units */ + 5 /*! Number of update attempts before giving up */ +}; +``` +The DmConnUpdate() function can also be used to request a connection parameter update from the peripheral or initiate one from the master. + +```c +/*************************************************************************************************/ +/*! + * \brief Update the connection parameters of an open connection + * + * \param connId Connection identifier. + * \param pConnSpec Connection specification. + * + * \return None. + */ +/*************************************************************************************************/ +void DmConnUpdate(dmConnId_t connId, hciConnSpec_t *pConnSpec); +``` -Packetcraft Link Layer conforms to the Bluetooth TCRL.2019-2 requirements verified with the following: +### How do I use the low power modes? +All of the applications will enter sleep mode in idle when build with ```DEBUG=0```. The Wireless Stack Framework (WSF) operating system will call PalSysSleep() mode when idle. With ```DEBUG=1```, the CPU will stay in active mode to leave the debugger enabled. -* Teledyne Harmony LE Tester version 19.12.16916.21195 +To enter the lowest power states, refer to the BLE_FreeRTOS application. This will create FreeRTOS tasks for the Cordio stack and allow users to add additional tasks. Enable ```configUSE_TICKLESS_IDLE``` and the device will enter standby mode and deep sleep between events. -This product was compiled and tested with the following version of GNU GCC +**WARNING:** The CPU debugger is disabled in sleep modes. If your application enters sleep mode directly after reset, it will be difficult to debug and reporgram. -* gcc-arm-none-eabi-9-2019-q4-major +### How do I send unformatted data like a UART? +Unfortunatly there is not a Bluetooth SIG defined standard for this protocol. This stack has a proprietary data transfer service that is used to transmit unformatted data between devices. Refer to the BLE_dats (BLE Data Server) for the peripheral application. You can connect to this device with the BLE_datc (BLE data client) application to see simple data transmission. Refer to the BLE_dats and BLE_dats [README](docs/Applications/BLE_datc_dats.md) for more information. +### How do I additional tasks and handlers to the WSF RTOS? -Platforms ---------- +## Additional Documentation +The Cordio architecture is described [here](docs/ARCHITECTURE.md). -This release was tested on the following platforms. Note: platforms listed may not be available in this repository. +Documentation for each of the supporting applications can be found [here](docs/Applications). -* Nordic nRF52840 / PCA10056 development kit / Nordic nRF5 SDK 16.0.0 (make configuration: "PLATFORM=nordic BOARD=PCA10056") -* Nordic nRF52832 / PCA10040 development kit / Nordic nRF5 SDK 16.0.0 (make configuration: "PLATFORM=nordic BOARD=PCA10040") -* Laird BL654 / 451-00004 USB adapter / Nordic nRF5 SDK 16.0.0 (make configuration: "PLATFORM=laird") +Documentation for Python tools used for Bluetooth development and debugging can be found [here](../../Tools/Bluetooth/README.md). diff --git a/Libraries/Cordio/docs/ARCHITECTURE.md b/Libraries/Cordio/docs/ARCHITECTURE.md new file mode 100644 index 0000000000..4a80896ae2 --- /dev/null +++ b/Libraries/Cordio/docs/ARCHITECTURE.md @@ -0,0 +1,80 @@ +# Architecture + +This document describes the Cordio software architecture. Refer to the Bluetooth specificaion Volume 1, Part A for additional information regarding the Bluetooth architecture. + +![Software Stack](res/Software_Stack.jpg) + +## Application + +The App Framework performs many operations common to Bluetooth LE embedded applications, such as: +* Application-level device, connection, and security management. +* Simple user interface abstractions for button press handling, sounds, display, and other user feedback. +* An abstracted device database for storing bonding data and other device parameters. + +## Profiles and Services + +The GATT Profile specifies the structure in which profile data is exchanged. This structure defines basic elements such as services and characteristics, used in a profile. The top level of the hierarchy is a profile. A profile is composed of one or more services necessary to fulfill a use case. A service is composed of characteristics or references to other services. Each characteristic contains a value and may contain optional information about the value. The service and characteristic and the components of the characteristic (i.e., value and descriptors) contain the profile data and are all stored in Attributes on the server. + +![Profiles](res/Profiles.PNG) + +## Wireless Stack Framework + +The Wireless Software Foundation (WSF) is a simple OS wrapper, porting layer, and general-purpose software service used by the software system. The goal of WSF is to stay small and lean, supporting only the basic services required by the stack. It consists of the following: +* Event handler service with event and message passing. +* Timer service. +* Queue and buffer management service. +* Portable data types. +* Critical sections and task locking. +* Trace and assert diagnostic services. +* Security interfaces for encryption and random number generation. + +### Platform Adaption Layer + +The Platform Adaption Layer is the abstraction between the software stack and the hardware. It includes APIs for timers, UART, RTC, and various system level functions such as sleep and memory management. + +## Attribute Protocol +The ATT subsystem implements the attribute protocol and generic attribute profile (GATT). It contains two independent subsystems: The attribute protocol client (ATTC) and attribute protocol server (ATTS). + +ATTC implements all attribute protocol client features and is designed to meet the client requirements of the generic attribute profile. ATTC can support multiple simultaneous connections to different servers. + +ATTS implements all attribute protocol server features and has support for multiple simultaneous client connections. ATTS also implements the server features defined by the generic attribute profile. + +## Device Manager + +The DM subsystem implements device management procedures required by the stack. These procedures are partitioned by procedure category and device role (master or slave). The following procedures are implemented in DM: + +* Advertising and device visibility: Enable/disable advertising, set advertising parameters and data, set connectability and discoverability. +* Scanning and device discovery: Start/stop scanning, set scan parameters, advertising reports, name discovery. +* Connection management: Create/accept/remove connections, set/update connection parameters, read RSSI. +* Security management: Bonding, storage of security parameters, authentication, encryption, authorization, random address management. +* Local device management: Initialization and reset, set local parameters, vendor-specific commands. +DM procedures support the Generic Access Profile (GAP) when applicable. + +## Security Manager Protocol +The Security Manager Protocol (SMP) is the peer-to-peer protocol used to generate encryption keys and identity keys. The protocol operates over a dedicated fixed L2CAP channel. The SMP block also manages storage of the encryption keys and identity keys and is responsible for generating random addresses and resolving random addresses to known device identities. The SMP block interfaces directly with the Controller to provide stored keys used for encryption and authentication during the encryption or pairing procedures. + +The SMP subsystem implements the security manager protocol. It contains two independent subsystems: +* The initiator (SMPI). SMPI implements the initiator features of the security manager protocol and has support for multiple simultaneous connections. +* The responder (SMPR). SMPR implements the responder features of the security manager protocol and has support for only one connection (by Bluetooth specification design). + +SMP also implements the cryptographic toolbox, which uses AES. The interface to AES is asynchronous and abstracted through WSF. SMP also implements functions to support data signing. + +## Logical Link Control Adaptation Protocol + +The L2CAP (Logical Link Control Adaptation Protocol) resource manager block is responsible for managing the ordering of submission of PDU fragments to the baseband and some relative scheduling between channels to ensure that L2CAP channels with QoS commitments are not denied access to the physical channel due to Controller resource exhaustion. This is required because the architectural model does not assume that a Controller has limitless buffering, or that the HCI is a pipe of infinite bandwidth. + +L2CAP Resource Managers may also carry out traffic conformance policing to ensure that applications are submitting L2CAP SDUs within the bounds of their negotiated QoS settings. The general Bluetooth data transport model assumes well-behaved applications, and does not define how an implementation is expected to deal with this problem. + +## Host Controller Interface + +The HCI subsystem implements the host-controller interface specification. This specification defines commands, events, and data packets sent between a Bluetooth LE protocol stack on a host and a link layer on a controller. +The HCI API is optimized to be a thin interface layer for a single chip system. It is configurable for either a single chip system or traditional system with wired HCI. +This configurability is accomplished through a layered implementation. A core layer can be configured for either a single chip system or wired HCI. A transport and driver layer below the core layer can be configured for different wired transports such as UART. + +## Link Layer + +The link layer is responsible for the creation, modification and release of logical links (and, if required, their associated logical transports), as well as the update of parameters related to physical links between devices. The link layer achieves this by communicating with the link layer in remote Bluetooth devices using the Link Layer Protocol (LL) in LE. The LL protocol allows the creation of new logical links and logical transports between devices when required, as well as the general control of link and transport attributes such as the enabling of encryption on the logical transport, and the adapting of transmit power on the physical link. + +## Physical Layer + +The PHY block is responsible for transmitting and receiving packets of information on the physical channel. A control path between the baseband and the PHY block allows the baseband block to control the timing and frequency carrier of the PHY block. The PHY block transforms a stream of data to and from the physical channel and the baseband into required formats. diff --git a/Libraries/Cordio/docs/Applications/BLE_datc_dats.md b/Libraries/Cordio/docs/Applications/BLE_datc_dats.md new file mode 100644 index 0000000000..2de62ffdd6 --- /dev/null +++ b/Libraries/Cordio/docs/Applications/BLE_datc_dats.md @@ -0,0 +1,1088 @@ +# BLE_datc_dats +BLE Data Client and Data Server. These examples demonstrate a simple data client and server. The intent here is to show simple unformatted data exchange between two devices. + +The Bluetooth specification does not define a simple data exchange protocol, similar to UART. We use a proprietary GATT service to offer this feature. + +The data server will advertise with a devices name of "DATS". The data client will scan for this device and create a connection. Once the conneciton has been created and the client completes the discovery, it will enable notificaitons and indiciations on the proprietary data serivce. This will allow the server to transmit data to the client with notifications to the proprietary data characteristic. The client can transmit data to the server by writing to the proprietary data characteristic. + +

+ +

+ +

+ADI Attach connected to DATS +

+ +## ARM Proprietary data service + +**UUID:** E0262760-08C2-11E1-9073-0E8AC72E1001 + +This is a proprietary serivce is used for simple unformatted data exchange between the server and the client. + +## Secure data service + +**UUID:** 42FC367E-32D9-4285-87C6-339924D135BE + +This is another proprietary service used for secure data exchange that requires elevated levels of encryption and authentication. Devices must be paired with LE Secure Connections to enable data transfer with this service. + +## Passkey input +Upon server discovery the user will be prompted to enter a passkey. +An arbitrary pin can be entered in the following format +``` +pin (connId) passkey +Eg: +pin 1 123456 + +``` +Next the server is expected to enter the same connId and passkey +to establish a secure connection and share bonding information +which for demonstration purposes,is echoed via the trace mechanism + +Note that either the client or server can enter the passkey first. +The peer device must then match. + +## LEDs + +The red LED will indicate that an error assertion has occurred. + +The green LED indicates CPU activity. When the LED is on, the CPU is active, when the LED +is off, the CPU is in sleep mode. + +## Board Setup + +### Board Selection + +Before building firmware you must select the correct value for BOARD in project.mk, e.g. "EvKit_V1". + +### Required Connections +- Connect a USB cable between the PC and the (USB/PWR - UART) connector. + +### Trace Serial Port +When TRACE is enabled in the project.mk, the on-board USB-to-UART adapter can +be used to view the trace messages and interact with the application. Open a serial port terminal with +the following settings. + +Baud : 115200 +Char size : 8 +Parity : None +Stop bits : 1 +HW Flow Control : No +SW Flow Control : No + + +# BLE_Dats + +Bluetooth data server that advertises as "DATS" and accepts connection requests. This exmaples contains two proprietary services that are used to show simple message passing to and from the data client. + +### Expected Output + +On startup: +``` +terminal: init +32kHz trimmed to 0x16 +DatsHandlerInit +Dats got evt 32 +>>> Reset complete <<< +dmAdvActConfig: state: 0 +dmAdvActSetData: state: 0 +dmAdvActSetData: state: 0 +dmAdvActStart: state: 0 +HCI_LE_ADV_ENABLE_CMD_CMPL_CBACK_EVT: state: 3 +dmDevPassEvtToDevPriv: event: 12, param: 33, advHandle: 0 +Dats got evt 33 +>>> Advertising started <<< +Dats got evt 21 +Database hash updated + +``` + +When a connection attempting to connect to the client. +``` +Dats got evt 21 +Database hash updated +Dats got evt 153 +dmConnIdByBdAddr not found +dmConnCcbAlloc 1 +dmConnSmExecute event=28 state=0 +dmAdvConnected: state: 1 +dmDevPassEvtToDevPriv: event: 13, param: 34, advHandle: 0 +smpDbGetRecord: connId: 1 type: 0 +smpDbAddDevice +SmpDbGetFailureCount: connId: 1 count: 0 +smpDbGetRecord: connId: 1 type: 0 +smpDbAddDevice +SmpDbGetPairingDisabledTime: connId: 1 period: 0 attemptMult: 0 +Dats got evt 39 +>>> Connection opened <<< +Dats got evt 65 +Dats got evt 22 +smpSmExecute event=6 state=0 +connId=1 idleMask=0x0001 +Dats got evt 49 +smpSmExecute event=2 state=2 +smpSmExecute event=17 state=3 +smpSmExecute event=4 state=5 +smpSmExecute event=6 state=4 +smpSmExecute event=20 state=6 +connId=1 idleMask=0x0001 +Dats got evt 46 +>>> Prompt user to enter passkey <<< +Dats got evt 87 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 +connId=1 idleMask=0x0005 + +``` +When matching pins have been entered +``` +> smpSmExecute event=4 state=13 +Rand Nb +[52730a1e 080e2b3f 6d010f4b 0d29b8ac] +smpSmExecute event=28 state=15 +Cbi +[520aab85 e23b56d5 70598231 64553242] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[634082f9 ae97841d 408a0609 d3149a0f] +Ca Peer +[634082f9 ae97841d 408a0609 d3149a0f] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[2b4f65e1 41465986 1732c49b 0779c049] +smpSmExecute event=28 state=15 +Cbi +[34b63e15 0a0b1d8a fbaac17d ae94c891] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[e7b74ec3 7bb660e0 fd3ffb69 a70fc1b5] +Ca Peer +[e7b74ec3 7bb660e0 fd3ffb69 a70fc1b5] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[cb42c521 d4edb9cd fe2a5777 526d153d] +smpSmExecute event=28 state=15 +Cbi +[58d9a8c4 c4710a1a bd41ed81 2e666953] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[d100648f ae87b3e0 850e96ef 3c2c9a47] +Ca Peer +[d100648f ae87b3e0 850e96ef 3c2c9a47] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[21a3cd36 613f1834 c6e3d6fa 337e3f6c] +smpSmExecute event=28 state=15 +Cbi +[314e5afe c5799362 0c3c7e01 54a62b7d] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[bc03c14d cf73fbab c64c8de8 65c9bd3f] +Ca Peer +[bc03c14d cf73fbab c64c8de8 65c9bd3f] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[3e0cb037 9edea6c2 dfdd238f eee47a18] +smpSmExecute event=28 state=15 +Cbi +[223876ac 32cfa06e 5764766f e655cfda] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[3a1dceac 4ed11dc5 60384042 5f625042] +Ca Peer +[3a1dceac 4ed11dc5 60384042 5f625042] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[23ca1caf 70a3ba5b fd40e6ca db907405] +smpSmExecute event=28 state=15 +Cbi +[0f969efc f159e4c6 588c68ae 5d1f9851] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[c34f8c33 3e16ee08 3cac6f79 1eea831f] +Ca Peer +[c34f8c33 3e16ee08 3cac6f79 1eea831f] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[840f704c 59845fc2 47d5463a 9c68159b] +smpSmExecute event=28 state=15 +Cbi +[f5a84dfe 36bdfc2d 410e133d 0c474039] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[e27af695 a9227a18 74c2ba3d 57ed5254] +Ca Peer +[e27af695 a9227a18 74c2ba3d 57ed5254] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[5558d557 ba639669 226f7665 98ba1755] +smpSmExecute event=28 state=15 +Cbi +[c8158453 c50a9448 236c7bd5 fe249a0d] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[530da1cb 834ec9fa 6076fd05 037dce54] +Ca Peer +[530da1cb 834ec9fa 6076fd05 037dce54] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[9f57fda8 897aac72 810475a4 eda95e4c] +smpSmExecute event=28 state=15 +Cbi +[12494fdf 83718797 5efa3ff7 4e230a9d] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[b9c97dbe 7a725ab4 20c59148 10821669] +Ca Peer +[b9c97dbe 7a725ab4 20c59148 10821669] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[564e5d0e 2605341f 4d5b6913 0c89c1aa] +smpSmExecute event=28 state=15 +Cbi +[a8b37963 eafdcaee ecbf62ab a23f686a] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[b1387cd1 054a3616 3a73b06d 085e74b7] +Ca Peer +[b1387cd1 054a3616 3a73b06d 085e74b7] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[fc4d0a4e 2e6ca8f1 65f242a8 88876d0e] +smpSmExecute event=28 state=15 +Cbi +[623c1256 7e20dba1 f5257b86 11b54ece] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[4540e3cd 77e8ac57 8024607c 0de42ce2] +Ca Peer +[4540e3cd 77e8ac57 8024607c 0de42ce2] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[144e1412 64996fa0 d686011f 7913327d] +smpSmExecute event=28 state=15 +Cbi +[b354740a 3d097abc e33af952 cffc0e8a] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[ba1e5505 2e488dda b984bd08 2d07fdeb] +Ca Peer +[ba1e5505 2e488dda b984bd08 2d07fdeb] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[2596e6cd 44929e11 9791ba02 62e3feef] +smpSmExecute event=28 state=15 +Cbi +[3790e2f7 96ca63b6 826bbf5c 077c3f31] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[fe05bd6a 1f277dee 124de8b0 02c03343] +Ca Peer +[fe05bd6a 1f277dee 124de8b0 02c03343] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[06175016 3aabb9f3 f3aa5925 c9b8a43d] +smpSmExecute event=28 state=15 +Cbi +[57d2399c 89fbc8f0 3ee71020 f66b45d5] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[c2dff69b 7ae8eba8 e92f3b57 ff3978c7] +Ca Peer +[c2dff69b 7ae8eba8 e92f3b57 ff3978c7] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[5c70daab 66fe0495 07d0e27d 824d9865] +smpSmExecute event=28 state=15 +Cbi +[f03928aa 2324a2ca 8c3c1fd8 9d589afe] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[9f8dec26 018dcea5 0cc56156 32b9107b] +Ca Peer +[9f8dec26 018dcea5 0cc56156 32b9107b] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[fd89b81d e2b3fdaf f22cf4c4 b39da763] +smpSmExecute event=28 state=15 +Cbi +[c005af08 39334b4a ac68cf0a ca5acc00] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[94681382 aa6a4d27 1b8eb879 a5ed8043] +Ca Peer +[94681382 aa6a4d27 1b8eb879 a5ed8043] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[5b0789ba 4bd1a9f8 10e15f9d 0dbd4ac2] +smpSmExecute event=28 state=15 +Cbi +[b719fe1d 02e6cc10 8776a1b4 0bc0fa6b] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[3f8a85da fad78d81 0c8e0733 876df6fb] +Ca Peer +[3f8a85da fad78d81 0c8e0733 876df6fb] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[c0c90b30 03659e86 a143abe4 ec289e73] +smpSmExecute event=28 state=15 +Cbi +[d02d6808 35888e79 55e04238 f0930c07] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[4efc0b02 bcd8bc6a ac93b70c effeaee1] +Ca Peer +[4efc0b02 bcd8bc6a ac93b70c effeaee1] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[96aab51d 5e627668 ba927ed6 d1192554] +smpSmExecute event=28 state=15 +Cbi +[49660e21 5b3e82cd 32e3ac9a d839ad2d] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[2db916d0 32b02469 1711edf5 812ae090] +Ca Peer +[2db916d0 32b02469 1711edf5 812ae090] +connId=1 idleMask=0x0001 +smpSmExecute event=26 state=18 +smpSmExecute event=6 state=14 +Rand Nb +[d9e874e4 9b02cb3f 9aac021d 7ad59561] +smpSmExecute event=28 state=15 +Cbi +[837b81cf 6c409caa c29a550b 649b2c46] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=16 +smpSmExecute event=28 state=17 +Ca +[f3d0b1b5 76097bfb 14418e57 6d3c11ba] +Ca Peer +[f3d0b1b5 76097bfb 14418e57 6d3c11ba] +smpSmExecute event=27 state=18 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=21 +smpSmExecute event=25 state=22 +DHKey (Shared Secret) +[bf891259 97f62954 0f8d8934 5bcd585f] +[48fc2eb4 4c6f5c19 b8f817a9 907571b3] +smpSmExecute event=28 state=23 +T +[72c2ed8a fe1ae569 8237053f b5af654c] +smpSmExecute event=28 state=24 +MAC +[273eaeb4 163166a1 362c8773 888811aa] +smpSmExecute event=28 state=25 +LTK +[7eacbbfe 776de847 1b78effc 32e84ba5] +smpSmExecute event=28 state=26 +DHKey Ea +[e619e7cf 7d654f17 f621cb5c f6dd720b] +smpSmExecute event=28 state=27 +DHKey Eb +[1e72f16f dcab7a66 2787c1ce ee93d5ec] +connId=1 idleMask=0x0001 +connId=1 idleMask=0x0001 +smpSmExecute event=8 state=36 +Dats got evt 44 +>>> Connection encrypted <<< +Dats got evt 47 +smpSmExecute event=12 state=37 +smpSmExecute event=12 state=37 +smpSmExecute event=6 state=37 +smpSmExecute event=6 state=37 +smpSmExecute event=14 state=37 +connId=1 idleMask=0x0000 +Dats got evt 47 +Dats got evt 42 +>>> Pairing completed successfully <<< +dmDevPassEvtToDevPriv: event: 13, param: 1, advHandle: 0 +Dats got evt 58 +Dats got evt 63 +Dats got evt 153 + +``` +When PHY change performed +``` +> btn 2 s +Short Button 2 Press +2 MBit TX and RX PHY Requested +Dats got evt 70 +DM_PHY_UPDATE_IND - RX: 2, TX: 2 +Dats got evt 65 +App got evt 16 +App got evt 16 +connId=1 idleMask=0x0000 +> btn 2 s +Short Button 2 Press +LE Coded S2 TX and RX PHY Requested +Dats got evt 70 +DM_PHY_UPDATE_IND - RX: 3, TX: 3 +Dats got evt 65 +App got evt 16 +App got evt 16 +dmConnUpdExecute event=113 state=3 +dmConnSmExecute event=30 state=3 +Dats got evt 41 +> btn 2 s +Short Button 2 Press +LE Coded S8 TX and RX PHY Requested +Dats got evt 70 +DM_PHY_UPDATE_IND - RX: 3, TX: 3 +> btn 2 s +Short Button 2 Press +1 MBit TX and RX PHY Requested +Dats got evt 70 +DM_PHY_UPDATE_IND - RX: 1, TX: 1 +Dats got evt 65 +``` +When message received from peer +``` +hello world +hciCoreTxAclStart len=18 +Dats got evt 18 +``` +When secure message recevied from peer +``` +>> Received secure data << +Secret number is 0x42 +Dats got evt 18 + +``` +### Commands +Type the desired command and parameter (if applicable) and press enter to execute the command. + +__help__ Displays the available commands. +__echo (on|off)__ Enables or disables the input echo. On by default. +__btn (ID) (s|m|l|x)__ Simulates button presses. Example: "btn 1 s" for a short button press on button 1. +__pin (ConnID) (Pin Code)__ Used to input the pairing pin code. + +## Push buttons +Push buttons can be used to interact with the application. + +__short__ press is less than 200 ms +__medium__ press is between 200 and 500 ms +__long__ press is between 500 and 1000 ms +__extra long__ press is greater than 1000 ms + +### When disconnected +1. Button 1 short press: Start advertising +2. Button 1 medium press: Enter bondable mode +3. Button 1 long press: Clear all bonding info +4. Button 1 extra long press: Show version info +5. Button 2 short press: Stop advertising + +### When connected +1. Button 2 short press: Change PHY (1M-2M-Coded_S2-Coded_S8) + +# BLE_Datc + +Bluetooth data client that scans and connections to devices advertising with the device name "DATS". The client will automatically discover the profiles and services on the device, subscribing to notifications and indications to enable the unformatted data exchange with the proprietary data service. + +### Expected Output + +On startup: +``` +terminal: init +32kHz trimmed to 0xF +DatcHandlerInit +Calculating database hash +Datc got evt 32 +>>> Reset complete <<< +Datc got evt 58 +Database hash calculation complete +Datc got evt 21 +Database hash updated +dmDevPassEvtToDevPriv: event: 13, param: 1, advHandle: 0 +Datc got evt 63 +Datc got evt 153 +dmDevPassEvtToDevPriv: event: 12, param: 36, advHandle: 0 +Datc got evt 36 +>>> Scanning started <<< +``` + +When a scan report has been received: +``` +Scan Report: + 55:CF:67:1F:6F:27 +Scan Report: + 00:05:8B:44:12:02 + Name: Fit +``` + +When server has been found: +``` +Scan Report: + 00:18:80:04:52:1F + Name: DATS +dmDevPassEvtToDevPriv: event: 13, param: 37, advHandle: 0 +Datc got evt 37 +Scan results: 4 +dmConnIdByBdAddr not found +dmConnCcbAlloc 1 +>>> Scanning stopped <<< +dmConnSmExecute event=24 state=0 +dmDevPassEvtToDevPriv: event: 14, param: 0, advHandle: 0 +dmConnSmExecute event=28 state=1 +dmDevPassEvtToDevPriv: event: 14, param: 1, advHandle: 0 +dmDevPassEvtToDevPriv: event: 12, param: 39, advHandle: 0 +smpDbGetRecord: connId: 1 type: 0 +smpDbAddDevice +SmpDbGetFailureCount: connId: 1 count: 0 +smpDbGetRecord: connId: 1 type: 0 +smpDbAddDevice +SmpDbGetPairingDisabledTime: connId: 1 period: 0 attemptMult: 0 +Datc got evt 39 +>>> Connection opened <<< +smpSmExecute event=1 state=0 +connId=1 idleMask=0x0001 +Datc got evt 65 +Datc got evt 22 +smpSmExecute event=6 state=1 +smpSmExecute event=17 state=2 +smpSmExecute event=4 state=3 +connId=1 idleMask=0x0001 +Datc got evt 87 +Datc got evt 4 +connId=1 idleMask=0x0009 +smpSmExecute event=6 state=4 +smpSmExecute event=20 state=5 +Datc got evt 46 +>>> Prompt user to enter passkey <<< +Datc got evt 3 +AttcDiscServiceCmpl status 0x00 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 2 +AttcDiscCharCmpl status 0x00 +connId=1 idleMask=0x0009 +Datc got evt 3 +AttcDiscServiceCmpl status 0x00 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 4 +AttcDiscCharCmpl status 0x00 +connId=1 idleMask=0x0009 +Datc got evt 3 +AttcDiscServiceCmpl status 0x00 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 2 +AttcDiscCharCmpl status 0x00 +connId=1 idleMask=0x0009 +Datc got evt 3 +AttcDiscServiceCmpl status 0x00 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 4 +AttcDiscCharCmpl status 0x79 +Datc got evt 2 +AttcDiscCharCmpl status 0x79 +Datc got evt 2 +AttcDiscCharCmpl status 0x00 +connId=1 idleMask=0x0001 +AppDiscComplete connId:1 status:0x04 +connId=1 idleMask=0x0009 +Datc got evt 9 +AttcDiscConfigCmpl status 0x79 +Datc got evt 9 +AttcDiscConfigCmpl status 0x79 +Datc got evt 9 +AttcDiscConfigCmpl status 0x79 +Datc got evt 9 +AttcDiscConfigCmpl status 0x00 +connId=1 idleMask=0x0001 +AppDiscComplete connId:1 status:0x08 +``` +After entering a pin +``` +pin 1 12345 +> smpSmExecute event=4 state=11 +Rand Na +[5fa96af9 f434b4de 3e452813 fef4f5eb] +smpSmExecute event=28 state=12 +Cai +[57964640 e18b1aa1 8ea7d8b2 2eb274c3] +connId=1 idleMask=0x0001 + +``` + +Once server enters a matching pin and encrypted connection is established +``` +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[7e2523a4 be6a8923 8ef900bf d4eaa458] +smpSmExecute event=26 state=16 +Rand Na +[efb856be 61bd11a8 2dff39c0 1f5d4d91] +smpSmExecute event=28 state=12 +Cai +[65f7c942 8c216010 cc73fdc9 bd21120e] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[db4858f8 33a964c1 e35ba27c 1f07e7db] +smpSmExecute event=26 state=16 +Rand Na +[9904fded 40ea2bb1 dfabe4be b9bcba45] +smpSmExecute event=28 state=12 +Cai +[1362d0db 074d32ea 32d0e79c 1155a20b] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[efd27c04 96ff72e0 c893bf54 9c524f0a] +smpSmExecute event=26 state=16 +Rand Na +[5ba16640 fd3af1ae afc6d035 d8eb1fa5] +smpSmExecute event=28 state=12 +Cai +[79603efa ad87d2cd bdc4c83b 17dcffe6] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[c1221276 73df3bf7 90e8df64 741909c1] +smpSmExecute event=26 state=16 +Rand Na +[59ea06d0 760407f7 87415144 fe234a1e] +smpSmExecute event=28 state=12 +Cai +[40b9915c af4a8712 c81e98f9 f197953a] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[325fe15b 5a6862e1 f4de459d 6c91c220] +smpSmExecute event=26 state=16 +Rand Na +[4c56f9f9 b1d91236 8dfb81f8 b0629bb7] +smpSmExecute event=28 state=12 +Cai +[c2fb6b18 63cb9311 d53c3333 0a2924cf] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[7725d42d 35f8e465 b3b6cfed 9bfe125a] +smpSmExecute event=26 state=16 +Rand Na +[3909e384 45979c24 c85d36d3 fc2bd4bf] +smpSmExecute event=28 state=12 +Cai +[9e570480 195412a0 07c84616 36cd6a06] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[1bce9472 21f7d6c4 4f8fe62b 91ac2271] +smpSmExecute event=26 state=16 +Rand Na +[fe57e223 78ca04e3 cd13bd82 ad43289c] +smpSmExecute event=28 state=12 +Cai +[42ba2b2e bd35ebe6 56c59b28 957639d2] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[a35acba5 00eba332 31442e10 aea9dacf] +smpSmExecute event=26 state=16 +Rand Na +[71aa44ad abe2d668 07b79f02 d2a974dc] +smpSmExecute event=28 state=12 +Cai +[5b02fce8 f92549ca 54bea290 c9fdfd1b] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[4a52c87c a504c8cf 49d9e8f0 1a69aca2] +smpSmExecute event=26 state=16 +Rand Na +[0f87eb54 83f4f78b 754d2f74 1b406c0d] +smpSmExecute event=28 state=12 +Cai +[16a9ba43 8c8b39d2 912f1f85 3f738170] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[b2aa1f53 802fa4ad 3e415844 4953c931] +smpSmExecute event=26 state=16 +Rand Na +[466db705 9fd2d031 35759a3f 45869950] +smpSmExecute event=28 state=12 +Cai +[004c8d5f 4413efb9 f60c10c2 8af82058] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[6b93dfa8 91d6bc27 fbb7142a 778d6eab] +smpSmExecute event=26 state=16 +Rand Na +[4d0cfaee 277f0959 ee9ad6b5 bf89e129] +smpSmExecute event=28 state=12 +Cai +[b977b373 4fdeb62d 4b9fc6dd 0cd58ccb] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[7d734f74 37d7575f 9a2176fe 9e0d7793] +smpSmExecute event=26 state=16 +Rand Na +[aa704717 22c5a505 922ea504 c8f32c21] +smpSmExecute event=28 state=12 +Cai +[b8db800a c2cfb643 0ad2127e 154b27e3] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[fb8bfb47 1db075d6 c10dfe20 275580a6] +smpSmExecute event=26 state=16 +Rand Na +[6715c20d 284d6526 c826990b c0266d4d] +smpSmExecute event=28 state=12 +Cai +[9a07bded 4652b3b3 04e58dd3 ddc41f5b] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[9b11572d 6ac46706 2a42ddf7 fa3f7eb6] +smpSmExecute event=26 state=16 +Rand Na +[276b1950 0160195c 2ca2749e 04cc0bba] +smpSmExecute event=28 state=12 +Cai +[7811b835 1ee6cd01 b35e0068 b0e995a2] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[febf4094 ccf93969 adc4d7e3 c3f26246] +smpSmExecute event=26 state=16 +Rand Na +[31c8d021 62bd5eb6 470c008d 0f9a8f69] +smpSmExecute event=28 state=12 +Cai +[6cc99436 0835e6bf b7ccd2a8 81eb7c2d] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[314f5edd e73e8b9e 865c3924 c438e032] +smpSmExecute event=26 state=16 +Rand Na +[4f46b9ce 57474f8d 8d00a000 74bdea15] +smpSmExecute event=28 state=12 +Cai +[baea7468 fabb299a 837bbbfb c47572e2] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[f8a46358 201aab0a ae9aae2c 0c32fb92] +smpSmExecute event=26 state=16 +Rand Na +[b80a6511 3c82e7e6 055243e6 a45202a6] +smpSmExecute event=28 state=12 +Cai +[24c084e8 e92b8e03 1a37f096 f4d5c31f] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[04aa43e8 dac7aa2a 490e6154 11b81966] +smpSmExecute event=26 state=16 +Rand Na +[16bc0b9f a93b2745 729a08b9 85682b0d] +smpSmExecute event=28 state=12 +Cai +[a5caa3a1 b7b66eaa f113972c 88645db6] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[831b8daf 7ae674d8 e2c5fbc3 9fc27be3] +smpSmExecute event=26 state=16 +Rand Na +[3a8e02cf 001e84b3 08d9a24e 19ff9b18] +smpSmExecute event=28 state=12 +Cai +[bf5345f1 299bca3f 0c99eac6 3ea96052] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=13 +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=14 +smpSmExecute event=28 state=15 +Cbi +[0a4dec2e 6aebc804 7bb1a21b aadc18c1] +smpSmExecute event=27 state=16 +smpSmExecute event=25 state=19 +DHKey (Shared Secret) +[7cf8b651 6c0f5bff 7d66bbf6 d8d85abd] +[0ef6bf2d 85a594d2 f55dccc3 6f98dd1d] +smpSmExecute event=28 state=20 +T +[a02f2c9d 9a153f28 0bde8cb2 ab2a7b84] +smpSmExecute event=28 state=21 +MAC +[66ebd01a c4818e8b 1cec71bf f0644ed9] +smpSmExecute event=28 state=22 +LTK +[b4cad222 8324e2fb 71bbca0f 04bfc828] +smpSmExecute event=28 state=23 +DHKey Ea +[a2925a68 0b71e9c3 065a959d 39079b01] +smpSmExecute event=28 state=24 +DHKey Eb +[3ed3c373 5b99fc5e 16577603 7a1ba181] +connId=1 idleMask=0x0001 +smpSmExecute event=6 state=25 +connId=1 idleMask=0x0001 +smpSmExecute event=8 state=34 +Datc got evt 44 +>>> Connection encrypted <<< +smpSmExecute event=6 state=35 +smpSmExecute event=6 state=35 +smpSmExecute event=12 state=35 +Datc got evt 47 +Datc got evt 47 +smpSmExecute event=12 state=35 +smpSmExecute event=12 state=35 +smpSmExecute event=14 state=35 +connId=1 idleMask=0x0000 +Datc got evt 42 +>>> Pairing completed successfully <<< +dmDevPassEvtToDevPriv: event: 13, param: 1, advHandle: 0 +Datc got evt 58 +Datc got evt 63 +``` +Simple message passing to peer: +``` +btn 2 l +Long Button 2 Press +> Datc got evt 10 +Datc got evt 13 +hello back +``` +Secure message passing to peer: +``` +btn 2 m +Medium Button 2 Press +> Datc got evt 10 +Datc got evt 13 +>> Notification from secure data service <<< +Secure data received! + +``` + +On PHY change request: +``` +btn 1 x +XL Button 1 Press +2 MBit TX and RX PHY Requested +> Datc got evt 70 +DM_PHY_UPDATE_IND - RX: 2, TX: 2 +Datc got evt 65 +btn 1 x +XL Button 1 Press +LE Coded S2 TX and RX PHY Requested +> Datc got evt 70 +DM_PHY_UPDATE_IND - RX: 3, TX: 3 +Datc got evt 65 +btn 1 x +XL Button 1 Press +LE Coded S8 TX and RX PHY Requested +> Datc got evt 70 +DM_PHY_UPDATE_IND - RX: 3, TX: 3 +btn 1 x +XL Button 1 Press +1 MBit TX and RX PHY Requested +> Datc got evt 70 +DM_PHY_UPDATE_IND - RX: 1, TX: 1 +Datc got evt 65 +``` + +Data Transfer Speed test (1M PHY): +``` +btn 2 x +XL Button 2 Press +Starting speed test +... +flowDisabled=1 handle=0 +flowDisabled=0 handle=0 +9520000 bits transferred in 18823249 us +505757 bps +``` + +Data Transfer Speed test (2M PHY): +``` +btn 2 x +XL Button 2 Press +Starting speed test +... +flowDisabled=1 handle=0 +flowDisabled=0 handle=0 +9520000 bits transferred in 9413977 us +1011262 bps +``` + +### Commands +Type the desired command and parameter (if applicable) and press enter to execute the command. + +__help__ Displays the available commands. +__echo (on|off)__ Enables or disables the input echo. On by default. +__btn (ID) (s|m|l|x)__ Simulates button presses. Example: "btn 1 s" for a short button press on button 1. +__pin (ConnID) (Pin Code)__ Used to input the pairing pin code. + +## Push buttons +Push buttons can be used to interact with the application. + +__short__ : press is less than 200 ms +__medium__ : press is between 200 and 500 ms +__long__ : press is between 500 and 1000 ms +__extra long__ : press is greater than 1000 ms + +### When disconnected +1. Button 1 short: Start/Stop scanning +2. Button 1 medium: Cycle through the connection index (select connection) +3. Button 1 long: Clear all bonding info +4. Button 1 extra long: Add RPAO characteristic to GAP service -- needed only when DM Privacy enabled +5. Button 2 extra long: Enable device privacy -- start generating local RPAs every 15 minutes + +### When connected +1. Button 1 short: Start/Stop scanning +2. Button 1 medium: Cycle through connection index (select connection) +3. Button 1 long: Close selected connection +4. Button 2 short: Request PHY change (1M-2M-S2-S8) Only for BLE5 version. +5. Button 2 medium : Send secure message to peer +6. Button 2 long: Send short message to peer +7. Button 2 extra long: Start data transfer speed test + diff --git a/Libraries/Cordio/docs/Applications/BLE_otac_otas.md b/Libraries/Cordio/docs/Applications/BLE_otac_otas.md new file mode 100644 index 0000000000..5bcfcc07bb --- /dev/null +++ b/Libraries/Cordio/docs/Applications/BLE_otac_otas.md @@ -0,0 +1 @@ +# BLE_otac_otas \ No newline at end of file diff --git a/Libraries/Cordio/docs/Applications/BLE_periph.md b/Libraries/Cordio/docs/Applications/BLE_periph.md new file mode 100644 index 0000000000..28c966c42b --- /dev/null +++ b/Libraries/Cordio/docs/Applications/BLE_periph.md @@ -0,0 +1,185 @@ +# BLE_periph + +This is the simplest application that should be used when getting started. It will advertise as "Periph" and accepts connection requests. + +## Board Setup + +Before building firmware you must select the correct value for BOARD in project.mk, e.g. "EvKit_V1". + +### LEDs + +The red LED will indicate that an error assertion has occurred. + +The green LED indicates CPU activity. When the LED is on, the CPU is active, when the LED +is off, the CPU is in sleep mode. + +### Required Connections +Connect a USB cable between the PC and the (USB/PWR - UART) connector. An anteanna or wired connection can be used if SMA is available on the board. + +### Trace Serial Port +When TRACE is enabled in the project.mk, the on-board USB-to-UART adapter can +be used to view the trace messages and interact with the application. Open a serial port terminal with +the following settings. + +Baud : 115200 +Char size : 8 +Parity : None +Stop bits : 1 +HW Flow Control : No +SW Flow Control : No + +### Expected Output + +On startup: +``` +terminal: init +PeriphHandlerInit +Calculating database hash +Periph got evt 119 +Periph got evt 32 +>>> Reset complete <<< +dmAdvActConfig: state: 0 +dmAdvActSetData: state: 0 +dmAdvActStart: state: 0 +HCI_LE_ADV_ENABLE_CMD_CMPL_CBACK_EVT: state: 3 +dmDevPassEvtToDevPriv: event: 12, param: 33, advHandle: 0 +Periph got evt 33 +>>> Advertising started <<< + +``` + +When a connection has been made. +``` +dmConnIdByBdAddr not found +dmConnCcbAlloc 1 +dmConnSmExecute event=28 state=0 +dmAdvConnected: state: 1 +dmDevPassEvtToDevPriv: event: 13, param: 34, advHandle: 0 +AttsCccInitTable connId=1 +smpDbGetRecord: connId: 1 type: 1 +smpDbAddDevice +SmpDbGetFailureCount: connId: 1 count: 0 +smpDbGetRecord: connId: 1 type: 1 +smpDbAddDevice +SmpDbGetPairingDisabledTime: connId: 1 period: 0 attemptMult: 0 +Periph got evt 39 +>>> Connection opened <<< +Periph got evt 65 +Periph got evt 87 +attsProcMtuReq features 0x00 +hciCoreTxAclStart len=7 +Periph got evt 22 +connId=1 idleMask=0x0004 +hciCoreTxAclStart len=18 +connId=1 idleMask=0x0004 +hciCoreTxAclStart len=26 +hciCoreTxAclStart len=34 +connId=1 idleMask=0x0004 +hciCoreTxAclStart len=34 +attsCccMainCback connId=1 handle=19 +hciCoreTxAclStart len=5 +hciCoreTxAclStart len=27 +hciCoreTxAclStart len=9 +connId=1 idleMask=0x0004 +hciCoreTxAclStart len=10 +connId=1 idleMask=0x0004 +hciCoreTxAclStart len=9 +attsCccMainCback connId=1 handle=515 +hciCoreTxAclStart len=7 +hciCoreTxAclStart len=14 +``` + +### Commands +Type the desired command and parameter (if applicable) and press enter to execute the command. + +__help__ Displays the available commands. +__echo (on|off)__ Enables or disables the input echo. On by default. +__btn (ID) (s|m|l|x)__ Simulates button presses. Example: "btn 1 s" for a short button press on button 1. +__pin (ConnID) (Pin Code)__ Used to input the pairing pin code. + +### Push buttons +Push buttons are not implemented in this example. + +## Stack Initialization + +## GAP Peripheral / Slave Role + +### Advertising interval +The advertising interval is configurable in this structure. We can define multiple interverals, each with their own duration. In this case we will advertise at a short interval (96\*0.625ms = 60ms) for 30 seconds. We will then transition to a long interval (1600\*0.625 ms = 1000 ms) indefinetly. Longer advertising intervals will conserve power, but increase the latency when communicating with scanning devices or creating connections. + +```c +/*! configurable parameters for advertising */ +static const appAdvCfg_t periphAdvCfg = { + { 30000, 0, 0 }, /*! Advertising durations in ms, 0 corresponds to infinite */ + { 96, 1600, 0 } /*! Advertising intervals in 0.625 ms units */ +}; +``` + +Applications can also set a definite advertising duration with will cause the device to stop advertising at the end of the duation. The application can restart advertising by calling AppAdvStart(). + +### Advertising data + +Applications can define the advertising data with this structure. This information will be broadcast in every advertising event. Each portion of the advertising data is defined by a length byte, a type byte, and the data. In this case we're advertising the flags that the device is discoverable and BR/EDR (Bluetooth Classic) is not supported. We're also advertising the device name "Periph". + +```c +/*! advertising data, discoverable mode */ +static const uint8_t periphAdvDataDisc[] = { + /*! flags */ + 2, /*! length */ + DM_ADV_TYPE_FLAGS, /*! AD type */ + DM_FLAG_LE_GENERAL_DISC | /*! flags */ + DM_FLAG_LE_BREDR_NOT_SUP, + /*! device name */ + 7, /*! length */ + DM_ADV_TYPE_LOCAL_NAME, /*! AD type */ + 'P', 'e', 'r', 'i', 'p', 'h' +}; +``` + +## GATT Server + +## MTU size and Throughput + +Each layer of the stack has parameters that will bottleneck the throughput of the system. The ATT layer defines a Maximum Transmission Unit (MTU) to indiate the maximum length of an ATT packet. + +``` c +/*! ATT configurable parameters (increase MTU) + * ATT_MAX_TRANS_TIMEOUT = 30 seconds + */ +static const attCfg_t periphAttCfg = { + 15, /* ATT server service discovery connection idle timeout in seconds */ + 241, /* desired ATT MTU */ + ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */ + 4 /* number of queued prepare writes supported by server */ +}; +``` + +This MaxRxAclLen defines the maximum reassembled RX Asynchronous Connection-Orientated Logical(ACL) packet length. Packets received at the HCI layer must be buffered until the entire ACL packet has been received. Once the entire ACL packet has been received, the HCI layer will send the packet to the L2CAP layer. +```c +/*************************************************************************************************/ +/*! + * \brief Set the maximum reassembled RX ACL packet length. Minimum value is 27. + * + * \param len ACL packet length. + * + * \return None. + */ +/*************************************************************************************************/ +void HciSetMaxRxAclLen(uint16_t len); +``` + +The MTU must be less than or equal to the MaxRxAclLen - L2C Header Length (4 bytes). +``` c + /* if configured MTU size is larger than maximum RX PDU length */ + if (pAttCfg->mtu > (HciGetMaxRxAclLen() - L2C_HDR_LEN)) + { + /* notify app about MTU misconfiguration */ + attExecCallback(0, DM_ERROR_IND, 0, DM_ERR_ATT_RX_PDU_LEN_EXCEEDED, 0); + } +``` + +## Callbacks + +## Adding WSF events and handlers + + diff --git a/Libraries/Cordio/docs/Applications/RF_Test.md b/Libraries/Cordio/docs/Applications/RF_Test.md new file mode 100644 index 0000000000..89ab9fd495 --- /dev/null +++ b/Libraries/Cordio/docs/Applications/RF_Test.md @@ -0,0 +1 @@ +# RF_Test \ No newline at end of file diff --git a/Libraries/Cordio/docs/BLUETOOTH_LE_BASICS.md b/Libraries/Cordio/docs/BLUETOOTH_LE_BASICS.md new file mode 100644 index 0000000000..45a8319987 --- /dev/null +++ b/Libraries/Cordio/docs/BLUETOOTH_LE_BASICS.md @@ -0,0 +1,43 @@ +# Bluetooth LE Basics + +## References +The Bluetooth Special Interest Group (SIG) has documentation available on their [website](https://www.bluetooth.com/). Refer to the [documentation](https://www.bluetooth.com/specifications/specs/) page to see the latest core specification. This will be your best resource for learning the details of Bluetooth Low Energy. + +These books are also excellent references for developers. + +* *Getting Started with Bluetooth Low Energy* by O'Reilly +* *Bluetooth Low Energy: The Developer's Handbook* by Robin Heydon + +## Architecture +The Bluetooth stack closely resembles the layers of the network stack. We have the application layer at the top and the physical layer at the bottom. Each layer encapsulates the data and passes it to the appropriate section of the upper and lower layers. + +![Stack](res/Stack.PNG) + +The Host Conroller Interface (HCI) is the common point where devices are split. Typically this this interface is over an asynchronous protocol such as UART. Some devices will define proprietary interfaces between the application and host layers. Multi-core SOCs can also use the HCI or proprietay interfaces to split the stack between multiple CPUs. + + +When testing the Controller layers, test equipment will have a USB interface and act as a Host device. Devices under test will use a USB to UART adapter and act as Controller devices. + +![HCI](res/HCI.PNG) + +## States +These are the common states used in Bluetooth LE communication. Typically devices will be in only one of these states at a time, but it is possible for devices to be in all simultaneously. + +### Advertising +Devices in this state are broadcasting advertisement packets to scanning/initiating devices. This is an asychronous operation that has no synchronization with peer devices. Advertising devices are transmitting without any previous knowledge of peer devices. Advertising and scanning operations are done on channels 37, 38, and 39. The interval between advertising events is configurable between 20 ms and 10.24 s. + +![ADV Scan](res/ADV_SCN.png) + +### Scanning / Initiating +Devices in the scanning state listen for advertising devcies and can send scan optionally requests for additional information. The scanning interval and window settings are configurable. + +If a devices is scanning with the intent of connecting to a specific device, that is called the initiating state. The initiating devcies will send a connection indication to the desired advertising device to indicate it's desire to create a connection. + +### Connected +Once a initiating devices sends the connection requset and the advertising devices accepts the connection request, the two devices enter the connected state. This is a point to point connection allowing devcies to directly exchange information. + +In order to minimize interference, devices in the connected state will hop between channels 0-36 in a pseudo random order. The channel hopping information is communicated in the connection indication. + +Each connection event is separated by the connection interval. This interval is configurable from 7.5 ms to 4 s. The master will always transmit first and receive second. The Slave will always receive first and transmit second. Devices will typically always send and receive at least one packet in each interval, and they can optionally transmit and receive multiple packets in each interval. + +![Connected](res/Connected.png) \ No newline at end of file diff --git a/Libraries/Cordio/LICENSE.md b/Libraries/Cordio/docs/LICENSE.md similarity index 100% rename from Libraries/Cordio/LICENSE.md rename to Libraries/Cordio/docs/LICENSE.md diff --git a/Libraries/Cordio/docs/PACKETCRAFT.md b/Libraries/Cordio/docs/PACKETCRAFT.md new file mode 100644 index 0000000000..049a60e5b7 --- /dev/null +++ b/Libraries/Cordio/docs/PACKETCRAFT.md @@ -0,0 +1,127 @@ +Packetcraft Protocol Software +============================= + +Packetcraft protocol software is a collection of embedded stacks implementing the Bluetooth Low Energy Link Layer, Host, Profile and Mesh specification (www.bluetooth.org). + +This repository contains open source release of Packetcraft's software. This is a qualified release and may be used in products. Please consult the [Bluetooth Qualification Process](https://www.bluetooth.com/develop-with-bluetooth/qualification-listing) for further details regarding additional certification requirements. + + +Release notes +------------- + +This latest release of the Packetcraft Host and Packetcraft Controller is Bluetooth 5.2 qualified and implements the following new Bluetooth 5.2 features: LE Isochronous Channels, Enhanced Attribute Protocol, and LE Power Control. + +This release includes the following completed requirements for r20.05: + + FW-3340 Isochronous Demo: single BIS data stream + FW-3354 TCRL.2019-1 compliant + FW-3359 Core v5.2: LE Isochronous Channels (ISO) + FW-3360 Core v5.2: LE Power Control + FW-3361 Core v5.2: Enhanced ATT (EATT) + FW-3617 Core v5.2: Isochronous Abstraction Layer (ISOAL) + FW-3726 Core v5.2: Host Support for LE Isochronous Channels (ISO) + FW-3727 Nordic nRF5 SDK 16.0.0 + FW-3730 Compile BLE host for 64-bit platform + FW-3736 Light CTL Model + FW-3738 Mesh v1.0.1 compliant + FW-3739 TCRL.2019-2 qualification + FW-3750 Laird BL654 platform + FW-3767 SBC codec + FW-3803 GCC compiler support for gcc-arm-none-eabi-9-2019-q4-major + FW-3820 Protect against SweynTooth vulnerability + + +Getting Started +--------------- + +**1. Toolchain** + +If using a system with package manager such as Ubuntu, use the following command line to install dependent tools: + +``` +sudo apt-get install build-essential binutils-arm-none-eabi +``` + +Alternatively download and install the GNU Arm Embedded Toolchain from here and add the path to the `bin` folder to your PATH environment. + +* [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm) + + +**2. Build** + +Select a project to build. The following folders contains buildable projects: + +* Packetcraft Profile sample application: [ble-apps/build](../ble-apps/build) +* Packetcraft Mesh sample application: [ble-mesh-apps/build](../ble-mesh-apps/build) +* Packetcraft Controller sample application: [controller/build](../controller/build) + +Consult the Sample App Developer's Guide (below) for more information about the application usage. + +For example, to build Packetcraft's sample Bluetooth Low Energy Tag device use the following make command from the root repo folder: + +``` +make -C ble-apps/build/tag/gcc +``` + +This command will build a complete device image including the Tag sample application, Profiles, Host, Link Layer and platform drivers for the Nordic nRF52840 / PCA10056 development board. The resulting image is located at `ble-apps/build/tag/gcc/bin/tag.bin`. + + +**3. Program** + +To install the firmware image on a Nordic PCA10056 developmnent board, plug a USB cable into your PCA10056. Drag-n-Drop the resulting image from the previous step onto the mass storage drive called "JLINK". + + +Documentation +------------- + +See the docs directory. + + +Certification +------------- + +Bluetooth LE Mesh solution implementing of the Bluetooth Mesh Profile 1.0 and the Bluetooth Mesh Model 1.0 wireless technical specifications + +* [QDID 116593](https://launchstudio.bluetooth.com/ListingDetails/66212) + +Bluetooth LE Host protocol stack implementing Bluetooth Core 5.2 specification + +* [QDID 146344](https://launchstudio.bluetooth.com/ListingDetails/103670) + +Bluetooth LE Link Layer protocol stack implementing Bluetooth 5.2 specification + +* [QDID 146281](https://launchstudio.bluetooth.com/ListingDetails/103599) + + +Verification +------------ + +Packetcraft Mesh is verified with the TCRL.2019-2 compliance tester using the following: + +* Bluetooth Profile Tuning Suites 7.6.1 + +Packetcraft Host is verified with the TCRL.2019-2 compliance tester using the following: + +* Bluetooth Profile Tuning Suites 7.6.1 + +Packetcraft Profiles is verified with the TCRL.2018-2 compliance tester using the following: + +* Bluetooth Profile Tuning Suites 7.3.0 + +Packetcraft Link Layer conforms to the Bluetooth TCRL.2019-2 requirements verified with the following: + +* Teledyne Harmony LE Tester version 19.12.16916.21195 + +This product was compiled and tested with the following version of GNU GCC + +* gcc-arm-none-eabi-9-2019-q4-major + + +Platforms +--------- + +This release was tested on the following platforms. Note: platforms listed may not be available in this repository. + +* Nordic nRF52840 / PCA10056 development kit / Nordic nRF5 SDK 16.0.0 (make configuration: "PLATFORM=nordic BOARD=PCA10056") +* Nordic nRF52832 / PCA10040 development kit / Nordic nRF5 SDK 16.0.0 (make configuration: "PLATFORM=nordic BOARD=PCA10040") +* Laird BL654 / 451-00004 USB adapter / Nordic nRF5 SDK 16.0.0 (make configuration: "PLATFORM=laird") diff --git a/Libraries/Cordio/docs/cordio_platform_doxyfile b/Libraries/Cordio/docs/cordio_platform_doxyfile new file mode 100644 index 0000000000..252ee6e117 --- /dev/null +++ b/Libraries/Cordio/docs/cordio_platform_doxyfile @@ -0,0 +1,2588 @@ +# Doxyfile 1.8.17 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Cordio Platform Documentation" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Cordio Platform Documentation (All interfaces)" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../platform/include/pal_btn.h \ + ../platform/include/pal_cfg.h \ + ../platform/include/pal_sys.h \ + ../platform/include/pal_crypto.h \ + ../platform/include/pal_bb_ble.h \ + ../platform/include/pal_timer.h \ + ../platform/include/pal_led.h \ + ../platform/include/pal_rtc.h \ + ../platform/include/pal_bb.h \ + ../platform/include/pal_uart.h + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.doc \ + *.txt \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /