Skip to content

Commit 5c2ea52

Browse files
authored
Fix grammar errors in the README.md
1 parent cb2c5bf commit 5c2ea52

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

python_client/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Internal client examples
22

3-
This repo contains implementation of example module device using internal client for fleet protocol v2.
4-
These devices is a virtual button which sends its current state and expects state of it's LED as response.
3+
This repo contains an implementation of the Example Module using the Internal Client for Fleet Protocol v2.
4+
The devices supported by this module are virtual buttons which send their current state and expect state of their LED as response.
55

66
#### Preparing environment
77

@@ -20,15 +20,15 @@ pip install -r requirements.txt
2020

2121
## Button
2222

23-
Button is a simple button device which has one LED attached to it. As status, it sends JSON with key `"pressed"` indicating whether button is pressed. As command, it expects JSON with key `"lit_up"` indicating the desired state of internal LED.
23+
Button is a simple button device with one LED attached to it. As status, it sends JSON with key `"pressed"` indicating whether button is pressed. As command, it expects JSON with key `"lit_up"` indicating the desired state of internal LED.
2424

2525
### Usage
2626

27-
Fake buttons can be run with `run_buttons.py` script. It expects config in `yaml` format which specifies attributes for button or multiple buttons (see `buttons.yaml`):
27+
Fake buttons can be run with the `run_buttons.py` script. It expects config in `yaml` format which specifies attributes for a button or multiple buttons (see `buttons.yaml`):
2828

2929
```yaml
3030
- button1_name:
31-
type: <int> specifying module specific device type (default is 0)
31+
type: <int> specifying module-specific device type (default is 0)
3232
role: <str> device role
3333
priority: <int> device priority (default is 0)
3434

@@ -41,6 +41,6 @@ To run use:
4141
python run_buttons.py --ip <server_ip> --port <server_port> --config <path_to_yaml>
4242
```
4343

44-
Multiple fake buttons will be created according to yaml config. They will try to connect to specified server, generate and send their statuses periodically and set their LED states according to commands.
44+
Multiple fake buttons will be created according to yaml config. They will try to connect to the specified server, generate and send their statuses periodically, and set their LED states according to commands.
4545

46-
> Manual mode of actual button pressing on keyboard can be specified by `--manual` argument.
46+
> The manual mode of the actual button pressing on the keyboard can be specified by `--manual` argument.

0 commit comments

Comments
 (0)