ThreadInterface.h

00001 /*
00002  * Copyright (c) 2015 ARM Limited. All rights reserved.
00003  * SPDX-License-Identifier: Apache-2.0
00004  * Licensed under the Apache License, Version 2.0 (the License); you may
00005  * not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00012  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef THREADINTERFACE_H
00018 #define THREADINTERFACE_H
00019 
00020 #include "MeshInterfaceNanostack.h"
00021 
00022 /** Thread mesh network interface class
00023  *
00024  * Configure Nanostack to use Thread protocol.
00025  */
00026 class ThreadInterface : public MeshInterfaceNanostack {
00027 public:
00028 
00029     /** Create an uninitialized LoWPANNDInterface
00030      *
00031      *  Must initialize to initialize the mesh on a phy.
00032      */
00033     ThreadInterface() : MeshInterfaceNanostack() { }
00034 
00035     /** Create an initialized MeshInterface
00036      *
00037      */
00038     ThreadInterface(NanostackRfPhy *phy) : MeshInterfaceNanostack(phy) { }
00039 
00040     nsapi_error_t initialize(NanostackRfPhy *phy);
00041 
00042     /**
00043      * \brief Sets the eui64 for the device configuration.
00044      * By default this value is read from the radio driver.
00045      * The value must be set before calling the connect function.
00046      * */
00047     void device_eui64_set(const uint8_t *eui64);
00048 
00049     /**
00050      * \brief sets the PSKd for the device configuration.
00051      * The default value is overwritten, which is defined in the mbed_lib.json file in the mesh-api
00052      * The value must be set before calling the connect function.
00053      * \return MESH_ERROR_NONE on success.
00054      * \return MESH_ERROR_PARAM in case of illegal parameters.
00055      * \return MESH_ERROR_MEMORY in case of memory error.
00056      * */
00057 
00058     mesh_error_t device_pskd_set(const char *pskd);
00059 
00060     virtual int connect();
00061     virtual int disconnect();
00062 private:
00063     /*
00064      * \brief Initialization of the interface.
00065      * \return MESH_ERROR_NONE on success.
00066      * \return MESH_ERROR_PARAM when input parameters are illegal (also in case when RF device is already associated to other interface)
00067      * \return MESH_ERROR_MEMORY in case of memory error
00068      * \return MESH_ERROR_UNKNOWN in other error cases
00069      */
00070     mesh_error_t init();
00071     /**
00072      * \brief Connect interface to the mesh network
00073      * \return MESH_ERROR_NONE on success.
00074      * \return MESH_ERROR_PARAM in case of illegal parameters.
00075      * \return MESH_ERROR_MEMORY in case of memory error.
00076      * \return MESH_ERROR_STATE if interface is already connected to network.
00077      * \return MESH_ERROR_UNKNOWN in case of unspecified error.
00078      * */
00079     mesh_error_t mesh_connect();
00080 
00081     /**
00082      * \brief Disconnect interface from the mesh network
00083      * \return MESH_ERROR_NONE on success.
00084      * \return MESH_ERROR_UNKNOWN in case of error.
00085      * */
00086     mesh_error_t mesh_disconnect();
00087 
00088     /**
00089      * \brief Read own global IP address
00090      *
00091      * \param address is where the IP address will be copied
00092      * \param len is the length of the address buffer, must be at least 40 bytes
00093      * \return true if address is read successfully, false otherwise
00094      */
00095     virtual bool getOwnIpAddress(char *address, int8_t len);
00096 };
00097 
00098 #endif // THREADINTERFACE_H