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
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
+
```
77
80
78
81
| Verbosity | Example using `e_stop()`|
79
82
| :--- | :--- |
@@ -108,30 +111,27 @@ sidecar-starter-pack/
108
111
└── README.md
109
112
```
110
113
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
-
114
114
### authentication.py
115
115
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
-
123
116
> [!CAUTION]
124
117
> Store your authorization token securely. It grants full access and control over your FarmBot and your FarmBot Web App account.
125
118
119
+
| class `Authentication()`| Description |
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. |
125
+
126
126
### basic_commands.py
127
127
128
128
| class `BasicCommands()`| Description |
129
129
| :--- | :--- |
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()`|<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. |
135
135
136
136
### broker.py
137
137
@@ -155,6 +155,12 @@ sidecar-starter-pack/
155
155
156
156
### information.py
157
157
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
+
158
164
| class `Information()`| Description |
159
165
| :--- | :--- |
160
166
|`get_info()`|[API] Get information about a specific endpoint. |
@@ -167,12 +173,6 @@ sidecar-starter-pack/
167
173
|`read_status()`|[BROKER] Returns the FarmBot status tree. |
168
174
|`read_sensor()`|[BROKER] Reads the given pin by id. |
169
175
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).
0 commit comments