You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+59-59
Original file line number
Diff line number
Diff line change
@@ -118,40 +118,40 @@ sidecar-starter-pack/
118
118
119
119
| class `Authentication()`| Description |
120
120
| :--- | :--- |
121
-
|`get_token()`|<ahref="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><imgsrc="https://img.shields.io/badge/REST%20API-FF9500"/></a> Get FarmBot authorization token. Server is "https://my.farm.bot" by default. |
122
-
|`check_token()`|<ahref="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><imgsrc="https://img.shields.io/badge/REST%20API-FF9500"/></a> Ensure the token persists throughout sidecar. |
123
-
|`request_handling()`|<ahref="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><imgsrc="https://img.shields.io/badge/REST%20API-FF9500"/></a> Handle errors associated with different endpoint errors. |
124
-
|`request()`|<ahref="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><imgsrc="https://img.shields.io/badge/REST%20API-FF9500"/></a> Make requests to API endpoints using different methods. |
121
+
|`get_token()`| Get FarmBot authorization token. Server is "https://my.farm.bot" by default. |
122
+
|`check_token()`| Ensure the token persists throughout sidecar. |
123
+
|`request_handling()`| Handle errors associated with different endpoint errors. |
124
+
|`request()`| Make requests to API endpoints using different methods. |
125
125
126
126
### basic_commands.py
127
127
128
128
| class `BasicCommands()`| Description |
129
129
| :--- | :--- |
130
-
|`wait()`|<ahref="https://developer.farm.bot/v15/docs/message-broker"><imgsrc="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Pauses execution for a certain number of milliseconds. |
131
-
|`e_stop()`|<ahref="https://developer.farm.bot/v15/docs/message-broker"><imgsrc="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
132
-
|`unlock()`|<ahref="https://developer.farm.bot/v15/docs/message-broker"><imgsrc="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Unlocks a locked (E-stopped) device. |
133
-
|`reboot()`|<ahref="https://developer.farm.bot/v15/docs/message-broker"><imgsrc="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Reboots the FarmBot OS and reinitializes the device. |
134
-
|`shutdown()`|<ahref="https://developer.farm.bot/v15/docs/message-broker"><imgsrc="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Shuts down the FarmBot OS, turning the device off. |
130
+
|`wait()`| Pauses execution for a certain number of milliseconds. |
131
+
|`e_stop()`| Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
132
+
|`unlock()`| Unlocks a locked (E-stopped) device. |
133
+
|`reboot()`| Reboots the FarmBot OS and reinitializes the device. |
134
+
|`shutdown()`| Shuts down the FarmBot OS, turning the device off. |
135
135
136
136
### broker.py
137
137
138
138
| class `BrokerConnect()`| Description |
139
139
| :--- | :--- |
140
-
|`connect()`|[BROKER]Establish persistent connection to send messages via message broker. |
141
-
|`disconnect()`|[BROKER]Disconnect from the message broker. |
142
-
|`publish()`|[BROKER]Publish messages containing CeleryScript via the message broker. |
143
-
|`on_connect()`|[BROKER]Callback function triggered when a connection to the message broker is successfully established. |
144
-
|`on_message()`|[BROKER]Callback function triggered when a message is received from the message broker. |
145
-
|`start_listen()`|[BROKER]Establish persistent subscription to message broker channels. |
146
-
|`stop_listen()`|[BROKER]End subscription to all message broker channels. |
140
+
|`connect()`| Establish persistent connection to send messages via message broker. |
141
+
|`disconnect()`| Disconnect from the message broker. |
142
+
|`publish()`| Publish messages containing CeleryScript via the message broker. |
143
+
|`on_connect()`| Callback function triggered when a connection to the message broker is successfully established. |
144
+
|`on_message()`| Callback function triggered when a message is received from the message broker. |
145
+
|`start_listen()`| Establish persistent subscription to message broker channels. |
146
+
|`stop_listen()`| End subscription to all message broker channels. |
147
147
148
148
### camera.py
149
149
150
150
| class `Camera()`| Description |
151
151
| :--- | :--- |
152
-
|`calibrate_camera()`|[BROKER]Performs camera calibration. This action will reset camera calibration settings. |
153
-
|`take_photo()`|[BROKER]Takes a photo using the device camera and uploads it to the web app. |
154
-
<!--- | `photo_grid()` | [BROKER] Returns metadata object about point grid required to perform a scan of the full garden. | --->
152
+
|`calibrate_camera()`| Performs camera calibration. This action will reset camera calibration settings. |
153
+
|`take_photo()`| Takes a photo using the device camera and uploads it to the web app. |
154
+
<!--- | `photo_grid()` | Returns metadata object about point grid required to perform a scan of the full garden. | --->
155
155
156
156
### information.py
157
157
@@ -163,76 +163,76 @@ sidecar-starter-pack/
163
163
164
164
| class `Information()`| Description |
165
165
| :--- | :--- |
166
-
|`get_info()`|[API]Get information about a specific endpoint. |
167
-
|`set_info()`|[API]Change information contained within an endpoint. |
168
-
|`safe_z()`|[API]Returns the highest safe point along the z-axis. |
169
-
|`garden_size()`|[API]Returns x-axis length, y-axis length, and area of garden bed. |
170
-
|`group()`|[API]Returns all group info or single by id. |
171
-
|`curve()`|[API]Returns all curve info or single by id. |
172
-
|`soil_height()`|[BROKER]Use the camera to determine soil height at the current location. |
173
-
|`read_status()`|[BROKER]Returns the FarmBot status tree. |
174
-
|`read_sensor()`|[BROKER]Reads the given pin by id. |
166
+
|`get_info()`| Get information about a specific endpoint. |
167
+
|`set_info()`| Change information contained within an endpoint. |
168
+
|`safe_z()`| Returns the highest safe point along the z-axis. |
169
+
|`garden_size()`| Returns x-axis length, y-axis length, and area of garden bed. |
170
+
|`group()`| Returns all group info or single by id. |
171
+
|`curve()`| Returns all curve info or single by id. |
172
+
|`soil_height()`| Use the camera to determine soil height at the current location. |
173
+
|`read_status()`| Returns the FarmBot status tree. |
174
+
|`read_sensor()`| Reads the given pin by id. |
175
175
176
176
### jobs.py
177
177
178
178
| class `JobHandling()`| Description |
179
179
| :--- | :--- |
180
-
|`get_job()`|[BROKER]Retrieves the status or details of the specified job. |
181
-
|`set_job()`|[BROKER]Initiates or modifies job with given parameters. |
182
-
|`complete_job()`|[BROKER]Marks job as completed and triggers any associated actions. |
180
+
|`get_job()`| Retrieves the status or details of the specified job. |
181
+
|`set_job()`| Initiates or modifies job with given parameters. |
182
+
|`complete_job()`| Marks job as completed and triggers any associated actions. |
183
183
184
184
### messages.py
185
185
186
186
| class `MessageHandling()`| Description |
187
187
| :--- | :--- |
188
-
|`log()`|[API]Sends new log message via the API. Requires the page to be refreshed before appearing. |
189
-
|`message()`|[BROKER]Sends new log message via the message broker. |
190
-
|`debug()`|[BROKER]Sends debug message used for developer information or troubleshooting. |
191
-
|`toast()`|[BROKER]Sends a message that pops up on the user interface briefly. |
188
+
|`log()`| Sends new log message via the API. Requires the page to be refreshed before appearing. |
189
+
|`message()`| Sends new log message via the message broker. |
190
+
|`debug()`| Sends debug message used for developer information or troubleshooting. |
191
+
|`toast()`| Sends a message that pops up on the user interface briefly. |
192
192
193
193
### movements.py
194
194
195
195
| class `MovementControls()`| Description |
196
196
| :--- | :--- |
197
-
|`move()`|[BROKER]Moves to the specified (x, y, z) coordinate. |
198
-
|`set_home()`|[BROKER]Sets the current position as the home position for a specific axis. |
199
-
|`find_home()`|[BROKER]Moves the device to the home position for a specified axis. |
200
-
|`axis_length()`|[BROKER]Returns the length of a specified axis. |
201
-
|`get_xyz()`|[BROKER]Returns the current (x, y, z) coordinates of the FarmBot. |
202
-
|`check_position()`|[BROKER]Verifies position of the FarmBot within specified tolerance range. |
197
+
|`move()`| Moves to the specified (x, y, z) coordinate. |
198
+
|`set_home()`| Sets the current position as the home position for a specific axis. |
199
+
|`find_home()`| Moves the device to the home position for a specified axis. |
200
+
|`axis_length()`| Returns the length of a specified axis. |
201
+
|`get_xyz()`| Returns the current (x, y, z) coordinates of the FarmBot. |
202
+
|`check_position()`| Verifies position of the FarmBot within specified tolerance range. |
203
203
204
204
### peripherals.py
205
205
206
206
| class `Peripherals()`| Description |
207
207
| :--- | :--- |
208
-
|`control_servo()`|[BROKER]Set servo angle between 0-100 degrees. |
209
-
|`control_peripheral()`|[BROKER]Set peripheral value (ON/OFF or slider value from 0-255) and mode (digital or analog). |
210
-
|`toggle_peripheral()`|[BROKER]Toggles the state of a specific peripheral between 'on' (100%) and 'off' (0%). |
0 commit comments