Misc

Add tutorials
Bump version to v0.2

Qt/android/AndroidManifest.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<manifest package="io.github.wh201906.medifier.qt" xmlns:android="http://schemas.android.com/apk/res/android" android:versionName="v0.1" android:versionCode="10" android:installLocation="auto">
+<manifest package="io.github.wh201906.medifier.qt" xmlns:android="http://schemas.android.com/apk/res/android" android:versionName="v0.2" android:versionCode="20" android:installLocation="auto">
     <!-- The following comment will be replaced upon deployment with default permissions based on the dependencies of the application.
          Remove the comment if you do not require these default permissions. -->
 

Qt/mEDIFIER.pro

@@ -54,7 +54,7 @@ DISTFILES += \
     android/AndroidManifest.xml
 
 # Remember to change version in AndroidManifest.xml
-VERSION = 0.1.0
+VERSION = 0.2.0
 # Expose VERSION to the source files.
 DEFINES += APP_VERSION=\\\"$$VERSION\\\"
 QMAKE_TARGET_PRODUCT = "mEDIFIER"

README.md

@@ -1,24 +1,34 @@
 # mEDIFIER
+
+[中文](./README_zh_CN.md)  
+An open-source alternative to the Edifier Connect app  
 I just don't know why the Edifier Connect takes up more than 200MB on my phone.  
 
 # Pros
 + Smaller  
-  (Android: ~2MB, Qt(Android): ~9MB, Qt(PC): ~30MB)  
+  (Android: ~9MB, PC: ~30MB)  
 + No Internet is required  
 + Less click on the physical buttons  
 + Cross-platform  
++ Switch connection between Bluetooth hosts(Android only)  
++ Export settings to file
++ Restore settings from file
 
 # Cons
 + Tested on W820NB Double Gold and W200BT Plus only  
   (Maybe works for W820NB Plus and W820NB somehow)  
-+ The BLE connection on Windows is not convenient  
++ The BLE connection on Windows doesn't work  
 + Sending raw commands to your device might break it  
 
 # Previews
 (All versions have both English And Simplified Chinese interfaces)
-| Android | Qt(Android) | Qt(PC) |  
-| --- | --- | --- |  
-| ![preview](doc/preview_android.jpg) | ![preview](doc/preview_qt_android.jpg) | ![preview](doc/preview_qt_pc.jpg) |  
+| Android | PC |  
+| --- | --- |  
+| ![preview](doc/preview_qt_android.jpg) | ![preview](doc/preview_qt_pc.jpg) |  
 
 # Download
 [GitHub Releases](https://github.com/wh201906/mEDIFIER/releases)
+
+# Tutorials
+1. [Connect to device](./doc/tutorials/connect.md)
+2. [Switch connection between Bluetooth hosts](./doc/tutorials/switch_host.md)

README_zh_CN.md

@@ -0,0 +1,34 @@
+# mEDIFIER
+
+[English](./README.md)  
+官方漫步者APP的开源替代版  
+更小更轻便  
+
+# 优点
++ 体积小  
+  (Android: ~9MB, PC: ~30MB)  
++ 不联网  
++ 减少按键次数，避免磨损  
++ 跨平台  
++ 快速切换蓝牙主机（仅限Android端）  
++ 导出设置到文件
++ 从文件导入设置
+
+# 缺点
++ 仅测试过 W820NB双金标版 和 W200BT Plus  
+  (也许能用在 W820NB Plus 和 W820NB 上)  
++ 在Windows端BLE连接几乎不可用  
++ 发送原始指令有可能损坏设备  
+
+# 预览图
+(所有版本均包含中文和英文界面)
+| Android | PC |  
+| --- | --- |  
+| ![preview](doc/preview_qt_android.jpg) | ![preview](doc/preview_qt_pc.jpg) |  
+
+# 下载
+[GitHub Releases](https://github.com/wh201906/mEDIFIER/releases)  
+
+# 教程
+1. [连接设备](./doc/tutorials/connect_zh_CN.md)  
+2. [快速切换蓝牙主机](./doc/tutorials/switch_host_zh_CN.md)  

doc/tutorials/connect.md

@@ -0,0 +1,65 @@
+# Connect to device
+
+[中文](./connect_zh_CN.md)  
+## Windows
+### RFCOMM (preferred)
+
+1. Pair your device in system settings
+2. Make sure your device is not connected to other Bluetooth host  
+(Disconnected or connected to the host you are using)
+3. Open this app
+4. Go to `Device` panel
+5. Click `Search RFCOMM`, wait until your device name appears
+6. Click your device name in the list, the MAC address at the bottom will be updated
+7. Click `Connect`
+8. Go to `Generic Device` panel after `Device Connected` is shown at the bottom
+9. (Optional) Click `Read Settings` to sync settings from device
+
+### BLE (not recommended)
+It's nearly impossible to connect to device on Windows using BLE due to the limitation in Qt API and the randomized Bluetooth MAC addresses on some devices. However, you could still try these steps if you want.
+
+1. Pair your device in system settings
+2. Make sure your device is connected to any Bluetooth host, but not controlled by other Edifier Connect app or mEDIFIER app  
+3. Remove all devices named `EDIFIER BLE` in the system settings
+4. Connect to the device named `EDIFIER BLE` in the system settings  
+(This might fail for some devices)
+5. Open this app
+6. Go to `Device` panel
+7. Click `Search BLE`, wait for a while
+8. Click the device named `EDIFIER BLE`, the MAC address at the bottom will be updated
+9. Click `Connect`
+10. Go to `Generic Device` panel after `Device Connected` is shown at the bottom
+11. (Optional) Click `Read Settings` to sync settings from device
+
+## Android
+### RFCOMM
+
+1. Pair your device in system settings
+2. Make sure your device is not connected to other Bluetooth host  
+(Disconnected or connected to the host you are using)
+3. Open this app
+4. Go to `Device` panel
+5. Click `Search RFCOMM`, wait until your device name appears
+6. Click your device name in the list, the MAC address at the bottom will be updated
+7. Click `Connect`
+8. Go to `Generic Device` panel after `Device Connected` is shown
+9. (Optional) Click `Read Settings` to sync settings from device
+
+### BLE (preferred)
+
+1. Pair your device in system settings
+2. Make sure your device is connected to any Bluetooth host, but not controlled by other Edifier Connect app or mEDIFIER app  
+3. Open this app
+4. Go to `Device` panel
+5. Click `Search BLE`, wait for a while
+6. Click the device named `EDIFIER BLE`, the MAC address at the bottom will be updated
+7. Click `Connect`
+8. Go to `Generic Device` panel after `Device Connected` is shown
+9. (Optional) Click `Read Settings` to sync settings from device
+
+## Linux & macOS
+This app theoretically works on Linux and macOS, but I don't have the environments to test it. You could try the steps for Windows and Android above.
+
+## Connect without searching
+It's possible to connect to a paired device without searching.  
+This app remembers the MAC address and the connection type you used last time. You can try to click `Connect` without searching. It works sometimes.

doc/tutorials/connect_zh_CN.md

@@ -0,0 +1,64 @@
+# 连接设备
+
+[English](./connect.md)  
+## Windows
+### RFCOMM (推荐)
+
+1. 在系统设置中配对您的设备
+2. 确保您的设备没有连接到其它主机  
+(未连接或已连接到当前主机)
+3. 打开App
+4. 进入`设备`面板
+5. 点击`搜索RFCOMM设备`，等待您的设备出现在列表中
+6. 点击列表中的设备名，下方的MAC地址将会相应改变
+7. 点击`连接`
+8. 当底部显示`设备已连接`后进入`通用设备`面板
+9. （可选） 点击`读取设置`，从设备加载设置
+
+### BLE (不推荐)
+由于Qt API的局限性以及某些设备随机化MAC地址的特性，在Windows上难以通过BLE连接到设备。以下步骤仅供参考。
+
+1. 在系统设置中配对您的设备
+2. 确保您的设备已经连上任一主机，但是没有被Edifier Connect或者mEDIFIER控制
+3. 在系统设置中移除所有名为`EDIFIER BLE`的设备
+4. 在系统设置中连接到名为`EDIFIER BLE`的设备  
+(这一步可能会失败)
+5. 打开App
+6. 进入`设备`面板
+7. 点击`搜索BLE设备`，稍等片刻
+8. 点击名为`EDIFIER BLE`的设备，下方的MAC地址将会相应改变
+9. 点击`连接`
+10. 当底部显示`设备已连接`后进入`通用设备`面板
+11. （可选） 点击`读取设置`，从设备加载设置
+
+## Android
+### RFCOMM
+
+1. 在系统设置中配对您的设备
+2. 确保您的设备没有连接到其它主机  
+(未连接或已连接到当前主机)
+3. 打开App
+4. 进入`设备`面板
+5. 点击`搜索RFCOMM设备`，等待您的设备出现在列表中
+6. 点击列表中的设备名，下方的MAC地址将会相应改变
+7. 点击`连接`
+8. 当显示`设备已连接`后进入`通用设备`面板
+9. （可选） 点击`读取设置`，从设备加载设置
+
+### BLE (推荐)
+
+1. 在系统设置中配对您的设备
+2. 确保您的设备已经连上任一主机，但是没有被Edifier Connect或者mEDIFIER控制
+3. 打开App
+4. 进入`设备`面板
+5. 点击`搜索BLE设备`，稍等片刻
+6. 点击名为`EDIFIER BLE`的设备，下方的MAC地址将会相应改变
+7. 点击`连接`
+8. 当显示`设备已连接`后进入`通用设备`面板
+9. （可选） 点击`读取设置`，从设备加载设置
+
+## Linux & macOS
+理论上此app可以在Linux和macOS上运行，但我没有测试过。您可以参考上面的步骤试一下。
+
+## 免搜索直接连接
+此app会保存您上次使用的MAC地址和连接类型。您可以尝试不搜索直接点击`连接`按钮来连接设备，有些情况下能连上。

doc/tutorials/switch_host.md

@@ -0,0 +1,20 @@
+# Switch connection between Bluetooth hosts
+
+[中文](./switch_host_zh_CN.md)  
+Sometimes you might need to switching the audio connection between two paired hosts. Typically, it requires these steps:  
+
+1. Long-press the "pairing" button on your device  
+2. Connect to the device in system settings, which needs a few clicks  
+
+These steps take some time, and wear your "pairing" button gradually.  
+I found that the some of the devices can be connected to one host for audio, then be controlled by the other host using BLE. According to this interesting feature, I wrote some code to simplify the switching process. Now you can switch the audio connection to an Android host in the mEDIFIER app.  
+
+# Steps (for Android only)
+
+1. Open this app  
+2. [Connect to your device in mEDIFIER](./connect.md), using BLE  
+3. Go to the device panel  
+4. Click `Connect Audio`  
+
+It's possible to switch the audio connection in 4 clicks:  
+Open mEDIFIER -> Click `Connect`(Connect without searching) -> Go to device panel -> Click `Connect Audio`  

doc/tutorials/switch_host_zh_CN.md

@@ -0,0 +1,20 @@
+# 快速切换蓝牙主机
+
+[English](./switch_host.md)  
+有时您可能需要在两台主机之间切换音频连接，通常需要以下步骤：  
+
+1. 长按设备上的“配对”键  
+2. 点几下屏幕，在系统设置中连上设备  
+
+以上步骤耗时略长，并且会逐渐磨损配对键。  
+我偶然发现一些设备在连上某台主机作音乐设备时还能被另一台主机通过BLE连接所控制。基于此，我设计了快速切换的功能，在Android端可以强行把音频切换到连到mEDIFIER运行的主机上。  
+
+# 步骤 (仅限Android)
+
+1. 打开App  
+2. [在mEDIFIER中用BLE连上设备](./connect.md)  
+3. 进入设备面板  
+4. 点击`连接音频`  
+
+理想状况下切换音频连接只需要点4下：  
+打开mEDIFIER -> 点击`连接`(免搜索直接连接)->进入设备面板->点击`连接音频`