From 547f45d5433866958fd837bcf880efc8afa5f84a Mon Sep 17 00:00:00 2001 From: Santobert Date: Sun, 15 Nov 2020 21:25:27 +0100 Subject: [PATCH] Use syntax highlighting (#64) --- README.md | 75 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 45 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 5ff2dcf..61b74b9 100644 --- a/README.md +++ b/README.md @@ -10,27 +10,35 @@ This API is experimental. Use at your own risk. Feel free to contribute if thing ## Installation Install using pip - pip install pybotvac +```bash +pip install pybotvac +``` Alternatively, clone the repository and run - python setup.py install +```bash +python setup.py install +``` ## Usage ### Robot If the serial and secret for your robot is known, simply run - >>> from pybotvac import Robot - >>> robot = Robot('OPS01234-0123456789AB', '0123456789ABCDEF0123456789ABCDEF', 'my_robot_name') - >>> print(robot) - Name: sample_robot, Serial: OPS01234-0123456789AB, Secret: 0123456789ABCDEF0123456789ABCDEF +```python +>>> from pybotvac import Robot +>>> robot = Robot('OPS01234-0123456789AB', '0123456789ABCDEF0123456789ABCDEF', 'my_robot_name') +>>> print(robot) +Name: sample_robot, Serial: OPS01234-0123456789AB, Secret: 0123456789ABCDEF0123456789ABCDEF +``` The format of the serial should be 'OPSxxxxx-xxxxxxxxxxxx', and the secret should be a string of hex characters 32 characters long. These can be found by using the Account class. To start cleaning - robot.start_cleaning() +```python +robot.start_cleaning() +``` If no exception occurred, your robot should now get to work. @@ -48,37 +56,44 @@ Currently the following methods are available in the Robot class: For convenience, properties exist for state and schedule - # Get state - state = robot.state +```python +# Get state +state = robot.state - # Check if schedule is enabled - robot.schedule_enabled +# Check if schedule is enabled +robot.schedule_enabled - # Disable schedule - robot.schedule_enabled = False +# Disable schedule +robot.schedule_enabled = False +``` ### Account If the serial and secret is unknown, they can be retrieved using the Account class. - >>> from pybotvac import Account - >>> # List all robots associated with account - >>> for robot in Account('sample@email.com', 'sample_password').robots: - print(robot) - - Name: my_robot_name, Serial: OPS01234-0123456789AB, Secret: 0123456789ABCDEF0123456789ABCDEF, Traits: ['maps'] +```python +>>> from pybotvac import Account +>>> # List all robots associated with account +>>> for robot in Account('sample@email.com', 'sample_password').robots: +... print(robot) +Name: my_robot_name, Serial: OPS01234-0123456789AB, Secret: 0123456789ABCDEF0123456789ABCDEF, Traits: ['maps'] +``` Information about maps and download of maps can be done from the Account class: - >>> from pybotvac import Account - >>> # List all maps associated with a specific robot - >>> for map_info in Account('sample@email.com', 'sample_password').maps: - print(map_info) +```python +>>> from pybotvac import Account +>>> # List all maps associated with a specific robot +>>> for map_info in Account('sample@email.com', 'sample_password').maps: +... print(map_info) +``` A cleaning map can be downloaded with the account class. Returns the raw image response. Example shows latest map. - You need the url from the map output to do that: - - >>> from pybotvac import Account - >>> # List all maps associated with a specific robot - >>> map = Account('sample@email.com', 'sample_password').maps - >>> download_link = map['robot_serial']['maps'][0]['url'] - Account('sample@email.com', 'sample_password').get_map_image('download_link') +You need the url from the map output to do that: + +```python +>>> from pybotvac import Account +>>> # List all maps associated with a specific robot +>>> map = Account('sample@email.com', 'sample_password').maps +>>> download_link = map['robot_serial']['maps'][0]['url'] +>>> Account('sample@email.com', 'sample_password').get_map_image(download_link) +```