Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/freertos/coremqtt-agent-demos
Demonstrates use of coreMQTT-Agent for simple MQTT connection sharing among different threads of execution.
https://github.com/freertos/coremqtt-agent-demos
freertos iot mqtt
Last synced: about 2 months ago
JSON representation
Demonstrates use of coreMQTT-Agent for simple MQTT connection sharing among different threads of execution.
- Host: GitHub
- URL: https://github.com/freertos/coremqtt-agent-demos
- Owner: FreeRTOS
- License: mit
- Created: 2020-11-24T21:32:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-05-12T04:58:43.000Z (over 1 year ago)
- Last Synced: 2023-05-12T05:25:22.378Z (over 1 year ago)
- Topics: freertos, iot, mqtt
- Language: C
- Homepage: https://freertos.org/mqtt/mqtt-agent-demo.html
- Size: 866 KB
- Stars: 28
- Watchers: 19
- Forks: 26
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## coreMQTT Agent and Demo Tasks (including OTA)
This repository demonstrates examples of using AWS IoT Device Shadow, Device Defender, and OTA from multiple threads. It uses FreeRTOS and the [coreMQTT Agent library](https://github.com/FreeRTOS/coreMQTT-Agent), an extension on top of [coreMQTT](https://github.com/FreeRTOS/coreMQTT) that provides MQTT APIs with thread safety. The examples here share a single MQTT connection amongst multiple concurrent tasks, without requiring the management of any synchronization primitives from the application.
## Cloning this repository
This repo uses [Git Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to bring in dependent components.
**Note:** If you download the ZIP file provided by the GitHub UI, you will not get the contents of the submodules. (The ZIP file is also not a valid git repository)
To clone using HTTPS:
```
git clone https://github.com/FreeRTOS/coreMQTT-Agent-Demos.git --recurse-submodules
```
Using SSH:
```
git clone [email protected]:FreeRTOS/coreMQTT-Agent-Demos.git --recurse-submodules
```
If you have downloaded the repo without using the `--recurse-submodules` argument, you need to run:
```
git submodule update --init --recursive
```
## Getting started
The [documentation page](https://freertos.org/mqtt/mqtt-agent-demo.html) for this repository contains information on the MQTT agent and the contained demo project. There is also a [supplemental documentation page](https://freertos.org/ota/ota-mqtt-agent-demo.html) that describes how to run an Over-the-Air (OTA) update agent as one of the RTOS tasks that share the same MQTT connection.
## Building Demos
This repository contains both a Visual Studio project that uses the FreeRTOS Windows port and can be built using the free [Community version of Visual Studio](https://visualstudio.microsoft.com/vs/community/), and a GCC/makefile project that build the FreeRTOS ARM Cortex-M3 port and targets the [QEMU hardware emulator](https://www.qemu.org/). The makefile can be built from the command line or the provided Eclipse project, and works on both Windows and Linux hosts.
### Visual Studio
1. Ensure to follow the instructions on the above linked demo documentation page to configure the build as required to access your network.
1. From the Visual Studio IDE, open the `mqtt_multitask_demo.sln` Visual Studio solution file in the `build/VisualStudio/` directory.
1. Select **Build Solution** from the IDE's **Build** menu.
### QEMU Cortex-M3
**Command Line**
1. Ensure that `arm-none-eabi-gcc` from the [GNU ARM Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) and GNU `make` are in your path.
1. From the `build/Cortex-M3_MPS2_QEMU_GCC` directory, run `make`.
**Eclipse IDE**
1. Ensure that `arm-none-eabi-gcc` from the [GNU ARM Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) and GNU `make` are in your path.
1. Open the `build/Cortex-M3_MPS2_QEMU_GCC` directory as an Eclipse project.
1. Select `Project -> Build Project` from the Eclipse menu.
In both cases, the generated executable can be found at `build/Cortex-M3_MPS2_QEMU_GCC/output/RTOSDemo.elf`.
**Running the Makefile build in QEMU**
Use the QEMU command contained in the [start_qemu.bat](build/Cortex-M3_MPS2_QEMU_GCC/start_qemu.bat) batch file to run the generated `RTOSDemo.elf` file directly. Alternatively, use the command contained in the [start_qemu_and_wait.bat](build/Cortex-M3_MPS2_QEMU_GCC/start_qemu_and_wait.bat) batch file to start QEMU and wait for a GDB connection on port 1234. The Eclipse project contains a configuration suitable for debugging.
Note that these QEMU commands assume there is a network tap driver called "TAP0".
**Obtaining network access from QEMU on Windows**
1. Install the [OpenVPN TAP driver for Windows](https://openvpn.net/).
1. Name the installed TAP interface "TAP0". This can be done by selecting "Change adapter settings" from Windows' Network Properties window (Control Panel\Network and Internet\Network Connections) to view all network adapters, selecting the installed TAP adapter, and then pressing F2 to edit the adapter's name.
1. From the same window, configure a real wired network interface to have a static IP address that is within the range of IP addresses allocated by your local DHCP server.
1. Still in the same window, select both the real network adapter and the TAP adapter at the same, then right click, and select "Bridge Connections" from the pop up menu.
## Getting help
You can use your Github login to get support from both the FreeRTOS community and directly from the primary FreeRTOS developers on our [active support forum](https://forums.freertos.org). You can also find a list of frequently asked questions [here](https://www.freertos.org/FAQ.html).
## Security
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
## License
This library is licensed under the MIT License. See the [LICENSE](LICENSE.md) file.