Skip to content

Commit dd00766

Browse files
Juliana MashonJuliana Mashon
Juliana Mashon
authored and
Juliana Mashon
committed
Added comments to examples
1 parent 07b21c8 commit dd00766

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,25 @@ bot.set_verbosity(2)
8989
This test will help familiarize you with sending commands via the [API](https://developer.farm.bot/docs/web-app/rest-api).
9090
```
9191
new_cabbage = {
92-
"name": "Cabbage",
93-
"pointer_type": "Plant",
94-
"x": 400,
95-
"y": 300,
96-
"z": 0,
97-
"openfarm_slug": "cabbage",
98-
"plant_stage": "planned",
92+
"name": "Cabbage", # Point name
93+
"pointer_type": "Plant", # Point type
94+
"x": 400, # x-coordinate
95+
"y": 300, # y-coordinate
96+
"z": 0, # z-coordinate
97+
"openfarm_slug": "cabbage", # Plant type
98+
"plant_stage": "planned", # Point status
9999
}
100100
101-
fb.add_info("points", new_cabbage)
101+
bot.add_info("points", new_cabbage) # Add plant to endpoint
102102
```
103103

104104
### Test 2: Turn your LED strip on and off
105105

106106
This test will help familiarize you with sending commands via the [Message Broker](https://developer.farm.bot/docs/message-broker).
107107
```
108-
on(7) # Turn ON pin 7 (LED strip)
109-
wait(2000) # Wait 2000 milliseconds
110-
off(7) # Turn OFF pin 7 (LED strip)
108+
bot.on(7) # Turn ON pin 7 (LED strip)
109+
bot.wait(2000) # Wait 2000 milliseconds
110+
bot.off(7) # Turn OFF pin 7 (LED strip)
111111
```
112112

113113
## :compass: Functions

0 commit comments

Comments
 (0)