Cleaned up Doxygen include graphs
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
/**
|
/*
|
||||||
* The MySensors Arduino library handles the wireless radio link and protocol
|
* The MySensors Arduino library handles the wireless radio link and protocol
|
||||||
* between your home built sensors/actuators and HA controller of choice.
|
* between your home built sensors/actuators and HA controller of choice.
|
||||||
* The sensors forms a self healing radio network with optional repeaters. Each
|
* The sensors forms a self healing radio network with optional repeaters. Each
|
||||||
@@ -16,13 +16,30 @@
|
|||||||
* modify it under the terms of the GNU General Public License
|
* modify it under the terms of the GNU General Public License
|
||||||
* version 2 as published by the Free Software Foundation.
|
* version 2 as published by the Free Software Foundation.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file MySensor.h
|
||||||
|
*
|
||||||
|
* MySensors main interface (includes all necessary code for the library)
|
||||||
|
*/
|
||||||
#ifndef MySensor_h
|
#ifndef MySensor_h
|
||||||
#define MySensor_h
|
#define MySensor_h
|
||||||
|
|
||||||
#include "MyConfig.h"
|
|
||||||
#include "core/MySensorCore.h"
|
#include "core/MySensorCore.h"
|
||||||
|
|
||||||
// Detect node type
|
// Detect node type
|
||||||
|
/**
|
||||||
|
* @def MY_GATEWAY_FEATURE
|
||||||
|
* @brief Is set for gateway sketches.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* @def MY_IS_GATEWAY
|
||||||
|
* @brief Is true when @ref MY_GATEWAY_FEATURE is set.
|
||||||
|
*/
|
||||||
|
/**
|
||||||
|
* @def MY_NODE_TYPE
|
||||||
|
* @brief Contain a string describing the class of sketch/node (gateway/repeater/sensor).
|
||||||
|
*/
|
||||||
#if defined(MY_GATEWAY_SERIAL) || defined(MY_GATEWAY_W5100) || defined(MY_GATEWAY_ENC28J60) || defined(ARDUINO_ARCH_ESP8266) || defined(MY_GATEWAY_MQTT_CLIENT)
|
#if defined(MY_GATEWAY_SERIAL) || defined(MY_GATEWAY_W5100) || defined(MY_GATEWAY_ENC28J60) || defined(ARDUINO_ARCH_ESP8266) || defined(MY_GATEWAY_MQTT_CLIENT)
|
||||||
#define MY_GATEWAY_FEATURE
|
#define MY_GATEWAY_FEATURE
|
||||||
#define MY_IS_GATEWAY (true)
|
#define MY_IS_GATEWAY (true)
|
||||||
@@ -82,11 +99,17 @@
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
// default LEDs blinking period in milliseconds
|
/**
|
||||||
|
* @def MY_DEFAULT_LED_BLINK_PERIOD
|
||||||
|
* @brief Default LEDs blinking period in milliseconds.
|
||||||
|
*/
|
||||||
#ifndef MY_DEFAULT_LED_BLINK_PERIOD
|
#ifndef MY_DEFAULT_LED_BLINK_PERIOD
|
||||||
#define MY_DEFAULT_LED_BLINK_PERIOD 300
|
#define MY_DEFAULT_LED_BLINK_PERIOD 300
|
||||||
#endif
|
#endif
|
||||||
// The RX LED default pin
|
/**
|
||||||
|
* @def MY_DEFAULT_RX_LED_PIN
|
||||||
|
* @brief The RX LED default pin.
|
||||||
|
*/
|
||||||
#ifndef MY_DEFAULT_RX_LED_PIN
|
#ifndef MY_DEFAULT_RX_LED_PIN
|
||||||
#if defined(ARDUINO_ARCH_ESP8266)
|
#if defined(ARDUINO_ARCH_ESP8266)
|
||||||
#define MY_DEFAULT_RX_LED_PIN 8
|
#define MY_DEFAULT_RX_LED_PIN 8
|
||||||
@@ -94,7 +117,10 @@
|
|||||||
#define MY_DEFAULT_RX_LED_PIN 6
|
#define MY_DEFAULT_RX_LED_PIN 6
|
||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
// The TX LED default pin
|
/**
|
||||||
|
* @def MY_DEFAULT_TX_LED_PIN
|
||||||
|
* @brief The TX LED default pin.
|
||||||
|
*/
|
||||||
#ifndef MY_DEFAULT_TX_LED_PIN
|
#ifndef MY_DEFAULT_TX_LED_PIN
|
||||||
#if defined(ARDUINO_ARCH_ESP8266)
|
#if defined(ARDUINO_ARCH_ESP8266)
|
||||||
#define MY_DEFAULT_TX_LED_PIN 9
|
#define MY_DEFAULT_TX_LED_PIN 9
|
||||||
@@ -102,7 +128,10 @@
|
|||||||
#define MY_DEFAULT_TX_LED_PIN 5
|
#define MY_DEFAULT_TX_LED_PIN 5
|
||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
// The Error LED default pin
|
/**
|
||||||
|
* @def MY_DEFAULT_ERR_LED_PIN
|
||||||
|
* @brief The Error LED default pin.
|
||||||
|
*/
|
||||||
#ifndef MY_DEFAULT_ERR_LED_PIN
|
#ifndef MY_DEFAULT_ERR_LED_PIN
|
||||||
#if defined(ARDUINO_ARCH_ESP8266)
|
#if defined(ARDUINO_ARCH_ESP8266)
|
||||||
#define MY_DEFAULT_ERR_LED_PIN 7
|
#define MY_DEFAULT_ERR_LED_PIN 7
|
||||||
@@ -275,3 +304,8 @@
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
// Doxygen specific constructs, not included when built normally
|
||||||
|
// This is used to enable disabled macros/definitions to be included in the documentation as well.
|
||||||
|
#if DOXYGEN
|
||||||
|
#define MY_GATEWAY_FEATURE
|
||||||
|
#endif
|
||||||
|
|||||||
@@ -20,10 +20,7 @@
|
|||||||
#ifndef MyGatewayTransport_h
|
#ifndef MyGatewayTransport_h
|
||||||
#define MyGatewayTransport_h
|
#define MyGatewayTransport_h
|
||||||
|
|
||||||
#include "MyConfig.h"
|
|
||||||
#include "MyMessage.h"
|
|
||||||
#include "MyProtocol.h"
|
#include "MyProtocol.h"
|
||||||
#include "MySensorCore.h"
|
|
||||||
|
|
||||||
// Common gateway functions
|
// Common gateway functions
|
||||||
|
|
||||||
|
|||||||
@@ -21,8 +21,6 @@
|
|||||||
#define MyHwATMega328_h
|
#define MyHwATMega328_h
|
||||||
|
|
||||||
#include "MyHw.h"
|
#include "MyHw.h"
|
||||||
#include "MyConfig.h"
|
|
||||||
#include "MyMessage.h"
|
|
||||||
#include <avr/eeprom.h>
|
#include <avr/eeprom.h>
|
||||||
#include <avr/pgmspace.h>
|
#include <avr/pgmspace.h>
|
||||||
#include <avr/sleep.h>
|
#include <avr/sleep.h>
|
||||||
|
|||||||
@@ -20,10 +20,6 @@
|
|||||||
#define MyHwESP8266_h
|
#define MyHwESP8266_h
|
||||||
|
|
||||||
#include "MyHw.h"
|
#include "MyHw.h"
|
||||||
#include "MyConfig.h"
|
|
||||||
|
|
||||||
#include "MyMessage.h"
|
|
||||||
|
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
#include <Arduino.h>
|
#include <Arduino.h>
|
||||||
|
|||||||
@@ -20,9 +20,6 @@
|
|||||||
#define MyHwSAMD_h
|
#define MyHwSAMD_h
|
||||||
|
|
||||||
#include "MyHw.h"
|
#include "MyHw.h"
|
||||||
#include "MyConfig.h"
|
|
||||||
|
|
||||||
#include "MyMessage.h"
|
|
||||||
#include <Wire.h>
|
#include <Wire.h>
|
||||||
|
|
||||||
#ifdef __cplusplus
|
#ifdef __cplusplus
|
||||||
|
|||||||
@@ -20,8 +20,7 @@
|
|||||||
#ifndef MyProtocol_h
|
#ifndef MyProtocol_h
|
||||||
#define MyProtocol_h
|
#define MyProtocol_h
|
||||||
|
|
||||||
#include "MyConfig.h"
|
#include "MySensorCore.h"
|
||||||
#include "MyMessage.h"
|
|
||||||
|
|
||||||
|
|
||||||
// parse(message, inputString)
|
// parse(message, inputString)
|
||||||
|
|||||||
@@ -473,11 +473,8 @@
|
|||||||
#ifndef MySigning_h
|
#ifndef MySigning_h
|
||||||
#define MySigning_h
|
#define MySigning_h
|
||||||
|
|
||||||
#include "MyConfig.h"
|
|
||||||
#include <stdint.h>
|
|
||||||
#include "MyMessage.h"
|
|
||||||
#include "drivers/ATSHA204/ATSHA204.h"
|
|
||||||
#include "MySensorCore.h"
|
#include "MySensorCore.h"
|
||||||
|
#include "drivers/ATSHA204/ATSHA204.h"
|
||||||
|
|
||||||
#ifdef MY_SIGNING_NODE_WHITELISTING
|
#ifdef MY_SIGNING_NODE_WHITELISTING
|
||||||
typedef struct {
|
typedef struct {
|
||||||
|
|||||||
Reference in New Issue
Block a user