Commit Graph

27 Commits

Author SHA1 Message Date
Néstor Díaz Valencia
f506bbcaab Update README.md 2021-09-25 09:30:55 +09:00
Shin'ichiro Kawasaki
9265086b12 Tag version 0.2.3
Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-05-08 21:04:03 +09:00
Shin'ichiro Kawasaki
ea1109cee2 Tag version 0.2.2
Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-05-03 19:42:50 +09:00
Shin'ichiro Kawasaki
f4af270fbc README.md: Improve description for multiple devices
Describe limitation for multiple device connections in "In Case You Fail
to Connect" section. Also, mention about toio support and improved a few
descriptions.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-05-03 19:33:06 +09:00
Shin'ichiro Kawasaki
e34ec61f3b Tag version 0.2.1
Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-04-11 14:14:33 +09:00
Peter Butkovic
461377f7ea Fixed missing glib.h error 2021-02-07 20:25:42 +09:00
Shin'ichiro Kawasaki
923c036cec Tag version 0.2.0
Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-12-27 21:09:05 +09:00
Shin'ichiro Kawasaki
8a69c2c917 README.md: Add "Issue Reporting" and Releases" sections
Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-12-27 20:57:09 +09:00
Shin'ichiro Kawasaki
8bf23a8c77 README.md: Brush up description
Improved English of the description. Updated list of devices and distros
that work with pyscrlink. Replaced 'Lego' with 'LEGO'.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-10-27 11:32:57 +09:00
Shin'ichiro Kawasaki
4ff47e2368 README.md: Describe repository rename to pyscrlink
Briefly described that bluepy-scratch-link was renamed to pyscrlink in
October 2020.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-10-23 18:06:55 +09:00
Shin'ichiro Kawasaki
bcd55cad00 README.md: Update description for pyscrlink
Rephrase explanation to match with the new project name "pyscrlink".

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-10-23 18:06:55 +09:00
Shin'ichiro Kawasaki
74344c6dee README.md: Clarify that BLED112 USB dongle is not supported
BLED112 is not supported at this moment. Comment it in README.md until
path for support gets clarified.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-09-20 21:15:06 +09:00
Shin'ichiro Kawasaki
e706263fea bluepy_helper_cap.py: Check bluepy-helper capability at scratch-link run
To run bluepy-scratch-link as a normal user bluepy-helper must have
cap_net_admin and cap_net_raw capabilities to connect to BLE devices
using bluepy. When it lacks these capabilities, bluepy-scratch-link
fails to discover BLE devices without message about the failure reason.

To inform users the reason of BLE device detection failure, check
capabilities of bluepy-helper when discovery of BLE device is requested.
If the capabilities are not set, print error messages and request users
to run script to set the capabilities. Implement this features in
bluepy_helper_cap.py.

In addition, re-implement bash script setcap.sh feature as python and
added to bluepy_helper_cap.py to simplify the code set.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-09-20 21:11:28 +09:00
Shin'ichiro Kawasaki
708a8a6f28 README.md: Remove description about gencert.sh
Now scratch_link.py generates certificate at server start. Remove
description about gencert.sh which is no longer needed.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-09-20 13:50:01 +09:00
Shin'ichiro Kawasaki
502670c3ac README.md: Avoid sudo for scratch_link.py
The README instruction notes to run scratch_link.py with sudo. This is
not good for normal users especially for children. To allow normal users
to run scratch_link.py, revise the instruction.

Add a step to run setcap.sh at set up. Remove the step of btmgmt commands
with sudo which are not required when bluetooth.service is running.
Also add some more troubleshooting guides users might be caught at
scratch_link.py without sudo.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-08-01 14:20:07 +09:00
Shin'ichiro Kawasaki
3557a5d1d2 README.md: Add bluez-utils to required package list for Arch
To use btmgmt on Arch systems, need to install bluez-utils package.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-05-31 13:22:45 +09:00
Shin'ichiro Kawasaki
4da6b4714a README.md: Remove server certificate allowance step from usage guide
With previous commit, gencert.sh automatically add the certificate to
FireFox or Chrome using certutil command. Blupy-scratch-link users no
need to allow the certificate explicitly.

Also add NSS to the required package list to install, which includes the
certutil command.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-04-19 21:46:57 +09:00
Shin'ichiro Kawasaki
f0bf6e1a6a README.md: Fix broken markdown format
To have new line after list items with numbers, the list item needs
period following empty line.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-04-11 17:03:12 +09:00
Shin'ichiro Kawasaki
f87a435f96 gencert.sh: Simplify certificate file generation commands
The command lines to generate certificate file for web server are
troublesome and their parameters confuse users. To clean up the steps per
James Le Cuirot suggestions, simplify openssl options and bash commands
in the generation script and README.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-04-11 17:01:08 +09:00
ngammarano
0bab1bdd29 Update README.md, corrected bullet list display 2020-03-12 10:42:10 -03:00
Shin'ichiro Kawasaki
27c95a9319 README.md: Improve device and distro confirmation status
Added "Confirmed devices and distros" section to clarify who confirmed
with which device or distros bluepy-scratch-link working well. Remove
trailing white spaces. Modified git repo URL for installation.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-03-01 14:46:53 +09:00
Chris Glencross
61a4ff5dbb Fix documentation, and mention pairing on the Raspberry Pi. 2020-02-24 20:24:18 +00:00
Chris Glencross
6b7619ebeb Add Lego Mindstorms functionality 2020-02-24 19:48:12 +00:00
Shin'ichiro Kawasaki
2b7fb7a07a README.md: Describe how to use Chrome browser
As ngammarano reported in a GitHub issue, Chrome browser has bypass key
sequence to allow local server certificate. Add that description to
README.md merging jazzpecq's patch. Thank goes to the two :)

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2020-01-18 16:42:32 +09:00
Shin'ichiro Kawasaki
9cbe00224a README.md: Clarify python version 3.6 as the requirement
It was reported that the bluepy-scratch-link does not run on Ubuntu 16.04
which has python version 3.5. The script stopped with an error about
f-format string, which was introduce with python 3.6.

Even removing f-format string from the script, bluepy-scratch-link still
requires python 3.6 because websockets module requires it. Clarify that
python version requirement to avoid confusion.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2019-11-10 18:49:55 +09:00
Shin'ichiro Kawasaki
6136280c93 README.md: Describe motivation, installation and usage
Described why this script was written. Wrote down installation and usage
guide. Confirmed the guide with elementary os 5.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2019-09-15 20:50:32 +09:00
Shin'ichiro Kawasaki
64ed1e53d9 Initial commit 2019-09-11 20:49:09 +09:00