examples/lighting-app/qpg6100/APPLICATION.md

   1 # CHIP QPG6100 Lighting 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 ## Lighting-app
  10
  11 The QPG6100 Lighting-app shows an implementation of a Lighting device, based on
  12 CHIP\
  13 and the Qorvo QPG6100 SDK. Intention of this example is to demonstrate a CHIP\
  14 device, with Thread connectivity, using BLE to perform CHIP provisioning.
  15
  16 ## Lighting-app button control
  17
  18 This application uses following buttons of the DK board:
  19
  20 -   SW1: Used to toggle the light between two levels
  21 -   SW2: Used to perform a HW reset for the full board
  22 -   SW4: Used to toggle the off/on state of the simulated light
  23 -   SW5: Used to perform, depending on the time the button is kept pressed,
  24     -   Software update - not yet supported (released before 3s)
  25     -   Trigger Thread joining (release after 3s)
  26     -   Factory reset (released after 6s)
  27
  28 Unused:
  29
  30 -   SW3 - slider switch
  31
  32 ## LED output
  33
  34 The following LEDs are used during the application:
  35
  36 -   LD2 - GRN led:
  37     -   Short blink every 1s: BLE advertising
  38     -   Fast blinks: BLE connected and subscribed
  39     -   Short off: Thread connected
  40     -   On: Full service connectivity
  41 -   LD3 - WHT led:
  42     -   Off: Light is off
  43     -   Dim: Light is set to low level
  44     -   Bright: Light is set to high level
  45
  46 ## Logging Output
  47
  48 -   See
  49     [View Logging Output](../../platform/qpg6100/README.md#view-logging-output)
  50 -   At startup you will see:
  51
  52 ```
  53 qvCHIP v0.0.0.0 (CL:155586) running
  54 [P][-] Init CHIP Stack
  55 [P][DL] BLEManagerImpl::Init() complete
  56 [P][-] Starting Platform Manager Event Loop
  57 [P][-] ============================
  58 [P][-] Qorvo Lighting-app Launching
  59 [P][-] ============================
  60 [D][DL] CHIP task running
  61 ```
  62
  63 -   Note! Logging is currently encapsulated by the Qorvo logging module. Output\
  64     will have additional header and footer bytes. This will be updated later\
  65     into a raw stream for any serial terminal to parse.