From 22ae4abcbf1d7445b6befa373c3fa1e8f2d425b4 Mon Sep 17 00:00:00 2001 From: Juliana Mashon Date: Tue, 6 Aug 2024 14:42:36 -0700 Subject: [PATCH] Updated descriptions with badges --- README.md | 113 ++++++++++++++++++++++++++---------------------------- 1 file changed, 55 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index ece74aa..e77ae3c 100644 --- a/README.md +++ b/README.md @@ -59,105 +59,102 @@ bot.get_token('email', 'password', 'server') ## :compass: Functions -> [!TIP] -> Functions marked with [API] communicate with the Farm Designer web app via the [REST API](https://developer.farm.bot/v15/docs/web-app/rest-api.html) and those marked with [BROKER] communicate with the FarmBot via the [message broker](https://developer.farm.bot/v15/docs/message-broker). - | Authentication | Description | | :--- | :--- | -| `get_token()` | [API] Generate user authentication token using your email and password. Server is https://my.farm.bot by default. | +| `get_token()` | Generate user authentication token using your email and password. Server is https://my.farm.bot by default. | | Publishing | Description | | :--- | :--- | -| `request()` | [API] Send requests to the API using various methods. | -| `publish()` | [BROKER] Publish messages containing CeleryScript via the message broker. | +| `request()` | Send requests to the API using various methods. | +| `publish()` | 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 | | :--- | :--- | -| `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. | +| `connect()` | Establish persistent connection with the message broker. | +| `disconnect()` | Disconnect from the message broker. | +| `start_listening()` | Establish persistent subscription to message broker channels. | +| `stop_listening()` | End subscription to all message broker channels. | | Basic Commands | 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] | +| `wait()` | Pauses execution for a certain number of milliseconds. | +| `e_stop()` | Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. | +| `unlock()` | Unlocks a locked (E-stopped) device. | +| `reboot()` | | +| `shutdown()` | | | Camera | Description | | :--- | :--- | -| `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. | +| `calibrate_camera()` | Performs camera calibration. This action will reset camera calibration settings. | +| `take_photo()` | Takes a photo using the device camera and uploads it to the web app. | +| `photo_grid()` | Returns metadata object about point grid required to perform a scan of the full garden. | | Information | 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] | +| `get_info()` | Get information about a specific endpoint. | +| `set_info()` | Change information contained within an endpoint. | +| `safe_z()` | Returns the highest safe point along the z-axis. | +| `garden_size()` | Returns x-axis length, y-axis length, and area of garden bed. | +| `group()` | Returns all group info or single by id. | +| `curve()` | Returns all curve info or single by id. | +| `read_status()` | Returns the FarmBot status tree. | +| `read_sensor()` | | > [!NOTE] > Not sure which endpoint to access? [Find the list here](https://developer.farm.bot/v15/docs/web-app/api-docs). | Jobs | Description | | :--- | :--- | -| `get_job()` | [BROKER] | -| `set_job()` | [BROKER] | -| `complete_job()` | [BROKER] | +| `get_job()` | | +| `set_job()` | | +| `complete_job()` | | | Messages | Description | | :--- | :--- | -| `log()` | [API] | -| `message()` | [BROKER] | -| `debug()` | [BROKER] | -| `toast()` | [BROKER] | +| `log()` | | +| `message()` | | +| `debug()` | | +| `toast()` | | | Movement | Description | | :--- | :--- | -| `move()` | [BROKER] | -| `set_home()` | [BROKER] | -| `find_home()` | [BROKER] | -| `axis_length()` | [BROKER] | -| `get_xyz()` | [BROKER] | -| `check_position()` | [BROKER] | +| `move()` | | +| `set_home()` | | +| `find_home()` | | +| `axis_length()` | | +| `get_xyz()` | | +| `check_position()` | | | Peripherals | Description | | :--- | :--- | -| `control_servo()` | [BROKER] | -| `control_peripheral()` | [BROKER] | -| `toggle_peripheral()` | [BROKER] | -| `on()` | [BROKER] | -| `off()` | [BROKER] | +| `control_servo()` | | +| `control_peripheral()` | | +| `toggle_peripheral()` | | +| `on()` | | +| `off()` | | | Resources | 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] | +| `mark_point()` | | +| `sort_points()` | | +| `sequence()` | | +| `get_seed_tray_cell()` | | +| `soil_height()` | Use the camera to determine soil depth at the current location. | +| `detect_weeds()` | Take photo and detect weeds in the image. If detected, weed points will be created. | +| `lua()` | Send a message containing lua code via the message broker. | +| `if_statement()` | | +| `assertion()` | | | Tools | Description | | :--- | :--- | -| `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. | +| `verify_tool()` | Verifies if a tool is mounted to the UTM. | +| `mount_tool()` | Mounts given tool and pulls it out of slot. | +| `dismount_tool()` | Dismounts currently mounted tool into assigned slot. | +| `water()` | Moves to and waters the given plant. | +| `dispense()` | Dispenses the given amount of liquid in milliliters. | ## :toolbox: Developer Info