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
> 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).
70
65
71
66
| Authentication | Description |
72
-
| --- | --- |
67
+
|:--- |:--- |
73
68
|[API]`get_token()`| Generate user authentication token using your email and password. Server is https://my.farm.bot by default. |
74
69
75
70
| Publishing | Description |
76
-
| --- | --- |
71
+
|:--- |:--- |
77
72
|[API]`request()`| Send requests to the API using various methods. |
78
73
|[BROKER]`publish()`| Publish messages containing CeleryScript via the message broker. |
79
74
75
+
> [!CAUTION]
76
+
> 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.
77
+
80
78
| Subscriptions | Description |
81
-
| --- | --- |
79
+
|:--- |:--- |
82
80
|[BROKER]`connect()`| Establish persistent connection with the message broker. |
83
81
|[BROKER]`disconnect()`| Disconnect from the message broker. |
84
82
|[BROKER]`start_listening()`| Establish persistent subscription to message broker channels. |
85
83
|[BROKER]`stop_listening()`| End subscription to all message broker channels. |
86
84
87
85
| Basic Commands | Description |
88
-
| --- | --- |
86
+
|:--- |:--- |
89
87
|[BROKER]`wait()`| Pauses execution for a certain number of milliseconds. |
90
88
|[BROKER]`e_stop()`| Emergency locks (E-stops) the Farmduino microcontroller and resets peripheral pins to OFF. |
91
89
|[BROKER]`unlock()`| Unlocks a locked (E-stopped) device. |
92
90
|[BROKER]`reboot()`| description |
93
91
|[BROKER]`shutdown()`| description |
94
92
95
93
| Camera | Description |
96
-
| --- | --- |
94
+
|:--- |:--- |
97
95
|[BROKER]`calibrate_camera()`| Performs camera calibration. This action will reset camera calibration settings. |
98
96
|[BROKER]`take_photo()`| Takes a photo using the device camera and uploads it to the web app. |
99
97
|[BROKER]`photo_grid()`| Returns metadata object about point grid required to perform a scan of the full garden. |
100
98
101
99
| Information | Description |
102
-
| --- | --- |
100
+
|:--- |:--- |
103
101
|[API]`get_info()`| Get information about a specific endpoint. |
104
102
|[API]`set_info()`| Change information contained within an endpoint. |
105
103
|[API]`safe_z()`| Returns the highest safe point along the z-axis. |
|[BROKER]`read_status()`| Returns the FarmBot status tree. |
110
108
|[BROKER]`read_sensor()`| description |
111
109
112
-
> [!CAUTION]
113
-
> 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.
114
-
115
110
> [!NOTE]
116
111
> Not sure which endpoint to access? [Find the list here](https://developer.farm.bot/v15/docs/web-app/api-docs).
0 commit comments