src/platform/nrfconnect/README.md

   1 # Overview of CHIP nRF Connect Adaption
   2
   3 The following is a quick overview of the nRF Connect adaptation of CHIP. Most of
   4 this code will have parallels in any new adaptation.
   5
   6 (All file names are relative to `connectedhomeip/src/...`).
   7
   8 `include/platform/nrfconnect/PlatformManagerImpl.h`
   9
  10 -   Uses Zephyr platform implementation of PlatformManager interface.
  11
  12 `include/platform/nrfconnect/ConfigurationManagerImpl.h`
  13
  14 -   Uses Zephyr platform implementation of ConfigurationManager interface.
  15
  16 `include/platform/nrfconnect/ConnectivityManagerImpl.h`<br>`nrfconnect/ConnectivityManagerImpl.cpp`
  17
  18 -   Concrete implementation of ConnectivityManager interface
  19 -   Provides high-level APIs for managing device connectivity
  20 -   Relies on various generic implementation classes to provide API
  21     functionality
  22 -   Very much a work-in-progress in the nrfconnect branch
  23
  24 `include/platform/nrfconnect/DeviceNetworkProvisioningDelegateImpl.h`<br>`nrfconnect/DeviceNetworkProvisioningDelegateImpl.cpp`
  25
  26 -   Concrete implementation of DeviceNetworkProvisioningDelegate interface
  27 -   Provides high-level APIs for managing network provisioning
  28
  29 `include/platform/nrfconnect/ThreadStackManagerImpl.h`
  30
  31 -   Uses Zephyr platform implementation of ThreadStackManager interface.
  32
  33 `include/platform/nrfconnect/BLEManagerImpl.h`
  34
  35 -   Uses Zephyr platform implementation of BLEManager interface.
  36
  37 `include/platform/nrfconnect/CHIPDevicePlatformEvent.h`
  38
  39 -   Uses Zephyr platform definitions of platform-specific event types and data
  40     for the chip Device Layer.