Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Juliana Mashon authored and Juliana Mashon committed Aug 6, 2024
1 parent f3d558f commit d08a2a9
Showing 1 changed file with 55 additions and 55 deletions.
110 changes: 55 additions & 55 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,100 +65,100 @@ bot.get_token('email', 'password', 'server')
| Authentication | Description |
| :--- | :--- |
| [API] `get_token()` | Generate user authentication token using your email and password. Server is https://my.farm.bot by default. |
| `get_token()` | [API] Generate user authentication token using your email and password. Server is https://my.farm.bot by default. |

| Publishing | Description |
| :--- | :--- |
| [API] `request()` | Send requests to the API using various methods. |
| [BROKER] `publish()` | Publish messages containing CeleryScript via the message broker. |
| `request()` | [API] Send requests to the API using various methods. |
| `publish()` | [BROKER] Publish messages containing CeleryScript via the message broker. |

> [!CAUTION]
> Making requests other than `GET` to the API will permanently alter the data in your account. `DELETE` and `POST` requests may destroy data that cannot be recovered. Altering data through the API may cause account instability.
| Subscriptions | Description |
| :--- | :--- |
| [BROKER] `connect()` | Establish persistent connection with the message broker. |
| [BROKER] `disconnect()` | Disconnect from the message broker. |
| [BROKER] `start_listening()` | Establish persistent subscription to message broker channels. |
| [BROKER] `stop_listening()` | End subscription to all message broker channels. |
| `connect()` | [BROKER] Establish persistent connection with the message broker. |
| `disconnect()` | [BROKER] Disconnect from the message broker. |
| `start_listening()` | [BROKER] Establish persistent subscription to message broker channels. |
| `stop_listening()` | [BROKER] End subscription to all message broker channels. |

| Basic Commands | Description |
| :--- | :--- |
| [BROKER] `wait()` | Pauses execution for a certain number of milliseconds. |
| [BROKER] `e_stop()` | Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
| [BROKER] `unlock()` | Unlocks a locked (E-stopped) device. |
| [BROKER] `reboot()` | description |
| [BROKER] `shutdown()` | description |
| `wait()` | [BROKER] Pauses execution for a certain number of milliseconds. |
| `e_stop()` | [BROKER] Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
| `unlock()` | [BROKER] Unlocks a locked (E-stopped) device. |
| `reboot()` | [BROKER] |
| `shutdown()` | [BROKER] |

| Camera | Description |
| :--- | :--- |
| [BROKER] `calibrate_camera()` | Performs camera calibration. This action will reset camera calibration settings. |
| [BROKER] `take_photo()` | Takes a photo using the device camera and uploads it to the web app. |
| [BROKER] `photo_grid()` | Returns metadata object about point grid required to perform a scan of the full garden. |
| `calibrate_camera()` | [BROKER] Performs camera calibration. This action will reset camera calibration settings. |
| `take_photo()` | [BROKER] Takes a photo using the device camera and uploads it to the web app. |
| `photo_grid()` | [BROKER] Returns metadata object about point grid required to perform a scan of the full garden. |

| Information | Description |
| :--- | :--- |
| [API] `get_info()` | Get information about a specific endpoint. |
| [API] `set_info()` | Change information contained within an endpoint. |
| [API] `safe_z()` | Returns the highest safe point along the z-axis. |
| [API] `garden_size()` | Returns x-axis length, y-axis length, and area of garden bed. |
| [API] `group()` | Returns all group info or single by id. |
| [API] `curve()` | Returns all curve info or single by id. |
| [BROKER] `read_status()` | Returns the FarmBot status tree. |
| [BROKER] `read_sensor()` | description |
| `get_info()` | [API] Get information about a specific endpoint. |
| `set_info()` | [API] Change information contained within an endpoint. |
| `safe_z()` |[API] Returns the highest safe point along the z-axis. |
| `garden_size()` | [API] Returns x-axis length, y-axis length, and area of garden bed. |
| `group()` | [API] Returns all group info or single by id. |
| `curve()` | [API] Returns all curve info or single by id. |
| `read_status()` | [BROKER] Returns the FarmBot status tree. |
| `read_sensor()` | [BROKER] |

> [!NOTE]
> Not sure which endpoint to access? [Find the list here](https://developer.farm.bot/v15/docs/web-app/api-docs).
| Jobs | Description |
| :--- | :--- |
| [BROKER] `get_job()` | description |
| [BROKER] `set_job()` | description |
| [BROKER] `complete_job()` | description |
| `get_job()` | [BROKER] |
| `set_job()` | [BROKER] |
| `complete_job()` | [BROKER] |

| Messages | Description |
| :--- | :--- |
| [API] `log()` | description |
| [BROKER] `message()` | description |
| [BROKER] `debug()` | description |
| [BROKER] `toast()` | description |
| `log()` | [API] |
| `message()` | [BROKER] |
| `debug()` | [BROKER] |
| `toast()` | [BROKER] |

| Movement | Description |
| :--- | :--- |
| [BROKER] `move()` | description |
| [BROKER] `set_home()` | description |
| [BROKER] `find_home()` | description |
| [BROKER] `axis_length()` | description |
| [BROKER] `get_xyz()` | description |
| [BROKER] `check_position()` | description |
| `move()` | [BROKER] |
| `set_home()` | [BROKER] |
| `find_home()` | [BROKER] |
| `axis_length()` | [BROKER] |
| `get_xyz()` | [BROKER] |
| `check_position()` | [BROKER] |

| Peripherals | Description |
| :--- | :--- |
| [BROKER] `control_servo()` | description |
| [BROKER] `control_peripheral()` | description |
| [BROKER] `toggle_peripheral()` | description |
| [BROKER] `on()` | description |
| [BROKER] `off()` | description |
| `control_servo()` | [BROKER] |
| `control_peripheral()` | [BROKER] |
| `toggle_peripheral()` | [BROKER] |
| `on()` | [BROKER] |
| `off()` | [BROKER] |

| Resources | Description |
| :--- | :--- |
| [BROKER] `mark_point()` | description |
| [BROKER] `sort_points()` | description |
| [BROKER] `sequence()` | description |
| [BROKER] `get_seed_tray_cell()` | description |
| [BROKER] `soil_height()` | Use the camera to determine soil depth at the current location. |
| [BROKER] `detect_weeds()` | Take photo and detect weeds in the image. If detected, weed points will be created. |
| [BROKER] `lua()` | Send a message containing lua code via the message broker. |
| [BROKER] `if_statement()` | description |
| [BROKER] `assertion()` | description |
| `mark_point()` | [BROKER] |
| `sort_points()` | [BROKER] |
| `sequence()` | [BROKER] |
| `get_seed_tray_cell()` | [BROKER] |
| `soil_height()` | [BROKER] Use the camera to determine soil depth at the current location. |
| `detect_weeds()` | [BROKER] Take photo and detect weeds in the image. If detected, weed points will be created. |
| `lua()` | [BROKER] Send a message containing lua code via the message broker. |
| `if_statement()` | [BROKER] |
| `assertion()` | [BROKER] |

| Tools | Description |
| :--- | :--- |
| [BROKER] `verify_tool()` | Verifies if a tool is mounted to the UTM. |
| [BROKER] `mount_tool()` | Mounts given tool and pulls it out of slot. |
| [BROKER] `dismount_tool()` | Dismounts currently mounted tool into assigned slot. |
| [BROKER] `water()` | Moves to and waters the given plant. |
| [BROKER] `dispense()` | Dispenses the given amount of liquid in milliliters. |
| `verify_tool()` | [BROKER] Verifies if a tool is mounted to the UTM. |
| `mount_tool()` | [BROKER] Mounts given tool and pulls it out of slot. |
| `dismount_tool()` | [BROKER] Dismounts currently mounted tool into assigned slot. |
| `water()` | [BROKER] Moves to and waters the given plant. |
| `dispense()` | [BROKER] Dispenses the given amount of liquid in milliliters. |

## :toolbox: Developer Info

Expand Down

0 comments on commit d08a2a9

Please sign in to comment.