README.md

virkey

High security multi-purpose Bluetooth Low Energy (BLE) relays.

Main characteristics

• Asymmetric encryption algorithm (libsodium)
• Unlimited users per device.
• Over-the-Air (OTA) firmware updates. The upgrades are transparent through users normal utilization. For example, when users open a garage door they send firmware chunks transparently. When all chunks are received, virkey hardware switches to new firmware version. This feature is crucial to correct potential security or functionality flaws.
• Supports complex time restriction rules.
• Android and iOS app (they are free but not open-source right now).
  • Android
  • iOS

Supported ESP32 boards

• OLIMEX ESP32 EVB

• DIYMALL RELAY32

• TTGO MINI 32

• TTGO T8

• GENERIC A. Generic board using this GPIOs:

  • GPIO 0 <- Factory reset / Boot loader.
  • GPIO 2 -> Status LED.
  • GPIO 32 -> Actuator 0 (Relay 1)
  • GPIO 33 -> Actuator 1 (Relay 2)

  See full details in boards.h and kconfig

Compile

Follow esp-idf install instructions.

Virkey uses version 3.0 of esp-idf. So you must checkout this branch on esp-idf working directory.

git checkout release/v3.0
git submodule update

If you want reproduce the same official binary, you must checkout esp-idf to commit referred in idfver file.

"master" branch points to last stable release. Development unstable code lives in "develop" branch.

Once esp-idf is installed, you must select the right board. On virkey working directory:

$ make menuconfig
--> Component config
    --> Virkey.com config
        --> Board

Compile and flash:

$ make -j4
$ make erase_flash
$ make flash

Execute make monitor after successful flash if you want see virkey's debug output.

Using virkey

After successful flash, launch virkey APP and follow instructions.