MyHwHAL.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#ifndef MyHwHAL_h
#define MyHwHAL_h
 
#define INVALID_INTERRUPT_NUM   (0xFFu)
 
#define MY_HWID_PADDING_BYTE    (0xAAu)
 
#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)
#if defined(ARDUINO_ARCH_ESP8266) && ARDUINO_ESP8266_MAJOR == 3
#define IRQ_HANDLER_ATTR IRAM_ATTR
#else
#define IRQ_HANDLER_ATTR ICACHE_RAM_ATTR
#endif
#else
#define IRQ_HANDLER_ATTR
#endif
 
// Implement these as functions or macros
/*
#define hwInit() MY_SERIALDEVICE.begin(BAUD_RATE)
#define hwWatchdogReset() wdt_reset()
#define hwReboot() wdt_enable(WDTO_15MS); while (1)
#define hwMillis() millis()
 
#define hwDigitalWrite(__pin, __value)
#define hwDigitalRead(__pin)
#define hwPinMode(__pin, __value)
 
void hwReadConfigBlock(void *buf, void *addr, size_t length);
void hwWriteConfigBlock(void *buf, void *addr, size_t length);
void hwWriteConfig(const int addr, uint8_t value);
uint8_t hwReadConfig(const int addr);
*/
 
//#define MY_HW_HAS_GETENTROPY
 
typedef uint8_t unique_id_t[16];
 
int8_t hwSleep(uint32_t ms);
 
int8_t hwSleep(const uint8_t interrupt, const uint8_t mode, uint32_t ms);
 
int8_t hwSleep(const uint8_t interrupt1, const uint8_t mode1, const uint8_t interrupt2,
               const  uint8_t mode2,
               uint32_t ms);
 
bool hwUniqueID(unique_id_t *uniqueID);
 
uint16_t hwCPUVoltage(void);
 
uint16_t hwCPUFrequency(void);
 
int8_t hwCPUTemperature(void);
 
uint16_t hwFreeMem(void);
 
#if defined(DEBUG_OUTPUT_ENABLED)
 
void hwDebugPrint(const char *fmt, ...);
static void hwDebugBuf2Str(const uint8_t *buf, size_t sz) __attribute__((unused));
#endif
 
#ifdef DOXYGEN
#define MY_CRITICAL_SECTION
#define MY_HW_HAS_GETENTROPY
#endif  /* DOXYGEN */
 
#endif // #ifdef MyHw_h