The MediBox Embedded Software Project aims to develop a smart pharmaceutical storage system capable of managing medicines effectively. This documentation outlines the design, implementation, and functionalities of the embedded software that controls the MediBox hardware components.
The MediBox system consists of hardware components including an OLED screen, buzzer, push buttons, Light Dependent Resistors (LDRs), and a servo motor. The software components include embedded software for hardware control, NTP client for time synchronization, alarm management system, temperature/humidity monitoring, light intensity monitoring, and a user interface for configuration and interaction.
The software provides the following functionalities:
- Set time zone and synchronize time with NTP server.
- Set and manage alarms, including disabling all alarms.
- Display current time on the OLED screen.
- Ring alarms with proper indication when triggered, stop alarms using push buttons.
- Monitor temperature and humidity levels, provide warnings if exceeded healthy limits.
- Monitor light intensity using LDRs, display real-time and historical data on Node-RED dashboard.
- Adjust shaded sliding window position using servo motor based on light intensity and user-defined parameters for different medicines.
The software provides the following advanced functionalities:
- Persist alarms and user settings in non-volatile memory.
- User Friendly OLED screen interface for configuration and interaction.
- Advaced power management system to reduce power consumption.
- On Change Detection for sensors to reduce power consumption.
- Continous monitoring of temperature, humidity and light intensity.
The MediBox software utilizes a modular architecture, dividing the system into distinct components to ensure efficient management of functionalities
- Hardware Abstraction Layer
- Provides a simplified interface for interacting with hardware components like the OLED display, buzzer, buttons, LDR sensors, and servo motor.
- Abstracts hardware-specific details, allowing for easier software development and potential adaptation to different hardware configurations.
- Sensor Management
- Handles data acquisition from the DHT sensor (temperature and humidity) and LDRs (light intensity).
- Processes and stores the collected sensor data, enabling environmental monitoring and data visualization on the Node-RED dashboard.
- Alarm Management
- Enables users to set, disable, and manage medication alarms.
- Activates the buzzer and displays a notification on the OLED screen when an alarm is triggered, reminding users to take their medication.
- Stores alarm configurations in non-volatile memory, ensuring persistence across power cycles.
- Time Management
- Synchronizes the system time with an NTP server, ensuring accurate timekeeping.
- Allows users to configure a custom time zone offset from UTC, tailoring the system to their location.
- Saves the time zone offset in non-volatile memory for persistent operation.
- User Interface
- Provides a menu-driven interface on the OLED display, enabling users to navigate through different functionalities using the push buttons.
- Allows for configuring alarms, setting time zones, and viewing system status information.
- Displays warning messages when temperature or humidity levels exceed predefined thresholds.
- Communication Management
- Establishes a secure connection with an MQTT broker for remote data transmission and control.
- Publishes sensor data (temperature, humidity, light intensity) to designated topics on the MQTT broker for visualization and analysis on the Node-RED dashboard.
- Subscribes to a specific topic to receive control commands for the servo motor from the MQTT broker, enabling remote adjustments to the shaded sliding window.
This modular architecture ensures clear separation of concerns, enhances maintainability, and allows for future expansion of functionalities and integration of additional components.
Tip
Full Documentation about Softaware Architecture can be found here
These hardware components are essential for the proper functioning of the MediBox system. The hardware components of the MediBox system play a crucial role in its proper functioning. These components include:
-
ESP32 Development Board: This board serves as the main controller for the system, providing the necessary processing power and connectivity options.
-
OLED Display: The OLED display is used to provide visual feedback to the user, showing information such as the current time, alarm notifications, and system status.
-
Buzzer: The buzzer is responsible for generating audible alarms when medication reminders are triggered, ensuring that users are alerted to take their medication.
-
Push Buttons: The push buttons allow users to interact with the system, enabling them to navigate through menus, set alarms, and acknowledge notifications.
-
Light Dependent Resistors (LDRs): LDRs are used to monitor the ambient light intensity. This information is used to adjust the position of the shaded sliding window, ensuring that medications are stored in optimal conditions.
-
Servo Motor: The servo motor controls the movement of the shaded sliding window based on the input from the LDRs and user-defined parameters.
Tip
Full Documentation about Hardware Components can be found here.
Warning
Hardware component change will be affect for the change in configuations
-
Hardware Components
-
Software Components
-
Hardware Installation
- Connect the components as given in the Port Map
-
Software Installation
-
Clone this repository
git clone https://github.com/yasanthaniroshan/Medibox.git
-
Setup platform.io plugin for VSCode
-
Install Node-RED as given in the official documentation
-
Import the Node-RED flow from the Node-RED Flow
-
-
Run the Project
- Open the project in VSCode and Create Certificate.h to include your CA certificate as
const char *root_ca = R"EOF(...)EOF"; - Build the project using the platform.io plugin.
- Upload the firmware to the ESP32 development board.
- Run the Node-RED server using the command
node-redin the terminal. - Open the Node-RED dashboard in the browser using the URL
http://localhost:1880/ui.
- Open the project in VSCode and Create Certificate.h to include your CA certificate as
- First you have to setup Workwi simulator for the project. The setup guide can be found here and the simulation can be found here
This project was developed as the Semester 4 Project in the Module EN2853 - Embedded Systems & Applications ENTC, UoM.