diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index a98b5425..df6b50b9 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -50,18 +50,32 @@ jobs: - name: Checkout uses: actions/checkout@v3 + - name: Show folder content + run: | + pwd + ls -l + + - name: Change to docs folder + run: cd docs + + - name: Show folder content + run: ls -l + - name: Set up Node.js uses: actions/setup-node@v3 with: node-version: 21.x - cache: yarn - cache-dependency-path: './docs/yarn.lock' # THIS PATTERN did the trick for me. + #cache: yarn + #cache-dependency-path: './yarn.lock' # THIS PATTERN did the trick for me. + + - name: Cleanup + run: yarn clear - name: Install dependencies - run: yarn install --cwd ./docs --frozen-lockfile --non-interactive + run: yarn install --frozen-lockfile --non-interactive - name: Build - run: yarn --cwd ./docs build + run: yarn build - name: Setup Pages uses: actions/configure-pages@v1 diff --git a/docs/docs/general/install.md b/docs/docs/general/install.md index ecfcf5a4..2b179d22 100644 --- a/docs/docs/general/install.md +++ b/docs/docs/general/install.md @@ -142,6 +142,61 @@ Place a `venus-data.tar.gz` file in the folder `/var/volatile/tmp/` by copying/u Since driver version `>= v1.0.0` you can also get an overview of the BMS specific settings be checking the end of the [`config.default.ini`](https://github.com/Louisvdw/dbus-serialbattery/blob/master/etc/dbus-serialbattery/config.default.ini). + +### Get BMS MAC address + +Execute this commands to scan for Bluetooth devices and get their MAC address: + +**Command to execute** +```bash +bluetoothctl +``` + +**Output** +``` +Agent registered +[CHG] Controller xx:xx:xx:xx:xx:xx Pairable: yes +``` + +**Command to execute** +```bash +scan on +``` + +**Output** +``` +Discovery started +[CHG] Controller xx:xx:xx:xx:xx:xx Discovering: yes +[CHG] Device xx:xx:xx:xx:xx:xx RSSI: -60 +``` + +**Command to execute** +``` +devices +``` + +**Output with device MAC addresses** +``` +Device xx:xx:xx:xx:xx:xx JK-B2A24S15P +``` + +**Command to execute** +``` +scan off +``` + +**Output** +``` +Discovery stopped +[CHG] Device xx:xx:xx:xx:xx:xx RSSI is nil +[CHG] Controller xx:xx:xx:xx:xx:xx Discovering: no +``` + +**Command to execute** +``` +quit +``` + ## How to change the default limits The driver currently uses a fixed upper current limit for the BMS: