src/include/platform/internal/DeviceNetworkProvisioning.h

   1 /*
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *
   5  *    Licensed under the Apache License, Version 2.0 (the "License");
   6  *    you may not use this file except in compliance with the License.
   7  *    You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *    Unless required by applicable law or agreed to in writing, software
  12  *    distributed under the License is distributed on an "AS IS" BASIS,
  13  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *    See the License for the specific language governing permissions and
  15  *    limitations under the License.
  16  */
  17
  18 /**
  19  *    @file
  20  *      This file defines the CHIP Device Network Provisioning object.
  21  *
  22  */
  23
  24 #pragma once
  25
  26 #include <core/CHIPCore.h>
  27 #include <platform/internal/DeviceNetworkInfo.h>
  28
  29 namespace chip {
  30 namespace DeviceLayer {
  31 namespace Internal {
  32
  33 class DLL_EXPORT DeviceNetworkProvisioningDelegate
  34 {
  35 public:
  36     /**
  37      * @brief
  38      *   Called to provision WiFi credentials in a device
  39      *
  40      * @param ssid WiFi SSID
  41      * @param passwd WiFi password
  42      */
  43     virtual CHIP_ERROR ProvisionWiFi(const char * ssid, const char * passwd) = 0;
  44
  45     /**
  46      * @brief
  47      *   Called to provision Thread credentials in a device
  48      *
  49      */
  50     virtual CHIP_ERROR ProvisionThread(DeviceLayer::Internal::DeviceNetworkInfo & threadData) = 0;
  51
  52     virtual ~DeviceNetworkProvisioningDelegate() {}
  53 };
  54
  55 } // namespace Internal
  56 } // namespace DeviceLayer
  57 } // namespace chip