Skip to content

Add more info to the README: compatible devices, bypass device scan #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adlerweb merged 1 commit into from
Nov 12, 2024
Merged

Add more info to the README: compatible devices, bypass device scan #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# J7-C_UC96_BLE_Logger
Bluetooth Low Energy Data logging for J7-C/UC96 USB Digital Power Testers
Bluetooth Low Energy Data logging for J7-C/UC96 USB Digital Power Testers. It should work with all the digital testers sharing the atorch protocol - see [here](https://github.com/CursedHardware/atorch-console/blob/master/README.md#supported-meter) for a list of potentially supported devices. Tested on J7-C and UD18 meters.

## Installation

Requires [gattlib](https://github.com/labapart/gattlib).

### Warning

Sadly there has been an API change with newer bluetooth adapters (HCI5) which [isn't supported by gattlib yet](https://github.com/oscaracena/pygattlib/issues/31). If you see a `Set scan parameters failed` error, your adapter may be using >=HCI5 and not be supported until the code has been ported to dbus/bluez or gattlib is updated.
Sadly there has been an API change with newer bluetooth adapters (HCI5) which [isn't supported by gattlib yet](https://github.com/oscaracena/pygattlib/issues/31). If you see a `Set scan parameters failed` error, your adapter may be using >=HCI5 and not be supported until the code has been ported to dbus/bluez or gattlib is updated. You can still run the script, though, you just need to bypass the scan by passing the `--device` option (or its shorthand `-d`) when running it.

## Usage

Expand All @@ -33,7 +33,7 @@ Device control:
target device MAC address. If no address is given
the first compatible device found will be used
-w, --wait wait for device to appear
-r, --reconnect wait and reconnect when loosing connection
-r, --reconnect wait and reconnect after losing connection
-H HCI, --hci HCI HCI used for communication. Defaults to hci0
-T SCANTIME, --scantime SCANTIME
Time in seconds to scan for devices. Defaults to 2
Expand Down
6 changes: 3 additions & 3 deletions j7c.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
group_dev = parser.add_argument_group(title="Device control")
group_dev.add_argument("-d", "--device", help="target device MAC address. If no address is given the first compatible device found will be used", default=False)
group_dev.add_argument('-w', '--wait', help='wait for device to appear', action='store_true')
group_dev.add_argument('-r', '--reconnect', help='wait and reconnect when loosing connection', action='store_true')
group_dev.add_argument('-r', '--reconnect', help='wait and reconnect after losing connection', action='store_true')
group_dev.add_argument("-H", "--hci", help="HCI used for communication. Defaults to hci0", default="hci0")
group_dev.add_argument("-T", "--scantime", help="Time in seconds to scan for devices. Defaults to 2 Seconds", default=2, type=int)

Expand Down Expand Up @@ -168,7 +168,7 @@ def __init__(self, address):
self.requester = NotifyRequester(self.received, address, False)

def connect(self):
debug(1, "Conneting to " + target)
debug(1, "Connecting to " + target)
sys.stdout.flush()

self.requester.connect(True)
Expand Down Expand Up @@ -210,7 +210,7 @@ def send_data(self):
debug(3, "Found compatible device at address " + address)
target = address
except:
debug(0, "Device discovery failed. Is bluetooth enabled? Are you root?")
debug(0, "Device discovery failed. Is bluetooth enabled? Are you root? Try running the script with the --device option to bypass the scan - see https://github.com/adlerweb/J7-C_UC96_BLE_Logger/blob/main/README.md#warning")

if args.wait:
doWait = True
Expand Down