@@ -7,10 +7,10 @@ Use the GoDice Python API to integrate GoDice functionality into your own Python
77
88Here are some of the things that you can do with the GoDice Python API:
99
10- * Turn ON/OFF GoDice RGB Leds
10+ * Turn ON/OFF GoDice RGB LEDs
1111* Ask for the die Color (dots color)
1212* Ask for the die battery level
13- * Get differernt notifications reagrding the die state (Rolling or Stable and get the outcome number)
13+ * Get different notifications regarding the die state (Rolling or Stable and get the outcome number)
1414* Use and configure different shells (D6, D20, D12 etc.)
1515
1616To run the demo (that uses the API) make sure you have the Bleak library installed and run main.py as following:
@@ -23,7 +23,7 @@ Once connected you will start get notification from the connected dice (Rolling,
2323
2424 Dependencies Installation
2525------------
26- The GoDice Python API is dependent on the [ Bleak] ( https://github.com/hbldh/bleak ) library for bluetooth (BLE) communication with the dice
26+ The GoDice Python API is dependent on the [ Bleak] ( https://github.com/hbldh/bleak ) library for Bluetooth (BLE) communication with the dice.
2727
2828You can install bleak by using this command:
2929
@@ -40,7 +40,7 @@ To discover dice using GoDice library:
4040``` python
4141from godice import *
4242
43- # Example how to discover GoDice bluetooth devices
43+ # Example how to discover GoDice Bluetooth devices
4444def main ():
4545
4646 # Discovering GoDice devices using BLE
@@ -62,7 +62,7 @@ Activating LEDs:
6262# Turn On/Off RGB LEDs, will turn off if led1 and led2 are None
6363# led1 - a list to control the 1st LED in the following format '[R, G, B]'
6464# where R, G, and B are numbers in the range of 0-255
65- # led2 - same as led1 fot the second led
65+ # led2 - same as led1 for the second led
6666
6767set_led(led1: list , led2: list )
6868```
@@ -106,7 +106,7 @@ Reading responses
106106Each die object has a "result_queue" attribute.
107107Whenever a response/message is sent to the die, it's response code (if it has one) and it's value placed in the result queue as a tuple.
108108
109- Example for iterating throught the queue:
109+ Example for iterating through the queue:
110110``` python
111111while not die_object.result_queue.empty():
112112
@@ -133,7 +133,7 @@ while not die_object.result_queue.empty():
133133
134134("FS" - Fake stable event, Value of die)
135135
136- ("B" - Battery response, Battery charge precent : 0-100)
136+ ("B" - Battery response, Battery charge percent : 0-100)
137137
138138("C" - Color response, ID of color of die: 0-5)
139139
0 commit comments