Skip to content

Latest commit

 

History

History
183 lines (152 loc) · 9.4 KB

GETTING_STARTED.md

File metadata and controls

183 lines (152 loc) · 9.4 KB
Raw

Getting Started

If you have received or built a ZSWatch there are a few things you need to know before starting.

  1. On the dock v1 Rev 1 the watch connector is rotated 180 degrees. Meaning you need to connect the watch 180 degree rotated (see image below).
  2. Be careful when connecting the watch to the dock.
    • Check orientation.
    • Check that the pins are not "offsetted".

Note the usage for the dock v1 Rev1.

Setting up the environment

Download and install the tools needed for flashing.

Don't forget to set the group policies to allow the execution of local scripts when using Windows and a virtual environment for Zephyr. Otherwise the Zephyr installation fails. Open a power shell as administrator and run set-executionpolicy remotesigned to change it.

Set up toolchain and everything by following Zephyr/nRF Connect Getting Started Guide. At this point it's not possible to use nRF Connect SDK as features and fixes not yet released in NCS are needed to build ZSWatch SW.

Cloning source code

git clone https://github.com/jakkra/ZSWatch.git
cd ZSWatch/
git submodule update --init --recursive
cd app
west init -l .
west update

Use Bosch BSEC2

To use the air quality features of the BME688 the Bosch BSEC2 binaries needs to be downloaded, this is optional.
By downloading (running below commands) you approve this License

west config manifest.group-filter +bsec2
west update

To enable the feature add below to prj.conf or build with boards/bsec.conf or use Kconfig to enable it.

CONFIG_BME680=n
CONFIG_EXTERNAL_USE_BOSCH_BSEC=y

Building and Flashing

There are two approaches to deal with Zephyr based projects:

Compiling

Using the command line

  • Set revision zswatch_nrf5340_cpuapp@<revision> to 1 or 3 depending on what version of ZSWatch is used. If your watch is built before Aug. 1 2023 it's revision 1, otherwise revision 3 or later.
  • Replace release.conf with debug.conf if the build is for development.

Example of building for ZSWatch board:

west build --board zswatch_nrf5340_cpuapp@3 -- -DOVERLAY_CONFIG="boards/release.conf"
west flash

Using the nRF Connect extension for VSCode

To be able to build, flash and debug via VSCode please install nRF Connect for VS Code Extension Pack.
Here you can also find a manual on how to deal with the nRF Connect extension. Follow the steps below to open and build the ZSWatch application:

  • Open the ZSWatch root folder in VSCode (important it's the root and not app folder), the the nRF Connect plugin will automatically see the app.
  • Press Create new build configuration and fill in zswatch board, revision, and any config files wanted, for example debug.conf.
  • Now press the Build Configuration button and it will compile.

Getting image resources into the watch

Many images and icons are placed in external flash and not uploaded when flashing the watch.
To upload the image resources into the external flash following needs to be done.

In VSCode: Ctrl + shift + p -> Tasks: Run task -> Upload Raw FS
Or run west upload_fs

Running and developing the ZSWatch SW without the actual ZSWatch HW

Depending on preference and available hardware, three options can be chosen:

  1. Native Posix
  2. Native Posix + dev kit dongle
  3. nRF5340 dev kit

1. Native Posix

This option applicable if you host computer hardware have build-in bluetooth module and your host machine is Linux. This option does not require any hardware at all sine Zephyr support BlueZ(details) and also can emulate display peripheral.

Preparation

The "Display driver" emulator need to be installed (Learn more about nativ_posix peripherals):

sudo apt-get install pkg-config libsdl2-dev:i386
export PKG_CONFIG_PATH=/usr/lib/i386-linux-gnu/pkgconfig

To execute ZSWatch application on native posix fist make sure that you have required version of linux kernel and BlueZ.
Find a HCI index on your host using: sudo hcitool dev this is needed later. Usually hci0 for internal and hci1 fo external HCI.

Running ZSWatch app

To build ZSWatch application for native posix simply run:

cd <ZSWatch path>/app
west build -b native_posix
sudo btmgmt --index <hci index> power off
sudo ./build/zephyr/zephyr.exe --bt-dev=hci<hci_index>

Tips:

  1. If you want to be able to debug: sudo gdb -ex=r --args build/zephyr/zephyr.exe --bt-dev=hci<hci index> or add below in your .vscode/launch.json
{
	"version": "0.2.0",
	"configurations": [
		{
            "name": "Debug Native Posix",
            "type": "gdb",
            "request": "launch",
            "target": "${workspaceFolder}/build/zephyr/zephyr.exe",
            "cwd": "${workspaceRoot}",
            "valuesFormatting": "parseText",
            "arguments": "--bt-dev=hci0" // Fill in hciX
        }
	]
}

2. Native Posix + dev-kit dongle

In case there is no built-in Bluetooth module on the host computer, an external nRF dev kit can be used as a BLE module. In fact, any external BLE module that supports the HCI interface can be used. In doing so, the application will run on the host machine and communicate with BLE controller over hci_usb/hci_uart depending on the hardware you have.

Preparation

Compile and flash the zephyr/samples/bluetooth/hci_usb application with following additions to prj.conf:

CONFIG_BT_EXT_ADV=y
CONFIG_BT_PER_ADV=y
CONFIG_BT_PER_ADV_SYNC=y
CONFIG_BT_PER_ADV_SYNC_MAX=2

NOTE: If hci_uart is used, a new HCI port must be attached, follow this guide. Alternatively in case of using hci_usb you don't need to attach new HCI port, just physically connect USB to nRF USB port.

Make sure that new hci device appear using: sudo hcitool dev

Next follow the Preparation to install the "Display driver" emulator and the Running ZSWatch app instruction to execute the application.

3. nRF5340 dev kit

This is possible, what you need is a nRF5340-DK (or EVK-NORA-B1) and a breakout of the screen I use https://www.waveshare.com/1.28inch-touch-lcd.htm.
You may also add any of the sensors on the ZSWatch, Sparkfun for example have them all:
BMI270 BME688 BMP581 LIS2MDL

When using the nRF5340-DK all you need to do is to replace zswatch_nrf5340_cpuapp with nrf5340dk_nrf5340_cpuapp as the board in the compiling instructions above. You may also need to tweak the pin assignment in app/boards/nrf5340dk_nrf5340_cpuapp.overlay for your needs.

Getting Gadgetbridge setup

Install the Android app GadgetBridge or from Play Store here

  • In Gadgetbridge press plus button to add ZSWatch
  • Enable "Discover unsupported devices" option and set "Scanning intensity" to maximum in "Discover and pair options"
  • It will scan and you should see a device called ZSWatch, long press it.
  • Select in the dropdown Bangle.js as the device.

Pairing

To get communication with your phone working you need to pair ZSWatch.

  • In ZSWatch go to Settings -> Bluetooth -> Enable pairing.
  • Now go reconnect to the watch from Gadgetbridge app.
  • You should now be paired and a popup should be seen on ZSWatch.

Weather

To get weather working follow the instructions here.