Skip to content

Commit

Permalink
docs: enhance project descriptions and add naming reasoning for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
sayanee committed Nov 13, 2024
1 parent 65edb25 commit 1c2eb3b
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions _data/projects.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# - name: Basil
# sequence: 6
# url: /basil
# description: 🌿 Indoor UV, air quality, and environmental sensor 🏠
# reasoning: Because basil thrives in bright, clean air and is a symbol of freshness!
# wireless: WiFi
# mcu: ESP32-C3
# sensor: air quality
# power: LiPo
# status: future
# started: 2025

- name: Capsicum
sequence: 5
url: /capsicum
description: πŸ«‘ Retrofit a wired doorbell to add WiFi and make it connected πŸ””
description: πŸ«‘ A retrofitted wired audio doorbell with added WiFi connectivity πŸ””
reasoning: Named after the bell pepper, also known as capsicum, for its playful nod to the 'bell' in doorbell.
wireless: WiFi
mcu: ESP32-C3
sensor: bell
Expand All @@ -12,7 +25,8 @@
- name: Oak
sequence: 4
url: /oak
description: 🌳 Outdoor LoRa-GPS tracker with E-Ink display πŸ”‘
description: 🌳 An outdoor LoRa-GPS tracker with an E-Ink display πŸ”‘
reasoning: Reflecting the strength and dependability of the mighty oak, ideal for a robust outdoor tracking device.
wireless: LoRa
mcu: SAMD21G18
sensor: GPS
Expand All @@ -27,7 +41,8 @@
- name: Pine
sequence: 3
url: /pine
description: 🌲 Indoor Infrared receiver and transmitter with temperature sensor 🎐
description: 🌲 An indoor infrared receiver and transmitter with a temperature sensor 🎐
reasoning: Inspired by the resilient pine tree, which stays evergreen and adaptable, even as seasons and temperatures shift.
wireless: Infrared
mcu: SAMD21G18
sensor: Temperature
Expand All @@ -41,7 +56,8 @@
- name: Palm
sequence: 2
url: /palm
description: 🌴 Outdoor BLE-connected UV sensor keychain πŸ—
description: 🌴 A BLE-connected outdoor UV sensor keychain πŸ—
reasoning: Named for the palm tree, a classic symbol of sunshine and the outdoors, making it perfect for a UV-focused device.
wireless: BLE
mcu: nRF52
sensor: UV Index
Expand All @@ -56,7 +72,8 @@
- name: Cactus
sequence: 1
url: /cactus
description: 🌡 Indoor WiFi-connected temperature and humidity sensor 🍢
description: 🌡 An indoor WiFi-connected temperature and humidity sensor 🍢
reasoning: Named after the cactus, a plant known for thriving in extreme climates while conserving moistureβ€”perfect for a device monitoring environmental conditions indoors.
wireless: WiFi
mcu: ESP8266
sensor: Humidity
Expand Down

0 comments on commit 1c2eb3b

Please sign in to comment.