Skip to content

Commit a998c4b

Browse files
Juliana MashonJuliana Mashon
Juliana Mashon
authored and
Juliana Mashon
committed
Attempt to add links via badges
1 parent a12144c commit a998c4b

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ bot.get_token("email", "password")
7474
### Configure function output verbosity
7575

7676
Set the level of verbosity of function outputs to change the level of information shown when functions are called.
77+
```
78+
bot.set_verbosity(2)
79+
```
7780

7881
| Verbosity | Example using `e_stop()` |
7982
| :--- | :--- |
@@ -108,30 +111,27 @@ sidecar-starter-pack/
108111
└── README.md
109112
```
110113

111-
> [!TIP]
112-
> 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).
113-
114114
### authentication.py
115115

116-
| class `Authentication()` | Description |
117-
| :--- | :--- |
118-
| `get_token()` | [API] Get FarmBot authorization token. Server is "https://my.farm.bot" by default. |
119-
| `check_token()` | [API] Ensure the token persists throughout sidecar. |
120-
| `request_handling()` | [API] Handle errors associated with different endpoint errors. |
121-
| `request()` | [API] Make requests to API endpoints using different methods. |
122-
123116
> [!CAUTION]
124117
> Store your authorization token securely. It grants full access and control over your FarmBot and your FarmBot Web App account.
125118
119+
| class `Authentication()` | Description |
120+
| :--- | :--- |
121+
| `get_token()` | <a href="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><img src="https://img.shields.io/badge/REST%20API-FF9500"/></a> Get FarmBot authorization token. Server is "https://my.farm.bot" by default. |
122+
| `check_token()` | <a href="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><img src="https://img.shields.io/badge/REST%20API-FF9500"/></a> Ensure the token persists throughout sidecar. |
123+
| `request_handling()` | <a href="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><img src="https://img.shields.io/badge/REST%20API-FF9500"/></a> Handle errors associated with different endpoint errors. |
124+
| `request()` | <a href="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><img src="https://img.shields.io/badge/REST%20API-FF9500"/></a> Make requests to API endpoints using different methods. |
125+
126126
### basic_commands.py
127127

128128
| class `BasicCommands()` | Description |
129129
| :--- | :--- |
130-
| `wait()` | [BROKER] Pauses execution for a certain number of milliseconds. |
131-
| `e_stop()` | [BROKER] Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
132-
| `unlock()` | [BROKER] Unlocks a locked (E-stopped) device. |
133-
| `reboot()` | [BROKER] Reboots the FarmBot OS and reinitializes the device. |
134-
| `shutdown()` | [BROKER] Shuts down the FarmBot OS, turning the device off. |
130+
| `wait()` | <a href="https://developer.farm.bot/v15/docs/message-broker"><img src="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Pauses execution for a certain number of milliseconds. |
131+
| `e_stop()` | <a href="https://developer.farm.bot/v15/docs/message-broker"><img src="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
132+
| `unlock()` | <a href="https://developer.farm.bot/v15/docs/message-broker"><img src="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Unlocks a locked (E-stopped) device. |
133+
| `reboot()` | <a href="https://developer.farm.bot/v15/docs/message-broker"><img src="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Reboots the FarmBot OS and reinitializes the device. |
134+
| `shutdown()` | <a href="https://developer.farm.bot/v15/docs/message-broker"><img src="https://img.shields.io/badge/Message%20Broker-66BF34"/></a> Shuts down the FarmBot OS, turning the device off. |
135135

136136
### broker.py
137137

@@ -155,6 +155,12 @@ sidecar-starter-pack/
155155

156156
### information.py
157157

158+
> [!CAUTION]
159+
> 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.
160+
161+
> [!NOTE]
162+
> Not sure which endpoint to access? [Find the list here](https://developer.farm.bot/v15/docs/web-app/api-docs).
163+
158164
| class `Information()` | Description |
159165
| :--- | :--- |
160166
| `get_info()` | [API] Get information about a specific endpoint. |
@@ -167,12 +173,6 @@ sidecar-starter-pack/
167173
| `read_status()` | [BROKER] Returns the FarmBot status tree. |
168174
| `read_sensor()` | [BROKER] Reads the given pin by id. |
169175

170-
> [!CAUTION]
171-
> 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.
172-
173-
> [!NOTE]
174-
> Not sure which endpoint to access? [Find the list here](https://developer.farm.bot/v15/docs/web-app/api-docs).
175-
176176
### jobs.py
177177

178178
| class `JobHandling()` | Description |

0 commit comments

Comments
 (0)