The existing set of documentation for the two examples, found here and here, only offer steps on how to build and run the demo along with some pre-requisites and a simple explanation of the demo. They fail to mention the caveats of building or running the examples on different platforms, and are, in some cases, out of date. For example, demoing on a macOS requires the user to enable Bluetooth access for their preferred terminal emulator; else, the python client script abruptly fails.
Thus, the goal as a result is to update the documentation to serve as a friendly guide for end-users looking to gain their first experience in working with FOTA over BLE on MbedOS. The steps involved in achieving said goal are listed in the requirements section below.
Note: Rather than using a GitHub Wiki, example-specific markdown files are to be used. This decision is a result of the complexities associated with issuing pull requests for wikis as mentioned in this Stack Overflow post. Possibly, in the future, the documentation would be migrated into a GitHub Wiki when the upstream repository sets one up.
Requirements:
[x] Update README.md to serve as an introduction to the examples and the FOTA Service
[x] Add known platform-specific caveats associated in the build process
[x] Add instructions on how to use the build automation python program - #1
[x] Add steps on running the example demos and known issues (i.e. points of failure or troubleshooting)
The existing set of documentation for the two examples, found here and here, only offer steps on how to build and run the demo along with some pre-requisites and a simple explanation of the demo. They fail to mention the caveats of building or running the examples on different platforms, and are, in some cases, out of date. For example, demoing on a macOS requires the user to enable Bluetooth access for their preferred terminal emulator; else, the python client script abruptly fails.
Thus, the goal as a result is to update the documentation to serve as a friendly guide for end-users looking to gain their first experience in working with FOTA over BLE on MbedOS. The steps involved in achieving said goal are listed in the requirements section below.
Requirements:
README.mdto serve as an introduction to the examples and the FOTA ServiceAssociated branch:
documentation