MyTransportHAL.h

/*
 * 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-2022 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.
 *
 * TransportHAL debug log messages:
 *
 * |E| SYS | SUB   | Message                                        | Comment
 * |-|-----|-------|----------------------------|---------------------------------------------------------------------
 * | | THA | INIT  |                                                        | Initialize transportHAL
 * | | THA | INIT  | PSK=%%s                                        | Load PSK for transport encryption (%AES)
 * | | THA | SAD   | ADDR=%%d                                       | Set transport address (ADDR)
 * | | THA | GAD   | ADDR=%%d                                       | Get trnasport address (ADDR)
 * | | THA | DATA  | AVAIL                                          | Message available
 * | | THA | SAN   | RES=%%d                                        | Transport sanity check, result (RES)
 * | | THA | RCV   | MSG=%%s                                        | Receive message (MSG)
 * | | THA | RCV   | DECRYPT                                        | Decrypt received message
 * | | THA | RCV   | PLAIN=%%s                                  | Decrypted message (PLAIN)
 * |!| THA | RCV   | PVER=%%d                                       | Message protocol version (PVER) mismatch
 * |!| THA | RCV   | LEN=%%d,EXP=%%d                        | Invalid message length (LEN), exptected length (EXP)
 * | | THA | RCV   | MSG LEN=%%d                                | Length of received message (LEN)
 * | | THA | SND   | MSG=%%s                                        | Send message (MSG)
 * | | THA | SND   | ENCRYPT                                        | Encrypt message to send (%AES)
 * | | THA | SND   | CIP=%%s                                        | Ciphertext of encypted message (CIP)
 * | | THA | SND   | MSG LEN=%%d,RES=%%d                | Sending message with length (LEN), result (RES)
 *
 *
 */
 
#ifndef MyTransportHAL_h
#define MyTransportHAL_h
 
#define INVALID_SNR         ((int16_t)-256) 
#define INVALID_RSSI        ((int16_t)-256) 
#define INVALID_PERCENT     ((int16_t)-100) 
#define INVALID_LEVEL       ((int16_t)-256) 
 
#if defined(MY_RX_MESSAGE_BUFFER_FEATURE)
#if defined(MY_RADIO_NRF5_ESB)
#error Receive message buffering not supported for NRF5 radio! Please define MY_NRF5_RX_BUFFER_SIZE
#endif
#if defined(MY_RADIO_RFM69)
#error Receive message buffering not supported for RFM69!
#endif
#if defined(MY_RADIO_RFM95)
#error Receive message buffering not supported for RFM95!
#endif
#if defined(MY_RS485)
#error Receive message buffering not supported for RS485!
#endif
#elif defined(MY_RX_MESSAGE_BUFFER_SIZE)
#error Receive message buffering requires message buffering feature enabled!
#endif
 
typedef enum {
    SR_RX_RSSI,            
    SR_TX_RSSI,            
    SR_RX_SNR,             
    SR_TX_SNR,             
    SR_TX_POWER_LEVEL,     
    SR_TX_POWER_PERCENT,   
    SR_UPLINK_QUALITY,     
    SR_NOT_DEFINED         
} signalReport_t;
 
 
bool transportHALInit(void);
void transportHALSetAddress(const uint8_t address);
uint8_t transportHALGetAddress(void);
bool transportHALSend(const uint8_t nextRecipient, const MyMessage *outMsg, const uint8_t len,
                      const bool noACK);
bool transportHALDataAvailable(void);
bool transportHALSanityCheck(void);
bool transportHALReceive(MyMessage *inMsg, uint8_t *msgLength);
void transportHALPowerDown(void);
void transportHALPowerUp(void);
void transportHALSleep(void);
void transportHALStandBy(void);
int16_t transportHALGetSendingRSSI(void);
int16_t transportHALGetReceivingRSSI(void);
int16_t transportHALGetSendingSNR(void);
int16_t transportHALGetReceivingSNR(void);
int16_t transportHALGetTxPowerPercent(void);
bool transportHALSetTxPowerPercent(const uint8_t powerPercent);
int16_t transportHALGetTxPowerLevel(void);
 
#endif // MyTransportHAL_h