Skip to content

Commit

Permalink
Updated to new command structure
Browse files Browse the repository at this point in the history
  • Loading branch information
nouser2013 authored May 6, 2020
1 parent 087ac55 commit 67592af
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,38 @@
# Manager for V2 Lighthouses by Valve/HTC
This python script helps you switch your Valve Lighthouses V2 on and into stand-by. Unfortunately, my Pimax 5K XR needs the lighthouses up and running before I turn it on, so the awesome work done by [@mann1x]( https://github.com/mann1x ) in his project [Pimax BS Manager](https://github.com/mann1x/pimax_bs_manager) is of little use to me. This may be different with your particular Pimax HMD.

**Note:** In the meantime, there are binary releases for Windows [here](https://github.com/nouser2013/lighthouse-v2-manager/releases).
## installation (Windows binary release)
1. Create a folder where you want to store the manager's files, e.g. `C:\Program Files\LH-Manager`.
1. Download and copy the files (executable and both icons) from [this repository's releases page](https://github.com/nouser2013/lighthouse-v2-manager/releases) into the target folder from step 1. Depending on the destination, administrative privileges may be required for copying.
1. Make sure your Bluetooth Low-Energy dongle is connected.
1. Open a command prompt and navigate to the folder from step 1, e.g. `C:\Program Files\LH-Manager`. From there, follow the instructions in the chapter "Usage".

## installation & prerequisites
## installation & prerequisites (python script version)
Make sure that you have the following:
* Windows 10, at least 17xx build
* BLE / Bluetooth 4.0 dongle installed and connected (*not* a BGAPI one!)
* Python 3, I used Python 3.8.2
* Pythonnet installation from [here](https://www.lfd.uci.edu/~gohlke/pythonlibs/#pythonnet)
1. download `pythonnet‑2.4.1.dev0‑cp38‑cp38‑win_amd64.whl`
2. `pip3 install pythonnet‑2.4.1.dev0‑cp38‑cp38‑win_amd64.whl`
* bleak installed `pip3 install bleak`
* bleak installed `pip3 install bleak`

## usage with command line arguments
The script provides three usage options: discovery, turning on and switch to standby of a lighthouse V2.

**Note:** if you installed the binary version, simply call the program by executing it. Instead of `python3 .\lighthouse-v2-manager.py` type `lighthouse-v2-manager.exe` in the command prompt window for the commands below.

### display instructions
If you call the executable/script with no command line arguments or with an invalid command, the useage instructions are returned. Choose one of the commands `discover`, `on` or `off` to interact with your Lighthouses V2.

**usage:** `python3 .\lighthouse-v2-manager.py`

### discovery
If you don't call it with any arguments, it tries to open your BLE device and scans for BLE servers in range. Once found, it looks for the service and characteristic which allow for the power-up and power-down of a lighthouse V2. Look for the MAC addresses and the results on stdout.
If you call the program with the `discover` command, it tries to open your BLE device and scans for BLE servers in range. Once found, it looks for the service and characteristic which allow for the power-up and power-down of a lighthouse V2. Look for the MAC addresses and the results on the console output.

Optionally, since version 1.1, you can specify the command line option `-cs` or `--create-shortcuts` with the discovery mode. The script then tries to create suitable shortcuts for your installation and your Lighthouses' MAC addresses. This works with both the script version and the binary stand-alone version.
Optionally, since version 1.1, you can specify the command line option `-cs` or `--create-shortcuts` with the discovery command. The program then tries to create suitable shortcuts for your installation and your Lighthouses' MAC addresses. This works with both the script version and the binary stand-alone version.

**usage:** `python3 .\lighthouse-v2-manager.py [-cs,--create-shortcuts]`
**usage:** `python3 .\lighthouse-v2-manager.py discover [-cs,--create-shortcuts]`

### switch lighthouses into standby
If you want to switch a lighthouse off ("stand-by"), specify either "off" as first argument and then each MAC address consecutively as further arguments like so:
Expand Down

0 comments on commit 67592af

Please sign in to comment.