Skip to content

Documentation is too old to be understandable and need some review #42

@BroZer8360

Description

@BroZer8360

Current Situation

I just bought a switchbot... And thought the API will be very quick to use but was not.
Can you do a total review of your readme.md to make it more understandable to people, according to your code ?

Tooks many minutes to understand that :

  • To work, you have to check if bluetooth is active : sudo systemctl start bluetooth.service
  • To work, the command shown in readme.md doesn't work, you have to use this one :
    sudo python2 switchbot.py <mac_adress> <component_type> <action>
    eg :
    sudo python2 switchbot.py <mac_adress> Bot Turn On

As python3 script and basic python doesn't work really well on Rpi even following your step and review .o in dependant libraries.

And then, show to people how to get easily mac adresse without scanning with the app on the phone (with a screenshot for exemple).

Logs

$ sudo python switchbot.py <mac_adress> Turn On
Usage: "sudo python switchbot.py [mac dev_type cmd]" or "sudo python switchbot.py"
Preparing to connect.
Connection successful.
Unsupported operations
Complete

Configuration

Well all configuration is OK, this is a bug from documentation and message shown using the script, it's not the good command that is asked to.

Environment

  • OS: Raspbian
  • Software: none
  • Node: none
  • npm: none

Additional Context

No response

Metadata

Metadata

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions