examples/lock-app/qpg6100/APPLICATION.md

   1 # CHIP QPG6100 Lock Example Application
   2
   3 An example application showing the use
   4 [CHIP](https://github.com/project-chip/connectedhomeip) on the Qorvo QPG6100.
   5
   6 More detailed information to be included in
   7 [SDK Documentation](../../platform/qpg6100/README.md).
   8
   9 ## Lock-app button control
  10
  11 This application uses following buttons of the DK board:
  12
  13 -   SW2: Used to perform a HW reset for the full board
  14 -   SW4: Used to toggle the Unlock/Lock the simulated lock
  15 -   SW5: Used to perform, depending on the time the button is kept pressed,
  16     -   Software update - not yet supported (released before 3s)
  17     -   Trigger Thread joining (release after 3s)
  18     -   Factory reset (released after 6s)
  19
  20 Unused:
  21
  22 -   SW1
  23 -   SW3 - slider switch
  24
  25 ## LED output
  26
  27 The following LEDs are used during the application:
  28
  29 -   LD1 - RED led: Status LED simulating the lock state
  30     -   On - lock closed
  31     -   Off - lock open
  32     -   Blinking - lock moving to new state
  33 -   LD2 - GRN led:
  34     -   Short blink every 1s: BLE advertising
  35     -   Fast blinks: BLE connected and subscribed
  36     -   Short off: Thread connected
  37     -   On: Full service connectivity
  38
  39 ## Logging Output
  40
  41 -   See
  42     [View Logging Output](../../platform/qpg6100/README.md#view-logging-output)
  43 -   At startup you will see:
  44
  45 ```
  46 qvCHIP v0.0.0.0 (CL:155586) running
  47 [P][-] Init CHIP Stack
  48 [P][DL] BLEManagerImpl::Init() complete
  49 [P][-] Starting Platform Manager Event Loop
  50 [P][-] ============================
  51 [P][-] Qorvo Lock-app Launching
  52 [P][-] ============================
  53 [D][DL] CHIP task running
  54 ```
  55
  56 -   Note! Logging is currently encapsulated by the Qorvo logging module.
  57     Output
  58     will have additional header and footer bytes. This will be updated later
  59     into a raw stream for any serial terminal to parse.