examples/common/chip-app-server/include/QRCodeUtil.h

   1 /*
   2  *    Copyright (c) 2020 Project CHIP Authors
   3  *    All rights reserved.
   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 #pragma once
  19
  20 #include <setup_payload/SetupPayload.h>
  21
  22 void PrintQRCode(chip::RendezvousInformationFlags rendezvousFlags);
  23 CHIP_ERROR GetQRCode(uint32_t & setupPinCode, std::string & QRCode, chip::RendezvousInformationFlags rendezvousFlags);
  24
  25 /**
  26  * Initialize DataModelHandler and start CHIP datamodel server, the server
  27  * assumes the platform's networking has been setup already.
  28  *
  29  * Method verifies if every character of the QR Code is valid for the url encoding
  30  * and otherwise it encodes the invalid character using available ones.
  31  *
  32  * @param QRCode address of the array storing QR Code to encode.
  33  * @param len length of the given QR Code.
  34  * @param url address of the location where encoded url should be stored.
  35  * @param maxSize maximal size of the array where encoded url should be stored.
  36  * @return CHIP_NO_ERROR on success and other values on error.
  37  */
  38 CHIP_ERROR EncodeQRCodeToUrl(const char * QRCode, size_t len, char * url, size_t maxSize);