Skip to content

Commit

Permalink
Update make-a-plant-watering-robot.md
Browse files Browse the repository at this point in the history 
took out the test part
  • Loading branch information
@mestcihazal
mestcihazal authored Dec 18, 2023
1 parent 00264ef commit f18e040
Showing 1 changed file with 19 additions and 79 deletions.
98 changes: 19 additions & 79 deletions docs/tutorials/projects/make-a-plant-watering-robot.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Make sure your Pi is flashed with a Viam-compatible operating system, and that y
## Set up your plant watering robot

Before programming the Pi to make the plant watering robot functional, you need to physically set up the plant watering robot by wiring the different components together.
You will set up the robot to receive signals from the resistive soil moisture sensor and signal to the peristaltic pump when it is time to pump water from the water's container to the plant's container.
You will set up the robot to receive signals from the resistive soil moisture sensor and signal to the peristaltic pump when it is time to pump water from the water container to the plant's container.

### Full wiring diagram

Expand Down Expand Up @@ -140,7 +140,7 @@ You can either bend or soldier the jumper wire here to make the connection betwe

{{% /alert %}}

## Program your plant watering robot
## Get ready to program your plant watering robot

{{<gif webm_src="/tutorials/plant-watering-pi/plant-watering-video.webm" mp4_src="/tutorials/plant-watering-pi/plant-watering-video.mp4" alt="The plant watering robot on a white desk. Camera goes up to the watering tube and pulls it out, showing the drip.">}}

Expand Down Expand Up @@ -170,17 +170,22 @@ Now, select **Yes** to enable SPI:
Finally, select **Finish**.
Restart your Pi using `sudo reboot` to make these changes take effect.

### Test your soil moisture readings on your Pi
### Install the Python SDK

Next, install the Adafruit ADC library [`Adafruit_CircuitPython_MCP3xxx`](https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx/) on your Pi.
Next, set up a virtual environment and install the SDK. (If you want to read more on virtual environments, check out [the documentation](https://docs.viam.com/build/program/python-venv/).)

Before installation, make sure any packages on your Pi are up to date:
Make sure any packages on your Pi are up to date, while connected to your Pi with SSH run:

```shell
sudo apt update
sudo apt upgrade
```

Then run the following command to create and activate the virtual environment:

python3 -m venv .venv
source .venv/bin/activate

Make sure you have `pip` installed for Python 3:

```shell
Expand All @@ -193,78 +198,12 @@ If not, run the following command:
sudo apt install python3-pip
```

Run the following command while connected to your Pi with SSH to install [`Adafruit_CircuitPython_MCP3xxx`](https://github.com/adafruit/Adafruit_CircuitPython_MCP3xxx/):

```shell
sudo pip3 install adafruit-circuitpython-mcp3xxx
```

Create a new directory for your plant watering robot's files and navigate to this directory in your terminal session.
For example, run the following commands:

```shell
mkdir plant-watering-robot
cd plant-watering-robot
```

After navigating to this directory, create a new Python file called <file>adctesting.py</file> and open up the file.
For example, run the following commands:

```shell
touch adctesting.py
nano adctesting.py
```

Now, add the following Python code to <file>adctesting.py</file> to test reading values from your resistive soil moisture sensor through your MCP3008 ADC:

```python
import time
import busio
import digitalio
import board
import adafruit_mcp3xxx.mcp3008 as MCP
from adafruit_mcp3xxx.analog_in import AnalogIn

# Create the SPI bus
spi = busio.SPI(clock=board.SCK, MISO=board.MISO, MOSI=board.MOSI)

# Create the cs (chip select)
cs = digitalio.DigitalInOut(board.D8)

# Create the MCP3008 object
mcp = MCP.MCP3008(spi, cs)

# Create an analog input channel on Pin 0
chan = AnalogIn(mcp, MCP.P0)

print('Reading MCP3008 values, press Ctrl-C to quit...')
while True:
print('Raw ADC Value: ', chan.value)
time.sleep(1)
```

Run the code as follows:
Run the following command to install the SDK:

```shell
sudo python3 adctesting.py
pip3 install viam-sdk
```

{{% alert title="Tip" color="tip" %}}

If running this code returns `ImportError: No module named busio`, try again after reinstalling `adafruit-blinka`:

```shell
sudo pip3 install --force-reinstall adafruit-blinka
```

{{% /alert %}}

Now, you should see the moisture sensor values outputted by the MCP3008.

Test your sensor by putting it in air, water, and different soils to see how the values change to determine your baseline for wet and dry values.

![Terminal output of resistive soil moisture sensor values.](/tutorials/plant-watering-pi/moisture-sensor-output.png)

### Configure the components of your robot in the Viam app

Follow [this guide](/get-started/installation/#install-viam-server) to install `viam-server` on your Pi, create a new robot, and connect to it on [the Viam app](https://app.viam.com).
Expand Down Expand Up @@ -393,13 +332,13 @@ Follow these instructions to start working on your Python control code:

{{% snippet "show-secret.md" %}}

4. Paste this code sample into a new file in the `plant-watering-robot` directory you created on your Pi.
4. Paste this code sample into a new file in the virtual directory you created on your Pi.
5. Name the file <file>plant-watering-robot.py</file>, and save it.

For example, run the following commands on your Pi to create and open the file:

```shell
cd plant-watering-robot
source .venv/bin/activate
touch plant-watering-robot.py
nano plant-watering-robot.py
```
Expand All @@ -426,7 +365,7 @@ while True:
readings = await sensor.get_readings()
soil_moisture = readings.get('moisture')

# Calculate average moisture reading from the list of readings, to account
# Calculate the average moisture reading from the list of readings, to account
# for outliers
avg_moisture = sum(soil_moisture) / len(soil_moisture)

Expand All @@ -435,18 +374,17 @@ while True:
if (avg_moisture > 60000):
print('this plant is too thirsty! giving it more water')

# Run the water pump for 100 rev. at 1000 rpm
# Run the water pump for 100 revs. at 1000 rpm
await water_pump.go_for(rpm=1000, revolutions=100)

# Wait 60 seconds so that the water can soak into the soil a bit before
# trying to water again
print('waiting a little bit for water to soak in')
print('waiting a little bit for the water to soak in')
time.sleep(60)
```

{{% alert title="Tip" color="tip" %}}
Make sure to import `time` at the beginning of your version of <file>plant-watering-robot.py</file> to be able to use `sleep()`!
Also, make sure to import `viam.components.sensor`.
{{% /alert %}}

See the motor component's [API documentation](/components/motor/#gofor) for more information about `water_pump.go_for()`.
Expand All @@ -458,6 +396,8 @@ sudo python3 plant-watering-robot.py
```

To tinker this example code to work best for you, determine at what [analog value from the soil moisture readings](#test-your-soil-moisture-readings-on-your-pi) you want to water your plant, as your thirsty plant's average moisture reading might differ from our example value of `60000`.

Test your sensor by putting it in air, water, and different soils to see how the values change to determine your baseline for wet and dry values.
Also, consider how often you would like to check the moisture levels of the plant, and how long the plant should be watered.

## Next steps
Expand Down

0 comments on commit f18e040

Please sign in to comment.