diff --git a/README.md b/README.md new file mode 100644 index 0000000..d7960b2 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Tillandsia Usneoides + +This repository contains all the documentation for the Tillandsia Uneoides +plant watering assistant (_Tillun_ for brevity). + +| Item | Value | +|------|---------------------| +| Name | Tillandsia Uneoides | +| Code | TU-001 | + +Contents: + +- `Requirements`: contains details about the features and requirements. +- `Design`: contains the design of the device, environment and +- `Components documentation`: complementary documentation of the suggested + components. +- `Software`: the microcontroller's code and documentation. +- `Calibration and testing`: notes on the calibration and usage of the device + resulting from real-world experimentation. +- `User manual`: instructions on how to setup and use the device. \ No newline at end of file diff --git a/calibration_and_testing/exp01_sensor_calibration.md b/calibration_and_testing/exp01_sensor_calibration.md new file mode 100644 index 0000000..da5a495 --- /dev/null +++ b/calibration_and_testing/exp01_sensor_calibration.md @@ -0,0 +1,16 @@ +# Experiment 01 - Sensor Calibration + +- Purpose: to understand how the values provided by sensor XXX vary in + different humidity conditions. +- Components: + - Arduino Proto + - Sensor XXX +- Methodology + - Prepare the board and sensor to take measurements. + - Prepare production code and alternative code with raw values. + - Prepare 6 testing conditions: air, water, and three pots with different + humidity conditions (completely dry, XXXml watered, XXXml watered and + XXXml watered). + - Perform raw and production-grade measurements in each environment. +- Results +- Take-aways \ No newline at end of file diff --git a/components.md b/components.md new file mode 100644 index 0000000..749d9e2 --- /dev/null +++ b/components.md @@ -0,0 +1,10 @@ +# Components + + +- Arduino Nano + - Docs: https://docs.arduino.cc/static/782947f0c36a61610868512da7bcd83c/A000005-datasheet.pdf + - Buy: + - https://www.electroya.com/producto/arduino-nano-v3-ch340/ + - https://www.electrohobby.es/placas-arduino/388-nano-ch340g.html + - https://tienda.bricogeek.com/arduino/12-arduino-nano-8058333490342.html +- \ No newline at end of file diff --git a/components_documentation/arduino-nano-datasheet.pdf b/components_documentation/arduino-nano-datasheet.pdf new file mode 100644 index 0000000..fce7b8b Binary files /dev/null and b/components_documentation/arduino-nano-datasheet.pdf differ diff --git a/engineer_log.md b/engineer_log.md new file mode 100644 index 0000000..0b9a9b0 --- /dev/null +++ b/engineer_log.md @@ -0,0 +1,39 @@ +# Engineer Log + +## 20221023 + +Today I began designing Tillun. I think Ana would enjoy the name. If the thing +rolls, I'll gift her one. + +Today I have been researching what are my options for the processing unit. I +think the ESP32 should be the optimal one, but I'm a bit intimidated by jumping +into that architecture that fast. I've decided it's wiser to stick within the +Arduino environment for now for two reasons: because I believe this way I'll +experience a more reasonable learning curve and because I believe that an +Arduino microcontroller will be more versatile than an ESP32, and I expect to +be re-using a lot of components from my Tillun experiments for the next +generations. + +It seems the Arduino Nano is the right tool for the job. As far as I could +tell, there are just a few differences with the Megaboard I'm using. First, it +has less CPU power and memory, which shouldn't be a problem since the sketch +that will run this project will be ridicolously short. Second, it has less pins +and ports. Not a problem either, since I'll probably only need one or two for +the moisture sensor. + +The only problem I might face is that there doesn't seem to be a lot of stock +in the stores I have checked. Amazon has units, but I refuse to buy from them +unless they are literally the only option in town. + +I also looked a bit into the moisture sensors. I still haven't settled for any +specific one. It also left me wondering of well can one count on some of these +sensors being on the market for a long time. It's definetely a design challenge +if you can't count on that and future alternatives might not work exactly the +same way or require a different calibration procedure. + +## Open topics + +- How to measure how much power a circuit is consuming. +- How to measure how long a battery will last. +- How to measure how much charge is left in a battery. +- \ No newline at end of file diff --git a/requirements.md b/requirements.md new file mode 100644 index 0000000..56daf7c --- /dev/null +++ b/requirements.md @@ -0,0 +1,32 @@ +# Requirements + +Tillun is a little device which helps a gardener visually tell the hydration +level of his plant's pot. With this information, the gardener can decide if he +should water the plant or not, and also if he watered the plant enough. + +_Note: you could wonder: can't the gardener obtain the same information by +taking a look at the pot's soil or sticking his finger in it? Absolutely. This +project is just a fun, unnecessary endeavour executed in the most professional +way possible._ + +## User stories + +- As a gardener, I want to know how hydrated is my plant's soil. + +## Set-up acceptance criteria + +- The device doesn't need the gardener to configure any software, or to use any + laptop at all for any reason. +- The device operates with one or two 9V batteries. +- The device comes with a QR code linking to the minimal instructions for setup + and operation. +- Reading-time not accounted for, the device can be installed in under a + minute. + +## Operation acceptance criteria + +- Understanding whether the device is operating or not should be trivial and + doable without any sort of equipment. +- The device can run for at least 6-months without a battery change (assuming + the starting point is two fully loaded 9V batteries). +- \ No newline at end of file