Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kwee-Veen committed Sep 22, 2024
1 parent 211608c commit c7d928d
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
SnackTrap is an IoT solution aimed at catching housemates who are trying to steal food from your cupboards.

![SnackTrap2](https://github.com/user-attachments/assets/2d1bff5f-3b1d-4bf6-b699-4fdbcb2fed14)

It incorporates a Raspberry Pi 4 installed with a SenseHAT's light sensor and LED array.
The device employs the Blynk IoT platform to interface with sensor data and record a history of device events.
Alarm data is also sent to the Firebase cloud database in JSON format
Expand All @@ -15,6 +17,8 @@ The device uses the SenseHAT pixel array to visually illustrate when the device
- Being armed
- Being disarmed

![SnackTrap](https://github.com/Kwee-Veen/SnackTrap/assets/118535981/247a2dc6-28d4-4078-ab6d-c8d366b7e2c6)

To use the device, arm the device using either the joystick-press sequence or the Blynk smartphone app.
The device will then respond if light levels are raised above a low threshold (5/255).
While inside a dark area, such as the inside of a cupboard being monitored, the alarm will not be triggered.
Expand All @@ -29,5 +33,3 @@ The device's events, including device alarm, armed and disarmed state changes, a
These events are triggered by HTTP requests sent from the device to the Blynk platform upon state changes.
Reviewing the device's Timeline provides a full history of events, with alarms emphasised as Warning events.
An additional copy of JSON data highlight the time of the event is sent to Firebase, serving as a backup of events and facilitating further data processing available if desired.

![SnackTrap](https://github.com/Kwee-Veen/SnackTrap/assets/118535981/247a2dc6-28d4-4078-ab6d-c8d366b7e2c6)

0 comments on commit c7d928d

Please sign in to comment.