apidocs/MyTransport_8h_source.html

/*

 * The MySensors Arduino library handles the wireless radio link and protocol

 * between your home built sensors/actuators and HA controller of choice.

 * The sensors forms a self healing radio network with optional repeaters. Each

 * repeater and gateway builds a routing tables in EEPROM which keeps track of the

 * network topology allowing messages to be routed to nodes.

 *

 * Created by Henrik Ekblad <[email protected]>

 * Copyright (C) 2013-2019 Sensnology AB

 * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors

 *

 * Documentation: http://www.mysensors.org

 * Support Forum: http://forum.mysensors.org

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * version 2 as published by the Free Software Foundation.

 */


#ifndef MyTransport_h

#define MyTransport_h


#include "hal/transport/MyTransportHAL.h"


#ifndef MY_TRANSPORT_MAX_TX_FAILURES

#if defined(MY_REPEATER_FEATURE)

#define MY_TRANSPORT_MAX_TX_FAILURES    (10u)

#else

#define MY_TRANSPORT_MAX_TX_FAILURES    (5u)

#endif

#endif


#ifndef MY_TRANSPORT_MAX_TSM_FAILURES

#define MY_TRANSPORT_MAX_TSM_FAILURES       (7u)

#endif


#ifndef MY_TRANSPORT_TIMEOUT_FAILURE_STATE_MS

#define MY_TRANSPORT_TIMEOUT_FAILURE_STATE_MS       (10*1000ul)

#endif

#ifndef MY_TRANSPORT_TIMEOUT_EXT_FAILURE_STATE_MS

#define MY_TRANSPORT_TIMEOUT_EXT_FAILURE_STATE_MS   (60*1000ul)

#endif

#ifndef MY_TRANSPORT_STATE_TIMEOUT_MS

#define MY_TRANSPORT_STATE_TIMEOUT_MS           (2*1000ul)

#endif

#ifndef MY_TRANSPORT_CHKUPL_INTERVAL_MS

#define MY_TRANSPORT_CHKUPL_INTERVAL_MS         (10*1000ul)

#endif

#ifndef MY_TRANSPORT_STATE_RETRIES

#define MY_TRANSPORT_STATE_RETRIES              (3u)

#endif


#define AUTO                                    (255u)

#define BROADCAST_ADDRESS           (255u)

#define DISTANCE_INVALID            (255u)

#define MAX_HOPS                            (254u)

#define INVALID_HOPS                    (255u)

#define MAX_SUBSEQ_MSGS             (5u)

#define UPLINK_QUALITY_WEIGHT   (0.05f)


// parent node check

#if defined(MY_PARENT_NODE_IS_STATIC) && !defined(MY_PARENT_NODE_ID)

#error MY_PARENT_NODE_IS_STATIC but no MY_PARENT_NODE_ID defined!

#endif


#define _autoFindParent (bool)(MY_PARENT_NODE_ID == AUTO)

#define isValidDistance(_distance) (bool)(_distance!=DISTANCE_INVALID)

#define isValidParent(_parent) (bool)(_parent != AUTO)


typedef void(*transportCallback_t)(void);


typedef struct {

    uint8_t nodeId;

    uint8_t parentNodeId;

    uint8_t distanceGW;

    uint8_t passiveMode : 1;

    uint8_t reserved : 7;

} transportConfig_t;


typedef struct {

    void(*Transition)(void);

    void(*Update)(void);

} transportState_t;

typedef int16_t transportRSSI_t;


// helper macro for conversion

#define transportInternalToRSSI(__value)    ((int16_t)__value >> 4)

#define transportRSSItoInternal(__value)    ((transportRSSI_t)__value << 4)


typedef struct {

    // SM variables

    transportState_t *currentState;

    uint32_t stateEnter;

    // general transport variables

    uint32_t lastUplinkCheck;

    // 8 bits

    bool findingParentNode : 1;

    bool preferredParentFound : 1;

    bool uplinkOk : 1;

    bool pingActive : 1;

    bool transportActive : 1;

    uint8_t stateRetries : 3;

    // 8 bits

    uint8_t failedUplinkTransmissions : 4;

    uint8_t failureCounter : 3;

    bool msgReceived : 1;

    uint8_t pingResponse;

#if defined(MY_SIGNAL_REPORT_ENABLED)

    transportRSSI_t uplinkQualityRSSI;

#endif

} transportSM_t;


typedef struct {

    uint8_t route[SIZE_ROUTES];

} routingTable_t;


// PRIVATE functions


void stInitTransition(void);

void stInitUpdate(void);

void stParentTransition(void);

void stParentUpdate(void);

void stIDTransition(void);

void stIDUpdate(void);

void stUplinkTransition(void);

void stUplinkUpdate(void);

void stReadyTransition(void);

void stReadyUpdate(void);

void stFailureTransition(void);

void stFailureUpdate(void);

void transportSwitchSM(transportState_t &newState);

void transportUpdateSM(void);

uint32_t transportTimeInState(void);

void transportInvokeSanityCheck(void);

void transportProcessFIFO(void);

void transportProcessMessage(void);

bool transportAssignNodeID(const uint8_t newNodeId);

bool transportWait(const uint32_t waitingMS, const uint8_t cmd, const uint8_t msgType);

uint8_t transportPingNode(const uint8_t targetId);

bool transportRouteMessage(MyMessage &message);

bool transportSendRoute(MyMessage &message);

bool transportSendWrite(const uint8_t to, MyMessage &message);

bool transportCheckUplink(const bool force = false);


// PUBLIC functions


bool transportWaitUntilReady(const uint32_t waitingMS = 0);

void transportInitialise(void);

void transportProcess(void);

bool isTransportReady(void);

bool isTransportSearchingParent(void);

bool isTransportExtendedFailure(void);

bool isMessageReceived(void);

void resetMessageReceived(void);

void transportClearRoutingTable(void);

uint32_t transportGetHeartbeat(void);

void transportLoadRoutingTable(void);

void transportSaveRoutingTable(void);

void transportSetRoute(const uint8_t node, const uint8_t route);

uint8_t transportGetRoute(const uint8_t node);

void transportReportRoutingTable(void);

uint8_t transportGetNodeId(void);

uint8_t transportGetParentNodeId(void);

uint8_t transportGetDistanceGW(void);

void transportTogglePassiveMode(const bool OnOff);

void transportDisable(void);

void transportReInitialise(void);


int16_t transportSignalReport(const char command) __attribute__((unused));


int16_t transportGetSignalReport(const signalReport_t signalReport) __attribute__((unused));


#endif // MyTransport_h