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

Create flowchart for MQTT Task in sw_architecture.md #6

Open
patrickanguyen opened this issue Apr 19, 2022 · 0 comments
Open

Create flowchart for MQTT Task in sw_architecture.md #6

patrickanguyen opened this issue Apr 19, 2022 · 0 comments

Comments

@patrickanguyen
Copy link
Contributor

patrickanguyen commented Apr 19, 2022

Description

The flowchart for the MQTT Task should be documented in sw_architecture.md before development. Add a flowchart diagram using mermaid markdown. You can use this website to create the flowcharts, then copy them onto the markdown file.

The MQTT task is responsible for publishing the sensor data to the MQTT broker. The MQTT task will receive the sensor values from a thread-safe queue from the different tasks. The MQTT task will wait for the sensor data from the queue. If the data is not received in time, it will set the sensor value to an error code and continue.

This is some documentation about FreeRTOS queue to help conceptualize how queues work in practice.

Please outreach if you need any help with this issue. This is a bit more complicated than the rest of the tasks.

Requirements

  • Should include the initialization of sensor step
  • Include a scenario for sensors failing
  • Make sure the design is robust as possible
@patrickanguyen patrickanguyen changed the title Create flowchart for MQTT Task Create flowchart for MQTT Task in sw_architecture.md Apr 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant