1
1
# sidecar-starter-pack
2
+ Authentication and communication utilities for FarmBot sidecars
2
3
3
4
[ ![ Test Status] ( https://github.com/FarmBot-Labs/sidecar-starter-pack/actions/workflows/test.yml/badge.svg?branch=main )] ( https://github.com/FarmBot-Labs/sidecar-starter-pack/actions?query=branch%3Amain )
4
5
[ ![ Coverage Status] ( https://coveralls.io/repos/github/FarmBot-Labs/sidecar-starter-pack/badge.svg?branch=main )] ( https://coveralls.io/github/FarmBot-Labs/sidecar-starter-pack?branch=main )
5
6
6
- Authentication and communication utilities for FarmBot sidecars
7
-
8
7
## :book : Contents
8
+
9
9
* [ Installation] ( #computer-installation-mac-os )
10
10
* [ Getting Started] ( #seedling-getting-started )
11
11
* [ Get your authentication token] ( #get-your-authentication-token )
@@ -14,7 +14,6 @@ Authentication and communication utilities for FarmBot sidecars
14
14
* [ Formatting message broker messages] ( #formatting-message-broker-messages )
15
15
16
16
## :computer : Installation (Mac OS)
17
- To set up the project locally, follow these steps:
18
17
19
18
Step 1: Clone the repository.
20
19
```
@@ -45,7 +44,6 @@ python3 -m pip install paho-mqtt
45
44
## :seedling : Getting Started
46
45
47
46
### Get your authentication token
48
- To generate your authentication token and get started:
49
47
50
48
Step 1: Import ` main.py ` and create an instance.
51
49
```
@@ -113,7 +111,7 @@ bot.get_token('email', 'password', 'server')
113
111
114
112
| Jobs | Description |
115
113
| :--- | :--- |
116
- | ` get_job() ` | [ BROKER] |
114
+ | ` get_job() ` | [ BROKER] < a href = " https://developer.farm.bot/v15/docs/web-app/rest-api.html " >< img src = " https://img.shields.io/badge/REST%20API-FF9500 " /></ a > |
117
115
| ` set_job() ` | [ BROKER] |
118
116
| ` complete_job() ` | [ BROKER] |
119
117
0 commit comments