Sprint 1 - rokanas/terminarium GitHub Wiki

The milestone can be found at the following link: Sprint #1 [internal].

Objective

Objective: Successfully Establish Sensor Connections, Read/Parse Raw Data, and Display Human-Readable Data on the Serial Monitor

The milestone to aimed to implement the functionality to read and parse raw data from the sensors. This involves retrieving the sensor data in its raw format and processing it to extract meaningful information. By employing appropriate parsing techniques, the project will ensure accurate and reliable data interpretation.

Moreover, Sprint #1 focuses on displaying the sensor data onto the serial monitor in a human-readable manner. This entails formatting and presenting the collected data in a clear and understandable format for users and developers monitoring the system. By achieving this objective, the project will enhance the accessibility and usability of the data, enabling effective monitoring of enclosure conditions.

By the end of Sprint #1, the project team aims to have established sensor connections, implemented reliable raw data reading and parsing mechanisms, and successfully displayed the sensor data in a human-readable format on the serial monitor.

List of requirements

The following section includes the list of requirements that were considered for Sprint #1. Moreover, for each, it is indicated whether it was completed or not.

During the initial phase of the project, the team has defined a set of "high-level" requirements, which were then refined and prioritized in order to define the goals for the first sprint. Such requirements are listed below, along with the corresponding user stories and/or features (i.e. GitLab issues) and the status of their completion (if no additional information is provided, the requirement is considered completed).

Note: for some features, a user story is not available, as it was not considered necessary; instead, a textual description is provided.

The system shall be able to measure the light intensity in the enclosure.
1. #1: Establish a connection between the Wio terminal and the light sensor.
2. #10: As a user, I want to access to light intensity data, so that I can monitor my terrarium.
3. #16: As a user, I want the light intensity levels displayed in the Wio Teminal, so that I can check the current status of the enclosure.
The system shall be able to measure the loudness / sound intensity in the enclosure.
1. #7: Establish a connection between the Wio terminal and the loudness sensor.
2. #12: As a user, I want access to loudness sensor data, so that I can monitor my terrarium.
3. #15: As a user, I want the loudness sensor data displayed in the Wio Teminal, so that I can check the current status of the enclosure.
4. #20: As a user, I want the loudness sensor data displayed in DBa units in the Wio Teminal, so that I can get a better idea of the sound level in the enclosure.
- This feature was not implemented, as it prove to pose excessive complexity in the implementation, and ultimately it was not considered necessary.
The system shall be able to measure the humidity in the enclosure. The system shall be able to measure the temperature in the enclosure.
- These two requirements were considered together, as only a single sensor is required to measure such parameters.
1. #2: Display a confirmation message in the Wio Terminal serial monitor once a connection between the terminal and the component sensor has been established.
2. #8: As a user, I want access to temperature and humidity data, so that I can monitor my terrarium.
3. #13: As a user, I want the temperature and humidity levels displayed in the Wio Teminal, so that I can check the current status of the enclosure.
The system shall be capable of detecting levels of vibrations in the enclosure.
- During the sprint, the team members have realized the infeasibility of this requirement, as the sensor that was considered for this purpose is not capable of detecting vibrations, but 2 states of motion (i.e. still and moving).
1. #5: Establish a connection between the Wio terminal and the vibration sensor.
2. #9: As a user, I want access to vibration data, so that I can monitor my terrarium.
3. #14: As a user, I want the vibration displayed in the Wio Teminal, so that I can check the current status of the enclosure.
The system shall be able to detect the moisture levels within the enclosure.
1. #1: Establish a connection between the Wio terminal and the moisture sensor.
2. #11: As a user, I want access to moisture data from my terrarium presented in a readable format, so that I can monitor the moisture levels.
3. #17: As a user, I want the moisture data displayed on the Wio terminals serial monitor so that I can check the current status of the enclosure.

Additionally, to ensure the concurrency of readings from the sensors, the following feature (via a user story) was considered:

#22: As an end-user of the Terminarium system, I require the functionality to view the parsed data of all sensors in a concurrent manner so that I can effectively monitor the enclosure's current status.

Timeline

There has been significant planning of the project carried before the official start of the sprint. However, the official timeline of the sprint is as follows:

Start date: 2023-04-10
End date: 2021-04-23

There are a total of 14 days in the sprint.

Risks

A summary of risks are challenges is outlined in detail in the Challenges subsection of the Sprint #1 section here.

Communication plan

Discord has been utilized as the primary communication channel for the project. The team has also utilized GitLab for version control and Clickup for task management and sprint planning.