Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added foldouts for use cases #4

Merged
merged 22 commits into from
Oct 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ pipx inject mkdocs mkdocs-material
mkdocs serve
```

Then open [docs](http://127.0.0.1:8000/OpenSmartMeter/) in a local web browser.
Then open [docs](http://127.0.0.1:8000/AirLink-Docs/) in a local web browser.

## Writing documentation

Expand Down
274 changes: 102 additions & 172 deletions docs/AirLink App.md

Large diffs are not rendered by default.

Binary file removed docs/AirLink App/1._Devices_view.jpg
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/AirLink App/2.5_TYPE_SERIAL_NUMBER.jpg
Binary file not shown.
Binary file not shown.
Binary file removed docs/AirLink App/2.7_ENTER_PAYG_TOKEN.jpg
Binary file not shown.
Binary file not shown.
Binary file removed docs/AirLink App/2.9_SYNC_-_Syncing_data.jpg
Binary file not shown.
Binary file removed docs/AirLink App/2._Resources_view.jpg
Binary file not shown.
Binary file not shown.
Binary file removed docs/AirLink App/3._Profile_view.jpg
Binary file not shown.
Binary file added docs/AirLink App/AirLink_BLE_Simulator.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/AirLink App/AirLink_Data_Flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/AirLink App/MVVMPattern.png
Binary file not shown.

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/AirLink App/home - device list page.jpg
Binary file added docs/AirLink App/home - payg token page.jpg
376 changes: 151 additions & 225 deletions docs/AirLink Devices.md

Large diffs are not rendered by default.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

13 changes: 13 additions & 0 deletions docs/AirLink Devices/Range Testing Results.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Range Testing Results

Range testing was done with a Laird BL652 (nRF51832) chip in advertisement mode being scanned from an Android phone.

Coverage around concrete house
![Coverage around concrete house](Range%20Testing%20Results/768DFA45-AB63-408E-B84A-8A7F18BEFE90.jpeg)

Coverage through concrete walls

![Coverage through concrete walls](Range%20Testing%20Results/0CAA08AD-79CD-42BD-ADC3-AA65A3272E82.jpeg)

Line of sight range
![Line of sight range](Range%20Testing%20Results/20210614_085821_mfnr.jpg)
Diff not rendered.
20 changes: 0 additions & 20 deletions docs/AirLink Devices/bluetooth-logo-color-black.svg
Diff not rendered.
Binary file added docs/AirLink Devices/bluetooth-logo.png
Loading