From e228902faffc55ca896ce86e22174cd9c9936e57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 18:36:45 +0100 Subject: [PATCH 01/71] adds boost python wrapper --- pyRF24Mesh/pyRF24Mesh.cpp | 52 +++++++++++++++++++++++++++++++++++++++ pyRF24Mesh/setup.py | 18 ++++++++++++++ 2 files changed, 70 insertions(+) create mode 100644 pyRF24Mesh/pyRF24Mesh.cpp create mode 100644 pyRF24Mesh/setup.py diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp new file mode 100644 index 0000000..94a7c12 --- /dev/null +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -0,0 +1,52 @@ +#include "boost/python.hpp" +#include "RF24/RF24.h" +#include "RF24Network/RF24Network.h" +#include "RF24Mesh/RF24Mesh.h" + +namespace bp = boost::python; + +// ******************** overload wrappers ************************** +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(begin_overload, RF24Mesh::begin, 0, 3) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeID_overload, RF24Mesh::getNodeID, 0, 1) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAddress, 0, 1) + +// **************** RF24Mesh exposed ***************** +// +BOOST_PYTHON_MODULE(RF24Mesh){ + { //::RF24Mesh + bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) + //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); + .def("begin", RF24Mesh::begin, begin_overload(args("channel", "data_rate", "timeout"))) + //uint8_t update(); + .def("update", &RF24Mesh::update) + //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); + .def("write", &RF24Mesh::write, write_overload(args("data", "msg_type", "size", "nodeID"))) + //void setNodeID(uint8_t nodeID); + .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) + //void DHCP(); + .def("DHCP", &RF24Mesh::DHCP) + //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); + .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(args("address"))) + //bool checkConnection(); + .def("checkConnection", &RF24Mesh::checkConnection) + //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); + .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(args("timeout"))) + //bool releaseAddress(); + .def("releaseAddress", &RF24Mesh::releaseAddress) + //int16_t getAddress(uint8_t nodeID); + .def("getAddress", &RF24Mesh::getAddress, (bp::arg("nodeID"))) + //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); + .def("write", &RF24Mesh::write, (bp::arg("to_node"), bp::arg("data"), bp::arg("msg_type"), bp::arg("size"))) + //void setChannel(uint8_t _channel); + .def("setChannel", &RF24Mesh::setChannel, (bp::arg("_channel"))) + //void setChild(bool allow); + .def("setChild", &RF24Mesh::setChild, (bp::arg("allow"))) + //void setAddress(uint8_t nodeID, uint16_t address); + .def("setAddress", &RF24Mesh::setAddress, (bp::arg("nodeID"), bp::arg("address"))) + //void saveDHCP(); + .def("saveDHCP", &RF24Mesh::saveDHCP) + //void loadDHCP(); + .def("loadDHCP", &RF24Mesh::loadDHCP) + } +} \ No newline at end of file diff --git a/pyRF24Mesh/setup.py b/pyRF24Mesh/setup.py new file mode 100644 index 0000000..4c2fe4d --- /dev/null +++ b/pyRF24Mesh/setup.py @@ -0,0 +1,18 @@ +#!/usr/bin/env python + +from distutils.core import setup, Extension +import sys + +if sys.version_info >= (3,): + BOOST_LIB = 'boost_python3' +else: + BOOST_LIB = 'boost_python' + +module_RF24Mesh = Extension('RF24Mesh', + libraries = ['rf24mesh', BOOST_LIB], + sources = ['pyRF24Mesh.cpp']) + +setup(name='RF24Mesh', + version='1.0', + ext_modules=[module_RF24Mesh] + ) From faa87ee7399e9e5c04f49d363f833c134df46ee3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 18:46:06 +0100 Subject: [PATCH 02/71] static_cast the overoaded wrappers --- pyRF24Mesh/pyRF24Mesh.cpp | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 94a7c12..bb338a5 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -6,10 +6,10 @@ namespace bp = boost::python; // ******************** overload wrappers ************************** -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(begin_overload, RF24Mesh::begin, 0, 3) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeID_overload, RF24Mesh::getNodeID, 0, 1) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAddress, 0, 1) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(beginWrapper, RF24Mesh::begin, 0, 3) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(writeWrapper, RF24Mesh::write, 3, 4) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeIDWrapper, RF24Mesh::getNodeID, 0, 1) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddressWrapper, RF24Mesh::renewAddress, 0, 1) // **************** RF24Mesh exposed ***************** // @@ -17,21 +17,29 @@ BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); - .def("begin", RF24Mesh::begin, begin_overload(args("channel", "data_rate", "timeout"))) + .def("begin", static_cast + (&RF24Mesh::begin), beginWrapper()) //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", &RF24Mesh::write, write_overload(args("data", "msg_type", "size", "nodeID"))) + .def("write", static_cast + (&RF24Mesh::write), writeWrapper()) //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); .def("DHCP", &RF24Mesh::DHCP) //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); - .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(args("address"))) + .def("getNodeID", static_cast + (&RF24Mesh::write), getNodeIDWrapper()) //bool checkConnection(); .def("checkConnection", &RF24Mesh::checkConnection) //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); - .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(args("timeout"))) + .def("renewAddress", static_cast + (&RF24Mesh::renewAddress), renewAddressWrapper()) //bool releaseAddress(); .def("releaseAddress", &RF24Mesh::releaseAddress) //int16_t getAddress(uint8_t nodeID); @@ -47,6 +55,6 @@ BOOST_PYTHON_MODULE(RF24Mesh){ //void saveDHCP(); .def("saveDHCP", &RF24Mesh::saveDHCP) //void loadDHCP(); - .def("loadDHCP", &RF24Mesh::loadDHCP) + .def("loadDHCP", &RF24Mesh::loadDHCP); } } \ No newline at end of file From 8121fdafcfb1327453c5d3cb9fecf420bb4ce9c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 19:07:11 +0100 Subject: [PATCH 03/71] removes static_cast agains; adds [return_internal_reference<>()] as seen on http://www.boost.org/doc/libs/1_38_0/libs/python/doc/v2/overloads.html --- pyRF24Mesh/pyRF24Mesh.cpp | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index bb338a5..4eafeb0 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -6,10 +6,10 @@ namespace bp = boost::python; // ******************** overload wrappers ************************** -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(beginWrapper, RF24Mesh::begin, 0, 3) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(writeWrapper, RF24Mesh::write, 3, 4) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeIDWrapper, RF24Mesh::getNodeID, 0, 1) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddressWrapper, RF24Mesh::renewAddress, 0, 1) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(begin_overload, RF24Mesh::begin, 0, 3) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeID_overload, RF24Mesh::getNodeID, 0, 1) +BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAddress, 0, 1) // **************** RF24Mesh exposed ***************** // @@ -17,29 +17,21 @@ BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); - .def("begin", static_cast - (&RF24Mesh::begin), beginWrapper()) + .def("begin", &RF24Mesh::begin, begin_overload(args("channel", "data_rate", "timeout")))[return_internal_reference<>()] //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", static_cast - (&RF24Mesh::write), writeWrapper()) + .def("write", &RF24Mesh::write, write_overload(args("data", "msg_type", "size", "nodeID")))[return_internal_reference<>()] //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); .def("DHCP", &RF24Mesh::DHCP) //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); - .def("getNodeID", static_cast - (&RF24Mesh::write), getNodeIDWrapper()) + .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(args("address")))[return_internal_reference<>()] //bool checkConnection(); .def("checkConnection", &RF24Mesh::checkConnection) //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); - .def("renewAddress", static_cast - (&RF24Mesh::renewAddress), renewAddressWrapper()) + .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(args("timeout")))[return_internal_reference<>()] //bool releaseAddress(); .def("releaseAddress", &RF24Mesh::releaseAddress) //int16_t getAddress(uint8_t nodeID); From d601161dd4a7f6ccd612cfcf66abe4421d1a8ba3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 19:24:33 +0100 Subject: [PATCH 04/71] adds namespace --- pyRF24Mesh/pyRF24Mesh.cpp | 64 +++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 4eafeb0..4f93db6 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -16,37 +16,37 @@ BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAdd BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) - //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); - .def("begin", &RF24Mesh::begin, begin_overload(args("channel", "data_rate", "timeout")))[return_internal_reference<>()] - //uint8_t update(); - .def("update", &RF24Mesh::update) - //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", &RF24Mesh::write, write_overload(args("data", "msg_type", "size", "nodeID")))[return_internal_reference<>()] - //void setNodeID(uint8_t nodeID); - .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) - //void DHCP(); - .def("DHCP", &RF24Mesh::DHCP) - //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); - .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(args("address")))[return_internal_reference<>()] - //bool checkConnection(); - .def("checkConnection", &RF24Mesh::checkConnection) - //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); - .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(args("timeout")))[return_internal_reference<>()] - //bool releaseAddress(); - .def("releaseAddress", &RF24Mesh::releaseAddress) - //int16_t getAddress(uint8_t nodeID); - .def("getAddress", &RF24Mesh::getAddress, (bp::arg("nodeID"))) - //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); - .def("write", &RF24Mesh::write, (bp::arg("to_node"), bp::arg("data"), bp::arg("msg_type"), bp::arg("size"))) - //void setChannel(uint8_t _channel); - .def("setChannel", &RF24Mesh::setChannel, (bp::arg("_channel"))) - //void setChild(bool allow); - .def("setChild", &RF24Mesh::setChild, (bp::arg("allow"))) - //void setAddress(uint8_t nodeID, uint16_t address); - .def("setAddress", &RF24Mesh::setAddress, (bp::arg("nodeID"), bp::arg("address"))) - //void saveDHCP(); - .def("saveDHCP", &RF24Mesh::saveDHCP) - //void loadDHCP(); - .def("loadDHCP", &RF24Mesh::loadDHCP); + //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); + .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout")))[bp::return_internal_reference<>()] + //uint8_t update(); + .def("update", &RF24Mesh::update) + //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); + .def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID")))[bp::return_internal_reference<>()] + //void setNodeID(uint8_t nodeID); + .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) + //void DHCP(); + .def("DHCP", &RF24Mesh::DHCP) + //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); + .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::args("address")))[bp::return_internal_reference<>()] + //bool checkConnection(); + .def("checkConnection", &RF24Mesh::checkConnection) + //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); + .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::args("timeout")))[bp::return_internal_reference<>()] + //bool releaseAddress(); + .def("releaseAddress", &RF24Mesh::releaseAddress) + //int16_t getAddress(uint8_t nodeID); + .def("getAddress", &RF24Mesh::getAddress, (bp::arg("nodeID"))) + //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); + .def("write", &RF24Mesh::write, (bp::arg("to_node"), bp::arg("data"), bp::arg("msg_type"), bp::arg("size"))) + //void setChannel(uint8_t _channel); + .def("setChannel", &RF24Mesh::setChannel, (bp::arg("_channel"))) + //void setChild(bool allow); + .def("setChild", &RF24Mesh::setChild, (bp::arg("allow"))) + //void setAddress(uint8_t nodeID, uint16_t address); + .def("setAddress", &RF24Mesh::setAddress, (bp::arg("nodeID"), bp::arg("address"))) + //void saveDHCP(); + .def("saveDHCP", &RF24Mesh::saveDHCP) + //void loadDHCP(); + .def("loadDHCP", &RF24Mesh::loadDHCP); } } \ No newline at end of file From f87bdfd0c42981808cdd56755b4d9fd9033cceb0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 19:25:36 +0100 Subject: [PATCH 05/71] single bp:arg() instead of args --- pyRF24Mesh/pyRF24Mesh.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 4f93db6..b68b718 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -17,21 +17,21 @@ BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); - .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout")))[bp::return_internal_reference<>()] + .def("begin", &RF24Mesh::begin, begin_overload(bp::arg("channel"), bp::arg("data_rate"), bp::arg("timeout")))[bp::return_internal_reference<>()] //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID")))[bp::return_internal_reference<>()] + .def("write", &RF24Mesh::write, write_overload(bp::arg("data"), bp::arg("msg_type"), bp::arg("size"), bp::arg("nodeID")))[bp::return_internal_reference<>()] //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); .def("DHCP", &RF24Mesh::DHCP) //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); - .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::args("address")))[bp::return_internal_reference<>()] + .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::arg("address")))[bp::return_internal_reference<>()] //bool checkConnection(); .def("checkConnection", &RF24Mesh::checkConnection) //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); - .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::args("timeout")))[bp::return_internal_reference<>()] + .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::arg("timeout")))[bp::return_internal_reference<>()] //bool releaseAddress(); .def("releaseAddress", &RF24Mesh::releaseAddress) //int16_t getAddress(uint8_t nodeID); From d3a17b3269b3ade560fca08bad5eebfbff5aa39c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 20:59:24 +0100 Subject: [PATCH 06/71] adds python example for master node --- pyRF24Mesh/example_master.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 pyRF24Mesh/example_master.py diff --git a/pyRF24Mesh/example_master.py b/pyRF24Mesh/example_master.py new file mode 100644 index 0000000..ba26669 --- /dev/null +++ b/pyRF24Mesh/example_master.py @@ -0,0 +1,24 @@ +from RF24 import * +from RF24Network import * +from RF24Mesh import * + + +class Mesh(object): + def __init__(self): + # radio setup for RPi B Rev2: CS0=Pin 24 + self.radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) + self.network = RF24Network(self.radio) + self.mesh = RF24Mesh(self.radio, self.network) + + self.mesh.setNodeID(0) + self.mesh.begin(108, RF24_250KBPS) + self.radio.setPALevel(RF24_PA_MAX) # Power Amplifier + self.radio.printDetails() + + while 1: + self.mesh.update() + self.mesh.DHCP() + + while self.network.available(): + print("Received message") + header, payload = self.network.read(10) From 9c2de0f3e9a10f545f177d49efaf85ed17d0a626 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 21:22:46 +0100 Subject: [PATCH 07/71] adds missing function --- pyRF24Mesh/pyRF24Mesh.cpp | 2 ++ pyRF24Mesh/setup.py | 3 +-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index b68b718..d9f4f09 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -48,5 +48,7 @@ BOOST_PYTHON_MODULE(RF24Mesh){ .def("saveDHCP", &RF24Mesh::saveDHCP) //void loadDHCP(); .def("loadDHCP", &RF24Mesh::loadDHCP); + //void setStaticAddress(uint8_t nodeID, uint16_t address); + .def("setStaticAddress", &RF24Mesh::setStaticAddress, (bp::arg("nodeID"), bp::arg("address"))) } } \ No newline at end of file diff --git a/pyRF24Mesh/setup.py b/pyRF24Mesh/setup.py index 4c2fe4d..9dc8b75 100644 --- a/pyRF24Mesh/setup.py +++ b/pyRF24Mesh/setup.py @@ -14,5 +14,4 @@ setup(name='RF24Mesh', version='1.0', - ext_modules=[module_RF24Mesh] - ) + ext_modules=[module_RF24Mesh]) From 3f79b2c82d77eb13b6682ecdc2a06997455b23dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 21:32:19 +0100 Subject: [PATCH 08/71] back to bp::args; moves [bp::return_internal_reference<>()] into correct position --- pyRF24Mesh/pyRF24Mesh.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index d9f4f09..437f002 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -17,21 +17,21 @@ BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); - .def("begin", &RF24Mesh::begin, begin_overload(bp::arg("channel"), bp::arg("data_rate"), bp::arg("timeout")))[bp::return_internal_reference<>()] + .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout"))[bp::return_internal_reference<>()]) //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", &RF24Mesh::write, write_overload(bp::arg("data"), bp::arg("msg_type"), bp::arg("size"), bp::arg("nodeID")))[bp::return_internal_reference<>()] + .def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))[bp::return_internal_reference<>()]) //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); .def("DHCP", &RF24Mesh::DHCP) //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); - .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::arg("address")))[bp::return_internal_reference<>()] + .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::args("address"))[bp::return_internal_reference<>()]) //bool checkConnection(); .def("checkConnection", &RF24Mesh::checkConnection) //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); - .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::arg("timeout")))[bp::return_internal_reference<>()] + .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::args("timeout"))[bp::return_internal_reference<>()]) //bool releaseAddress(); .def("releaseAddress", &RF24Mesh::releaseAddress) //int16_t getAddress(uint8_t nodeID); @@ -47,8 +47,8 @@ BOOST_PYTHON_MODULE(RF24Mesh){ //void saveDHCP(); .def("saveDHCP", &RF24Mesh::saveDHCP) //void loadDHCP(); - .def("loadDHCP", &RF24Mesh::loadDHCP); + .def("loadDHCP", &RF24Mesh::loadDHCP) //void setStaticAddress(uint8_t nodeID, uint16_t address); - .def("setStaticAddress", &RF24Mesh::setStaticAddress, (bp::arg("nodeID"), bp::arg("address"))) + .def("setStaticAddress", &RF24Mesh::setStaticAddress, (bp::arg("nodeID"), bp::arg("address"))); } } \ No newline at end of file From 93046a969b03f7c3c3d8b1313b910f7c3238d690 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 21:37:05 +0100 Subject: [PATCH 09/71] remove [bp::return_internal_reference<>()] because those functions don't actually return any internal references... --- pyRF24Mesh/pyRF24Mesh.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 437f002..63aff2e 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -17,21 +17,21 @@ BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); - .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout"))[bp::return_internal_reference<>()]) + .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout"))) //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))[bp::return_internal_reference<>()]) + .def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))) //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); .def("DHCP", &RF24Mesh::DHCP) //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); - .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::args("address"))[bp::return_internal_reference<>()]) + .def("getNodeID", &RF24Mesh::getNodeID, getNodeID_overload(bp::args("address"))) //bool checkConnection(); .def("checkConnection", &RF24Mesh::checkConnection) //uint16_t renewAddress(uint32_t timeout=MESH_RENEWAL_TIMEOUT); - .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::args("timeout"))[bp::return_internal_reference<>()]) + .def("renewAddress", &RF24Mesh::renewAddress, getNodeID_overload(bp::args("timeout"))) //bool releaseAddress(); .def("releaseAddress", &RF24Mesh::releaseAddress) //int16_t getAddress(uint8_t nodeID); From 27c3f4788a232f237d0032fc16685a198ca99188 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 21:58:31 +0100 Subject: [PATCH 10/71] trying manual wrapper functions --- pyRF24Mesh/pyRF24Mesh.cpp | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 63aff2e..64b7afe 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -7,7 +7,7 @@ namespace bp = boost::python; // ******************** overload wrappers ************************** BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(begin_overload, RF24Mesh::begin, 0, 3) -BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) +//BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeID_overload, RF24Mesh::getNodeID, 0, 1) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAddress, 0, 1) @@ -15,13 +15,18 @@ BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAdd // BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh + bool (RF24Mesh::*write1)(const void*, uint8_t, size_t) = &RF24Mesh::write; + bool (RF24Mesh::*write2)(const void*, uint8_t, size_t, uint8_t) = &RF24Mesh::write; + bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout"))) //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - .def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))) + //.def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))) + .def("write", write1) + .def("write", write2) //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); From ebbe80df848ace5ec0e57a46d1c82bf97fb0c430 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 22:25:58 +0100 Subject: [PATCH 11/71] wrapper functions for byte buffer parameters --- pyRF24Mesh/pyRF24Mesh.cpp | 56 ++++++++++++++++++++++++++++++++++----- 1 file changed, 49 insertions(+), 7 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 64b7afe..d04cfa4 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -5,6 +5,51 @@ namespace bp = boost::python; + +// **************** expicit wrappers ***************** +// where needed, especially where buffer is involved + +char *get_bytes_or_bytearray_str(bp::object buf) +{ + PyObject *py_ba; + py_ba = buf.ptr(); + if (PyByteArray_Check(py_ba)) + return PyByteArray_AsString(py_ba); + else if (PyBytes_Check(py_ba)) + return PyBytes_AsString(py_ba); + else + throw_ba_exception(); + return NULL; +} + +int get_bytes_or_bytearray_ln(bp::object buf) +{ + PyObject *py_ba; + py_ba = buf.ptr(); + if (PyByteArray_Check(py_ba)) + return PyByteArray_Size(py_ba); + else if (PyBytes_Check(py_ba)) + return PyBytes_Size(py_ba); + else + throw_ba_exception(); + return 0; +} + +bool write_wrap1(RF24Mesh& ref, bp::object buf, uint8_t msg_type) +{ + return ref.write(get_bytes_or_bytearray_str(buf), msg_type, get_bytes_or_bytearray_ln(buf)); +} + +bool write_wrap2(RF24Mesh& ref, bp::object buf, uint8_t msg_type, uint8_t nodeID) +{ + return ref.write(get_bytes_or_bytearray_str(buf), msg_type, get_bytes_or_bytearray_ln(buf), nodeID); +} + +bool write_to_node_wrap(RF24Mesh& ref, uint16_t to_node, bp::object data, uint8_t msg_type) +{ + return ref.write(to_node, get_bytes_or_bytearray_str(buf), msg_type, get_bytes_or_bytearray_ln(buf), nodeID); +} + // ******************** overload wrappers ************************** BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(begin_overload, RF24Mesh::begin, 0, 3) //BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) @@ -15,9 +60,6 @@ BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAdd // BOOST_PYTHON_MODULE(RF24Mesh){ { //::RF24Mesh - bool (RF24Mesh::*write1)(const void*, uint8_t, size_t) = &RF24Mesh::write; - bool (RF24Mesh::*write2)(const void*, uint8_t, size_t, uint8_t) = &RF24Mesh::write; - bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); .def("begin", &RF24Mesh::begin, begin_overload(bp::args("channel", "data_rate", "timeout"))) @@ -25,8 +67,10 @@ BOOST_PYTHON_MODULE(RF24Mesh){ .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); //.def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))) - .def("write", write1) - .def("write", write2) + .def("write", &write_wrap1, (bp::arg("data"), bp::arg("msg_type"))) + .def("write", &write_wrap2, (bp::arg("data"), bp::arg("msg_type"), bp::arg("nodeID"))) + //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); + .def("write", &write_to_node_wrap, (bp::arg("to_node"), bp::arg("data"), bp::arg("msg_type"), bp::arg("size"))) //void setNodeID(uint8_t nodeID); .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); @@ -41,8 +85,6 @@ BOOST_PYTHON_MODULE(RF24Mesh){ .def("releaseAddress", &RF24Mesh::releaseAddress) //int16_t getAddress(uint8_t nodeID); .def("getAddress", &RF24Mesh::getAddress, (bp::arg("nodeID"))) - //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); - .def("write", &RF24Mesh::write, (bp::arg("to_node"), bp::arg("data"), bp::arg("msg_type"), bp::arg("size"))) //void setChannel(uint8_t _channel); .def("setChannel", &RF24Mesh::setChannel, (bp::arg("_channel"))) //void setChild(bool allow); From 4a1b9a8889158feb612eb79edb47304a4e131105 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 22:28:44 +0100 Subject: [PATCH 12/71] added missing throw_ba_exception() function --- pyRF24Mesh/pyRF24Mesh.cpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index d04cfa4..e610303 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -9,6 +9,12 @@ namespace bp = boost::python; // **************** expicit wrappers ***************** // where needed, especially where buffer is involved +void throw_ba_exception(void) +{ + PyErr_SetString(PyExc_TypeError, "buf parameter must be bytes or bytearray"); + bp::throw_error_already_set(); +} + char *get_bytes_or_bytearray_str(bp::object buf) { PyObject *py_ba; From 06250007c473e8dd972f4471e751070df1189246 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 22:44:21 +0100 Subject: [PATCH 13/71] example doesn't need to be a class --- pyRF24Mesh/example_master.py | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/pyRF24Mesh/example_master.py b/pyRF24Mesh/example_master.py index ba26669..43b94c4 100644 --- a/pyRF24Mesh/example_master.py +++ b/pyRF24Mesh/example_master.py @@ -3,22 +3,20 @@ from RF24Mesh import * -class Mesh(object): - def __init__(self): - # radio setup for RPi B Rev2: CS0=Pin 24 - self.radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) - self.network = RF24Network(self.radio) - self.mesh = RF24Mesh(self.radio, self.network) - - self.mesh.setNodeID(0) - self.mesh.begin(108, RF24_250KBPS) - self.radio.setPALevel(RF24_PA_MAX) # Power Amplifier - self.radio.printDetails() +# radio setup for RPi B Rev2: CS0=Pin 24 +radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) +network = RF24Network(radio) +mesh = RF24Mesh(radio, network) - while 1: - self.mesh.update() - self.mesh.DHCP() +mesh.setNodeID(0) +mesh.begin(108, RF24_250KBPS) +radio.setPALevel(RF24_PA_MAX) # Power Amplifier +radio.printDetails() - while self.network.available(): - print("Received message") - header, payload = self.network.read(10) +while 1: + mesh.update() + mesh.DHCP() + + while network.available(): + print("Received message") + header, payload = network.read(10) From d2381c8fbff71c4fdafbc07747a99beee8879ca8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 22:45:50 +0100 Subject: [PATCH 14/71] fixes arguments --- pyRF24Mesh/pyRF24Mesh.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index e610303..ad0bb7c 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -51,9 +51,9 @@ bool write_wrap2(RF24Mesh& ref, bp::object buf, uint8_t msg_type, uint8_t nodeID return ref.write(get_bytes_or_bytearray_str(buf), msg_type, get_bytes_or_bytearray_ln(buf), nodeID); } -bool write_to_node_wrap(RF24Mesh& ref, uint16_t to_node, bp::object data, uint8_t msg_type) +bool write_to_node_wrap(RF24Mesh& ref, uint16_t to_node, bp::object buf, uint8_t msg_type) { - return ref.write(to_node, get_bytes_or_bytearray_str(buf), msg_type, get_bytes_or_bytearray_ln(buf), nodeID); + return ref.write(to_node, get_bytes_or_bytearray_str(buf), msg_type, get_bytes_or_bytearray_ln(buf)); } // ******************** overload wrappers ************************** From 68cce8d7fc988b9989e3e80513419b1a76496c39 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 22:10:26 +0000 Subject: [PATCH 15/71] adds rf24network library reference to setup; fixes typo in setNodeId() function name --- pyRF24Mesh/example_master.py | 2 +- pyRF24Mesh/setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyRF24Mesh/example_master.py b/pyRF24Mesh/example_master.py index 43b94c4..5c86527 100644 --- a/pyRF24Mesh/example_master.py +++ b/pyRF24Mesh/example_master.py @@ -8,7 +8,7 @@ network = RF24Network(radio) mesh = RF24Mesh(radio, network) -mesh.setNodeID(0) +mesh.setNodeId(0) mesh.begin(108, RF24_250KBPS) radio.setPALevel(RF24_PA_MAX) # Power Amplifier radio.printDetails() diff --git a/pyRF24Mesh/setup.py b/pyRF24Mesh/setup.py index 9dc8b75..8d5eb72 100644 --- a/pyRF24Mesh/setup.py +++ b/pyRF24Mesh/setup.py @@ -9,7 +9,7 @@ BOOST_LIB = 'boost_python' module_RF24Mesh = Extension('RF24Mesh', - libraries = ['rf24mesh', BOOST_LIB], + libraries = ['rf24mesh', 'rf24network', BOOST_LIB], sources = ['pyRF24Mesh.cpp']) setup(name='RF24Mesh', From e3f833d09207125b29cbc9683c9c4b04dfaf3e8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Mon, 26 Dec 2016 23:23:23 +0100 Subject: [PATCH 16/71] adopts correct capitalization of ID --- pyRF24Mesh/example_master.py | 2 +- pyRF24Mesh/pyRF24Mesh.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyRF24Mesh/example_master.py b/pyRF24Mesh/example_master.py index 5c86527..43b94c4 100644 --- a/pyRF24Mesh/example_master.py +++ b/pyRF24Mesh/example_master.py @@ -8,7 +8,7 @@ network = RF24Network(radio) mesh = RF24Mesh(radio, network) -mesh.setNodeId(0) +mesh.setNodeID(0) mesh.begin(108, RF24_250KBPS) radio.setPALevel(RF24_PA_MAX) # Power Amplifier radio.printDetails() diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index ad0bb7c..5bb5841 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -78,7 +78,7 @@ BOOST_PYTHON_MODULE(RF24Mesh){ //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); .def("write", &write_to_node_wrap, (bp::arg("to_node"), bp::arg("data"), bp::arg("msg_type"), bp::arg("size"))) //void setNodeID(uint8_t nodeID); - .def("setNodeId", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) + .def("setNodeID", &RF24Mesh::setNodeID, (bp::arg("nodeID"))) //void DHCP(); .def("DHCP", &RF24Mesh::DHCP) //int16_t getNodeID(uint16_t address=MESH_BLANK_ID); From 7bbece99ab79bb99b5eddf550240ddc035625608 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Tue, 27 Dec 2016 13:53:50 +0100 Subject: [PATCH 17/71] clean up --- pyRF24Mesh/pyRF24Mesh.cpp | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 5bb5841..29b73f2 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -6,7 +6,7 @@ namespace bp = boost::python; -// **************** expicit wrappers ***************** +// ******************** expicit wrappers ************************** // where needed, especially where buffer is involved void throw_ba_exception(void) @@ -58,13 +58,12 @@ bool write_to_node_wrap(RF24Mesh& ref, uint16_t to_node, bp::object buf, uint8_ // ******************** overload wrappers ************************** BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(begin_overload, RF24Mesh::begin, 0, 3) -//BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(write_overload, RF24Mesh::write, 3, 4) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(getNodeID_overload, RF24Mesh::getNodeID, 0, 1) BOOST_PYTHON_MEMBER_FUNCTION_OVERLOADS(renewAddress_overload, RF24Mesh::renewAddress, 0, 1) -// **************** RF24Mesh exposed ***************** -// -BOOST_PYTHON_MODULE(RF24Mesh){ +// ******************** RF24Mesh exposed ************************** +BOOST_PYTHON_MODULE(RF24Mesh) +{ { //::RF24Mesh bp::class_("RF24Mesh", bp::init((bp::arg("_radio"), bp::arg("_network")))) //bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout=MESH_RENEWAL_TIMEOUT ); @@ -72,7 +71,6 @@ BOOST_PYTHON_MODULE(RF24Mesh){ //uint8_t update(); .def("update", &RF24Mesh::update) //bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID=0); - //.def("write", &RF24Mesh::write, write_overload(bp::args("data", "msg_type", "size", "nodeID"))) .def("write", &write_wrap1, (bp::arg("data"), bp::arg("msg_type"))) .def("write", &write_wrap2, (bp::arg("data"), bp::arg("msg_type"), bp::arg("nodeID"))) //bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size ); From d228ce6674f2295c9f675fd6612d3b8baf2c2aea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rn=20Esdohr?= Date: Wed, 28 Dec 2016 12:05:02 +0100 Subject: [PATCH 18/71] typo in comment --- pyRF24Mesh/pyRF24Mesh.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyRF24Mesh/pyRF24Mesh.cpp b/pyRF24Mesh/pyRF24Mesh.cpp index 29b73f2..26f6afc 100644 --- a/pyRF24Mesh/pyRF24Mesh.cpp +++ b/pyRF24Mesh/pyRF24Mesh.cpp @@ -6,7 +6,7 @@ namespace bp = boost::python; -// ******************** expicit wrappers ************************** +// ******************** explicit wrappers ************************** // where needed, especially where buffer is involved void throw_ba_exception(void) From c783fdb64c30dd268185c7e7481ab9c42c341382 Mon Sep 17 00:00:00 2001 From: Filip Richter Date: Fri, 28 Jul 2017 18:32:14 +0200 Subject: [PATCH 19/71] Files moved to standard structure --- .../RF24Mesh_Example_Master.py | 4 +++- pyRF24Mesh/setup.py | 0 2 files changed, 3 insertions(+), 1 deletion(-) rename pyRF24Mesh/example_master.py => examples_RPi/RF24Mesh_Example_Master.py (92%) mode change 100644 => 100755 mode change 100644 => 100755 pyRF24Mesh/setup.py diff --git a/pyRF24Mesh/example_master.py b/examples_RPi/RF24Mesh_Example_Master.py old mode 100644 new mode 100755 similarity index 92% rename from pyRF24Mesh/example_master.py rename to examples_RPi/RF24Mesh_Example_Master.py index 43b94c4..eb60222 --- a/pyRF24Mesh/example_master.py +++ b/examples_RPi/RF24Mesh_Example_Master.py @@ -1,3 +1,5 @@ +#!/usr/bin/env python3 + from RF24 import * from RF24Network import * from RF24Mesh import * @@ -9,7 +11,7 @@ mesh = RF24Mesh(radio, network) mesh.setNodeID(0) -mesh.begin(108, RF24_250KBPS) +mesh.begin() radio.setPALevel(RF24_PA_MAX) # Power Amplifier radio.printDetails() diff --git a/pyRF24Mesh/setup.py b/pyRF24Mesh/setup.py old mode 100644 new mode 100755 From e628d65c2e1fd04b3315e19a0bd785ede9315feb Mon Sep 17 00:00:00 2001 From: Filip Richter Date: Fri, 28 Jul 2017 19:34:36 +0200 Subject: [PATCH 20/71] Python example RF24Mesh_Example_Master.py rewrited to work as C++ example --- examples_RPi/RF24Mesh_Example_Master.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/examples_RPi/RF24Mesh_Example_Master.py b/examples_RPi/RF24Mesh_Example_Master.py index eb60222..4b7a1a2 100755 --- a/examples_RPi/RF24Mesh_Example_Master.py +++ b/examples_RPi/RF24Mesh_Example_Master.py @@ -4,6 +4,8 @@ from RF24Network import * from RF24Mesh import * +from struct import unpack + # radio setup for RPi B Rev2: CS0=Pin 24 radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) @@ -20,5 +22,8 @@ mesh.DHCP() while network.available(): - print("Received message") header, payload = network.read(10) + if chr(header.type) == 'M': + print("Rcv {} from 0{:o}".format(unpack("L",payload)[0], header.from_node)) + else: + print("Rcv bad type {} from 0{:o}".format(header.type,header.from_node)); \ No newline at end of file From 7708cfc9f4cbc615b759401394d973e7d51cd2b5 Mon Sep 17 00:00:00 2001 From: Filip Richter Date: Fri, 28 Jul 2017 20:06:55 +0200 Subject: [PATCH 21/71] Mesh node example in Python 3 --- examples_RPi/RF24Mesh_Example.py | 51 ++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100755 examples_RPi/RF24Mesh_Example.py diff --git a/examples_RPi/RF24Mesh_Example.py b/examples_RPi/RF24Mesh_Example.py new file mode 100755 index 0000000..01ad639 --- /dev/null +++ b/examples_RPi/RF24Mesh_Example.py @@ -0,0 +1,51 @@ +#!/usr/bin/env python3 + +from RF24 import * +from RF24Network import * +from RF24Mesh import * + +from time import sleep, time +from struct import pack + +start = time() + +def millis(): + + return int((time()-start)*1000) % (2 ** 32) + +def delay(ms): + ms = ms % (2**32) + sleep(ms/1000.0) + +# radio setup for RPi B Rev2: CS0=Pin 24 +radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) +network = RF24Network(radio) +mesh = RF24Mesh(radio, network) + +mesh.setNodeID(4) +print("start nodeID", mesh.getNodeID()); +mesh.begin() +radio.setPALevel(RF24_PA_MAX) # Power Amplifier +radio.printDetails() + +displayTimer = 0 + +while 1: + # Call mesh.update to keep the network updated + mesh.update() + + if (millis() - displayTimer) >= 1000: + displayTimer = millis() + + if not mesh.write(pack("L", displayTimer), ord('M')): + # If a write fails, check connectivity to the mesh network + if not mesh.checkConnection(): + # The address could be refreshed per a specified timeframe or only when sequential writes fail, etc. + print("Renewing Address") + mesh.renewAddress() + else: + print("Send fail, Test OK") + else: + print("Send OK:", displayTimer) + delay(1); + \ No newline at end of file From 2022b937d6074294266187bffc148e6a081c84e4 Mon Sep 17 00:00:00 2001 From: Igor Moura Date: Fri, 5 Oct 2018 16:56:05 -0300 Subject: [PATCH 22/71] Added compiler variable into makefiles for easy compiler switching --- Makefile | 7 +++++-- examples_RPi/Makefile | 5 ++++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index aaf09c2..bd7e8bc 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,9 @@ LIBNAME_RFN=$(LIB_RFN).so.1.0 HEADER_DIR=${PREFIX}/include/RF24Mesh +# Which compiler to use +CC=g++ + ARCH=armv6zk ifeq "$(shell uname -m)" "armv7l" ARCH=armv7-a @@ -45,11 +48,11 @@ all: librf24mesh # Make the library librf24mesh: RF24Mesh.o - g++ -shared -Wl,-soname,$@.so.1 ${CCFLAGS} -o ${LIBNAME_RFN} $^ + $(CC) -shared -Wl,-soname,$@.so.1 ${CCFLAGS} -o ${LIBNAME_RFN} $^ # Library parts RF24Mesh.o: RF24Mesh.cpp - g++ -Wall -fPIC ${CCFLAGS} -c $^ + $(CC) -Wall -fPIC ${CCFLAGS} -c $^ # clear build files clean: diff --git a/examples_RPi/Makefile b/examples_RPi/Makefile index fff4edb..4aed050 100644 --- a/examples_RPi/Makefile +++ b/examples_RPi/Makefile @@ -12,6 +12,9 @@ # prefix := /usr/local +# Which compiler to use +CC=g++ + ARCH=armv6zk ifeq "$(shell uname -m)" "armv7l" ARCH=armv7-a @@ -36,7 +39,7 @@ SOURCES = ${PROGRAMS:=.cpp} all: ${PROGRAMS} ${PROGRAMS}: ${SOURCES} - g++ ${CCFLAGS} -Wall -I../ -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o $@ + $(CC) ${CCFLAGS} -Wall -I../ -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o $@ clean: rm -rf $(PROGRAMS) From 33aad0ba9f8a50981ca5a8019d2cb55df0b18939 Mon Sep 17 00:00:00 2001 From: Igor Moura Date: Fri, 5 Oct 2018 17:30:13 -0300 Subject: [PATCH 23/71] Split increment and assignment in order to avoid UB --- RF24Mesh.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 7c9bb46..b92dc77 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -253,8 +253,10 @@ uint16_t RF24Mesh::renewAddress(uint32_t timeout){ while(!requestAddress(reqCounter)){ if(millis()-start > timeout){ return 0; } delay(50 + ( (totalReqs+1)*(reqCounter+1)) * 2); - (++reqCounter) = reqCounter%4; - (++totalReqs) = totalReqs%10; + reqCounter++; + reqCounter = reqCounter%4; + totalReqs++; + totalReqs = totalReqs%10; } network.networkFlags &= ~2; From 63da60709158535b5e6168576e0b2a221eff4e7c Mon Sep 17 00:00:00 2001 From: Igor Moura Date: Wed, 10 Oct 2018 15:48:30 -0300 Subject: [PATCH 24/71] Added compiler variable into ncurses makefile --- examples_RPi/ncurses/Makefile | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/examples_RPi/ncurses/Makefile b/examples_RPi/ncurses/Makefile index f882ad7..3df0046 100644 --- a/examples_RPi/ncurses/Makefile +++ b/examples_RPi/ncurses/Makefile @@ -12,6 +12,9 @@ # prefix := /usr/local +# Which compiler to use +CC=g++ + ARCH=armv6zk ifeq "$(shell uname -m)" "armv7l" ARCH=armv7-a @@ -36,7 +39,7 @@ SOURCES = ${PROGRAMS2:=.cpp} all: ${PROGRAMS} ${PROGRAMS}: ${SOURCES} - g++ ${CCFLAGS} -Wall -I../ -lncurses -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o $@ + $(CC) ${CCFLAGS} -Wall -I../ -lncurses -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o $@ clean: rm -rf $(PROGRAMS) From c31387abc051e2a246faa6eda9d5c87c1aaca9d8 Mon Sep 17 00:00:00 2001 From: Igor Moura Date: Wed, 10 Oct 2018 15:59:02 -0300 Subject: [PATCH 25/71] Added default initialization value for bool This gets rid of a warning clang was throwing about a case where the variable `ok` could be used without initialization if `headers.to_node` was false. --- examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp b/examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp index 9ff2e9a..0c6664f 100644 --- a/examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp +++ b/examples_RPi/ncurses/RF24Mesh_Ncurses_Master.cpp @@ -174,7 +174,7 @@ void pingNode(uint8_t listNo){ RF24NetworkHeader headers(mesh.addrList[listNo].address,NETWORK_PING); uint32_t pingtime=millis(); - bool ok; + bool ok = false; if(headers.to_node){ ok = network.write(headers,0,0); if(ok && failID == mesh.addrList[listNo].nodeID){ failID = 0; } From 37e0626bcb62094fef89683f6353645995cc57e6 Mon Sep 17 00:00:00 2001 From: Igor Moura Date: Wed, 10 Oct 2018 16:10:30 -0300 Subject: [PATCH 26/71] Examples' makefiles now create a `bin` dir Makes it easier to add the generated files to .gitignore --- examples_RPi/Makefile | 3 ++- examples_RPi/ncurses/Makefile | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/examples_RPi/Makefile b/examples_RPi/Makefile index 4aed050..1db53d9 100644 --- a/examples_RPi/Makefile +++ b/examples_RPi/Makefile @@ -39,7 +39,8 @@ SOURCES = ${PROGRAMS:=.cpp} all: ${PROGRAMS} ${PROGRAMS}: ${SOURCES} - $(CC) ${CCFLAGS} -Wall -I../ -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o $@ + mkdir -p bin + $(CC) ${CCFLAGS} -Wall -I../ -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o bin/$@ clean: rm -rf $(PROGRAMS) diff --git a/examples_RPi/ncurses/Makefile b/examples_RPi/ncurses/Makefile index 3df0046..92437f8 100644 --- a/examples_RPi/ncurses/Makefile +++ b/examples_RPi/ncurses/Makefile @@ -39,7 +39,8 @@ SOURCES = ${PROGRAMS2:=.cpp} all: ${PROGRAMS} ${PROGRAMS}: ${SOURCES} - $(CC) ${CCFLAGS} -Wall -I../ -lncurses -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o $@ + mkdir -p bin + $(CC) ${CCFLAGS} -Wall -I../ -lncurses -lrf24-bcm -lrf24network -lrf24mesh $@.cpp -o bin/$@ clean: rm -rf $(PROGRAMS) From 8502bc49a2fa1e9b4651be2679a842414e60c48b Mon Sep 17 00:00:00 2001 From: Igor Moura Date: Wed, 10 Oct 2018 16:13:18 -0300 Subject: [PATCH 27/71] Added .gitignore Now executable files and the resulting library files made won't get in the way of git while trying stuff out --- .gitignore | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9ffd052 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# Executables from examples +*/bin/* + +# Generated library files +*.so +*.so.1 From 4ed90d33f2d8b5fd62260131212e81177bf713c6 Mon Sep 17 00:00:00 2001 From: Avamander Date: Mon, 4 Mar 2019 16:34:31 +0200 Subject: [PATCH 28/71] Update library.json --- library.json | 53 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/library.json b/library.json index 58e790a..b45ad16 100644 --- a/library.json +++ b/library.json @@ -1,22 +1,35 @@ { - "name": "RF24Mesh", - "keywords": "rf, radio, wireless, spi, mesh, network", - "description": "A simple and seamless 'mesh' layer for sensor networks. Designed to interface directly with with the RF24Network Development library, an OSI Network Layer using nRF24L01(+) radios driven by the newly optimized RF24 library fork.", - "repository": - { - "type": "git", - "url": "https://github.com/TMRh20/RF24Mesh.git" - }, - "version": "1.0.4", - "dependencies": [ - { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, - { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } - ], - "exclude": "examples_RPi", - "frameworks": "arduino", - "platforms": [ - "atmelavr", - "atmelsam", - "teensy" - ] + "name": "RF24Network", + "version": "1.0.8", + "keywords": "rf, radio, wireless, spi", + "description": "Optimized Network Layer for nRF24L01(+) Radios", + "license": "GPL-2.0-only", + "repository": { + "type": "git", + "url": "https://github.com/TMRh20/RF24Network.git" + }, + "dependencies": { + "name": "RF24", + "authors": "RF24", + "frameworks": "arduino" + }, + "exclude": [ + "examples/*", + "examples_RPi/*", + "RPi/*", + "tests/*" + ], + "frameworks": "arduino", + "platforms": [ + "atmelavr", + "atmelsam", + "teensy" + ], + "requires": [{ + "name": "RF24" + }, + { + "name": "RF24Network" + } + ] } From 5a1ec3797216cea1c3397296b03841cdec803697 Mon Sep 17 00:00:00 2001 From: Avamander Date: Fri, 22 Mar 2019 16:42:42 +0200 Subject: [PATCH 29/71] Update library.properties --- library.properties | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/library.properties b/library.properties index 87955c6..ac3b5ee 100644 --- a/library.properties +++ b/library.properties @@ -1,9 +1,9 @@ name=RF24Mesh version=1.0.51 author=TMRh20 -maintainer=TMRh20 +maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. paragraph=Provides a simple and seamless 'mesh' layer for sensor networks, allowing automatic and dynamic configuration that can be customized to suit many scenarios. It is currently designed to interface directly with with the RF24Network Development library, an OSI Network Layer using nRF24L01(+) radios driven by the newly optimized RF24 library fork. category=Communication -url=http://tmrh20.github.io/RF24Mesh/ -architectures=avr +url=https://tmrh20.github.io/RF24Mesh/ +architectures=avr,esp8266 From c76ab82c9a07edef467a77d137a8707e0338793a Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Wed, 8 May 2019 12:26:33 -0600 Subject: [PATCH 30/71] Update version for release --- library.json | 53 +++++++++++++++++----------------------------- library.properties | 2 +- 2 files changed, 21 insertions(+), 34 deletions(-) diff --git a/library.json b/library.json index b45ad16..713d079 100644 --- a/library.json +++ b/library.json @@ -1,35 +1,22 @@ { - "name": "RF24Network", - "version": "1.0.8", - "keywords": "rf, radio, wireless, spi", - "description": "Optimized Network Layer for nRF24L01(+) Radios", - "license": "GPL-2.0-only", - "repository": { - "type": "git", - "url": "https://github.com/TMRh20/RF24Network.git" - }, - "dependencies": { - "name": "RF24", - "authors": "RF24", - "frameworks": "arduino" - }, - "exclude": [ - "examples/*", - "examples_RPi/*", - "RPi/*", - "tests/*" - ], - "frameworks": "arduino", - "platforms": [ - "atmelavr", - "atmelsam", - "teensy" - ], - "requires": [{ - "name": "RF24" - }, - { - "name": "RF24Network" - } - ] + "name": "RF24Mesh", + "keywords": "rf, radio, wireless, spi, mesh, network", + "description": "A simple and seamless 'mesh' layer for sensor networks. Designed to interface directly with with the RF24Network Development library, an OSI Network Layer using nRF24L01(+) radios driven by the newly optimized RF24 library fork.", + "repository": + { + "type": "git", + "url": "https://github.com/TMRh20/RF24Mesh.git" + }, + "version": "1.0.6", + "dependencies": [ + { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, + { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } + ], + "exclude": "examples_RPi", + "frameworks": "arduino", + "platforms": [ + "atmelavr", + "atmelsam", + "teensy" + ] } diff --git a/library.properties b/library.properties index ac3b5ee..920977f 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=RF24Mesh -version=1.0.51 +version=1.0.6 author=TMRh20 maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. From 4b036cef093a2a262d88960616a2b4ca67f9debb Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Wed, 8 May 2019 13:00:23 -0600 Subject: [PATCH 31/71] Add mesh.begin() after failed renewal of address Enable recovery from most errors of the radio modules. This allows users to recover from wiring errors, hot-swapping of radios etc. without restarting the device. --- examples/RF24Mesh_Example/RF24Mesh_Example.ino | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/examples/RF24Mesh_Example/RF24Mesh_Example.ino b/examples/RF24Mesh_Example/RF24Mesh_Example.ino index 94bb8e1..e5bf6d5 100644 --- a/examples/RF24Mesh_Example/RF24Mesh_Example.ino +++ b/examples/RF24Mesh_Example/RF24Mesh_Example.ino @@ -1,4 +1,3 @@ - /** RF24Mesh_Example.ino by TMRh20 This example sketch shows how to manually configure a node via RF24Mesh, and send data to the @@ -67,7 +66,11 @@ void loop() { if ( ! mesh.checkConnection() ) { //refresh the network address Serial.println("Renewing Address"); - mesh.renewAddress(); + if(!mesh.renewAddress()){ + //If address renewal fails, reconfigure the radio and restart the mesh + //This allows recovery from most if not all radio errors + mesh.begin(); + } } else { Serial.println("Send fail, Test OK"); } From c992646742918e1ed479829c895e83b8677f1715 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 19 May 2019 14:01:40 -0600 Subject: [PATCH 32/71] Add one more step to address renewal - Found inconsistensies in address renewal, where a node would get a valid address, but the master node would not have the correct address. Perform an address lookup as the last step to address renewal. --- RF24Mesh.cpp | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index b92dc77..5e09280 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -413,6 +413,12 @@ bool RF24Mesh::requestAddress(uint8_t level){ delay(3); } + if(getNodeID(mesh_address) != getNodeID()){ + network.begin(MESH_DEFAULT_ADDRESS); + mesh_address = MESH_DEFAULT_ADDRESS; + return 0; + } + return 1; } @@ -646,4 +652,4 @@ void RF24Mesh::DHCP(){ /*****************************************************/ -#endif +#endif \ No newline at end of file From c7f64a6c37d798104c8239063df3184d278bda38 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 19 May 2019 15:20:16 -0600 Subject: [PATCH 33/71] Correct debug output --- RF24Mesh.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 5e09280..c91b638 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -330,7 +330,7 @@ bool RF24Mesh::requestAddress(uint8_t level){ #ifdef MESH_DEBUG_SERIAL Serial.print( millis() ); Serial.print(F(" MSH: Got poll from level ")); Serial.print(level); Serial.print(F(" count "));Serial.print(pollCount); - Serial.print(F(" node "));Serial.println(contactNode[pollCount]); // #ML# + Serial.print(F(" node "));Serial.println(contactNode[pollCount-1],OCT); // #ML# #elif defined MESH_DEBUG_PRINTF printf("%u MSH: Got poll from level %d count %d\n",millis(),level,pollCount); #endif From e7f90d898620f7d5d848d77b39b93a47ed912b24 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 19 May 2019 18:06:25 -0600 Subject: [PATCH 34/71] Change timeout for nodeID lookups --- RF24Mesh.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index c91b638..49764c5 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -208,7 +208,7 @@ int16_t RF24Mesh::getNodeID(uint16_t address){ if(mesh_address == MESH_DEFAULT_ADDRESS){ return -1; } RF24NetworkHeader header( 00, MESH_ID_LOOKUP ); if(network.write(header,&address,sizeof(address)) ){ - uint32_t timer=millis(), timeout = 500; + uint32_t timer=millis(), timeout = 150; while(network.update() != MESH_ID_LOOKUP){ if(millis()-timer > timeout){ return -1; } } From c27604a4dfb173a97fec0ad30f880b2f40442c18 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Tue, 21 May 2019 09:32:14 -0600 Subject: [PATCH 35/71] Add a second lookup to the end of address renewal Add a second lookup, to ensure nodes are getting a response --- RF24Mesh.cpp | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 49764c5..be5a9d1 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -414,9 +414,11 @@ bool RF24Mesh::requestAddress(uint8_t level){ } if(getNodeID(mesh_address) != getNodeID()){ - network.begin(MESH_DEFAULT_ADDRESS); - mesh_address = MESH_DEFAULT_ADDRESS; - return 0; + if(getNodeID(mesh_address) != getNodeID()){ + network.begin(MESH_DEFAULT_ADDRESS); + mesh_address = MESH_DEFAULT_ADDRESS; + return 0; + } } return 1; From 92a03c0c00a3a82c42704222dee46494e8da8ac4 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 26 May 2019 02:45:27 -0600 Subject: [PATCH 36/71] Remove address confirmations from address renewal With nodes performing an address lookup as the last step to renewal, an address confirmation message is no longer needed. --- RF24Mesh.cpp | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index be5a9d1..8398678 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -208,7 +208,7 @@ int16_t RF24Mesh::getNodeID(uint16_t address){ if(mesh_address == MESH_DEFAULT_ADDRESS){ return -1; } RF24NetworkHeader header( 00, MESH_ID_LOOKUP ); if(network.write(header,&address,sizeof(address)) ){ - uint32_t timer=millis(), timeout = 150; + uint32_t timer=millis(), timeout = 125; while(network.update() != MESH_ID_LOOKUP){ if(millis()-timer > timeout){ return -1; } } @@ -401,17 +401,17 @@ bool RF24Mesh::requestAddress(uint8_t level){ radio.stopListening(); delay(10); network.begin(mesh_address); - header.to_node = 00; - header.type = MESH_ADDR_CONFIRM; + //header.to_node = 00; + //header.type = MESH_ADDR_CONFIRM; - while( !network.write(header,0,0) ){ + /*while( !network.write(header,0,0) ){ if(registerAddrCount++ >= 6 ){ network.begin(MESH_DEFAULT_ADDRESS); mesh_address = MESH_DEFAULT_ADDRESS; return 0; } delay(3); - } + }*/ if(getNodeID(mesh_address) != getNodeID()){ if(getNodeID(mesh_address) != getNodeID()){ @@ -625,15 +625,15 @@ void RF24Mesh::DHCP(){ network.write(header,&newAddress,sizeof(newAddress),header.to_node); //addrMap[from_id] = newAddress; } - uint32_t timer=millis(); + //uint32_t timer=millis(); lastAddress = newAddress; lastID = from_id; - while(network.update() != MESH_ADDR_CONFIRM){ - if(millis()-timer > network.routeTimeout){ - return; - } - - } + //while(network.update() != MESH_ADDR_CONFIRM){ + // if(millis()-timer > network.routeTimeout){ + // return; + // } + // + //} setAddress(from_id,newAddress); #ifdef MESH_DEBUG_PRINTF printf("Sent to 0%o phys: 0%o new: 0%o id: %d\n", header.to_node,MESH_DEFAULT_ADDRESS,newAddress,header.reserved); From 67bc9ab7b9bab5522382d286bd26a1839f1d0f5e Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 26 May 2019 02:54:20 -0600 Subject: [PATCH 37/71] Update readme --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 0b64b49..f30746c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ RF24Mesh ======== -Initial concept and design stage: Mesh Networking for RF24Network https://tmrh20.github.io/RF24Mesh \ No newline at end of file From 6252c3ab3896a9cc0fa52011caae51056bfe57dd Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 26 May 2019 02:55:38 -0600 Subject: [PATCH 38/71] Update RF24Mesh.h documentation --- RF24Mesh.h | 3 --- 1 file changed, 3 deletions(-) diff --git a/RF24Mesh.h b/RF24Mesh.h index 2c7d7b7..f350466 100644 --- a/RF24Mesh.h +++ b/RF24Mesh.h @@ -381,9 +381,6 @@ class RF24Mesh * @li Dynamic/On-the fly configuration of addresses and network topology * @li Automatic routing and handling of data - Nodes will join together to extend the range of radio links by routing data as required. * - * Status (Dec 2015) - * @li RF24Mesh is mostly complete and stable, but is being actively utilized & tested with development ongoing. - * @li Address assignments are not saved, except on RPi/Linux devices. If the 'master' node goes down, all nodes need to reconnect to the mesh or restart to prevent addressing conflicts. * * * @section More How to learn more From 7760101df09402ba7daf653431971486a2877965 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 26 May 2019 02:58:23 -0600 Subject: [PATCH 39/71] Update version for release --- library.json | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/library.json b/library.json index 713d079..1fdde02 100644 --- a/library.json +++ b/library.json @@ -7,7 +7,7 @@ "type": "git", "url": "https://github.com/TMRh20/RF24Mesh.git" }, - "version": "1.0.6", + "version": "1.0.7", "dependencies": [ { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } diff --git a/library.properties b/library.properties index 920977f..dc4b580 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=RF24Mesh -version=1.0.6 +version=1.0.7 author=TMRh20 maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. From eacd24f63e3f3cccfecb2997696070cd06fa3cc2 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 24 May 2020 21:44:55 -0600 Subject: [PATCH 40/71] checkConnection verify connection both ways The checkConnection() function previously only tested connectivity from node->master. This modification tests connectivity node->master->node. This should ensure proper maintenance of the mesh for new users and make things less confusing. Behavior changes a bit, since the test is only performed once, where previously, three attempts were performed. #174 #165 #78 --- RF24Mesh.cpp | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 8398678..2b6c849 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -138,21 +138,8 @@ void RF24Mesh::setChild(bool allow){ /*****************************************************/ bool RF24Mesh::checkConnection(){ - - uint8_t count = 3; - bool ok = 0; - while(count-- && mesh_address != MESH_DEFAULT_ADDRESS){ - update(); - if(radio.rxFifoFull() || (network.networkFlags & 1)){ - return 1; - } - RF24NetworkHeader header(00,NETWORK_PING); - ok = network.write(header,0,0); - if(ok){break;} - delay(103); - } - if(!ok){ radio.stopListening(); } - return ok; + + return (getAddress(_nodeID) >= 0 ? true : false); } From 409e4092296b199250c6d79e64c1515c641d97b2 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Wed, 27 May 2020 08:27:58 -0600 Subject: [PATCH 41/71] Update library.properties Add dependencies --- library.properties | 1 + 1 file changed, 1 insertion(+) diff --git a/library.properties b/library.properties index dc4b580..8ecafb2 100644 --- a/library.properties +++ b/library.properties @@ -7,3 +7,4 @@ paragraph=Provides a simple and seamless 'mesh' layer for sensor networks, allow category=Communication url=https://tmrh20.github.io/RF24Mesh/ architectures=avr,esp8266 +depends=RF24,RF24Network From d4c8e68b8b4f88e3e70222739b1d5718145e1422 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sun, 7 Jun 2020 21:05:11 -0600 Subject: [PATCH 42/71] Update version for release --- library.json | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/library.json b/library.json index 1fdde02..5a391aa 100644 --- a/library.json +++ b/library.json @@ -7,7 +7,7 @@ "type": "git", "url": "https://github.com/TMRh20/RF24Mesh.git" }, - "version": "1.0.7", + "version": "1.0.8", "dependencies": [ { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } diff --git a/library.properties b/library.properties index 8ecafb2..3dedbec 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=RF24Mesh -version=1.0.7 +version=1.0.8 author=TMRh20 maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. From 556347426608ffb4d5f4df0d64474c605bf9ffa5 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Mon, 8 Jun 2020 09:40:00 -0600 Subject: [PATCH 43/71] Update versioning to fix problems Previous RF24Mesh release v1.0.51 messed up the versioning. Moving to v1.1.0 to fix this. --- library.json | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/library.json b/library.json index 5a391aa..8b7a4cc 100644 --- a/library.json +++ b/library.json @@ -7,7 +7,7 @@ "type": "git", "url": "https://github.com/TMRh20/RF24Mesh.git" }, - "version": "1.0.8", + "version": "1.1.0", "dependencies": [ { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } diff --git a/library.properties b/library.properties index 3dedbec..85d5dcc 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=RF24Mesh -version=1.0.8 +version=1.1.0 author=TMRh20 maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. From e00a9d522fc217257298e653001a68e2afb3e60b Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Mon, 27 Jul 2020 00:20:02 -0600 Subject: [PATCH 44/71] Fix: Issue with renewAddress() - In attempts to prevent data loss, this function previously returned if radio data was available. Currently calls network.update() instead to try and buffer available data before transmission --- RF24Mesh.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 2b6c849..be85413 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -225,7 +225,7 @@ bool RF24Mesh::releaseAddress(){ uint16_t RF24Mesh::renewAddress(uint32_t timeout){ - if(radio.available()){ return 0; } + if(radio.available()){ network.update(); } uint8_t reqCounter = 0; uint8_t totalReqs = 0; radio.stopListening(); From b30b18281cf64812266b8e4db0b823e3cd088fef Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Wed, 29 Jul 2020 21:12:22 -0600 Subject: [PATCH 45/71] Dynamic memory allocation & fixes - Allocate/Reallocate memory in chunks of 10 structs instead of 1. Allows for up to 10 nodes in the address list before memory is re-allocated. - Do not do initial memory allocation if begin() has already been called - Reset network flags on timeout in renewAddress(); - Fix warnings related to improper variable type and unassigned variable --- RF24Mesh.cpp | 84 +++++++++++++++++++++------------------------------- RF24Mesh.h | 3 +- 2 files changed, 36 insertions(+), 51 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index be85413..d509a41 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -21,17 +21,20 @@ bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeou radio.setDataRate(data_rate); network.returnSysMsgs = 1; - if(getNodeID()){ //Not master node + if(getNodeID() > 0){ //Not master node mesh_address = MESH_DEFAULT_ADDRESS; if(!renewAddress(timeout)){ return 0; } }else{ - #if !defined (RF24_TINY) && !defined(MESH_NOMASTER) - addrList = (addrListStruct*)malloc(2 * sizeof(addrListStruct)); - addrListTop = 0; - loadDHCP(); - #endif + #if !defined (RF24_TINY) && !defined(MESH_NOMASTER) + if( !addrMemAllocated ){ + addrMemAllocated = 1; + addrList = (addrListStruct*)malloc( (10 * sizeof(addrListStruct)) ); + addrListTop = 0; + loadDHCP(); + } + #endif mesh_address = 0; network.begin(mesh_address); } @@ -103,7 +106,7 @@ bool RF24Mesh::write(const void* data, uint8_t msg_type, size_t size, uint8_t no if(mesh_address == MESH_DEFAULT_ADDRESS){ return 0; } int16_t toNode = 0; - int32_t lookupTimeout = millis()+ MESH_LOOKUP_TIMEOUT; + uint32_t lookupTimeout = millis()+ MESH_LOOKUP_TIMEOUT; uint32_t retryDelay = 50; if(nodeID){ @@ -238,7 +241,7 @@ uint16_t RF24Mesh::renewAddress(uint32_t timeout){ uint32_t start = millis(); while(!requestAddress(reqCounter)){ - if(millis()-start > timeout){ return 0; } + if(millis()-start > timeout){ network.networkFlags &= ~2; return 0; } delay(50 + ( (totalReqs+1)*(reqCounter+1)) * 2); reqCounter++; reqCounter = reqCounter%4; @@ -356,7 +359,6 @@ bool RF24Mesh::requestAddress(uint8_t level){ #ifdef MESH_DEBUG_SERIAL uint8_t mask = 7; char addrs[5] = " ", count=3; uint16_t newAddr; #endif - uint8_t registerAddrCount = 0; uint16_t newAddress=0; //memcpy(&addrResponse,network.frame_buffer+sizeof(RF24NetworkHeader),sizeof(addrResponse)); @@ -440,21 +442,20 @@ void RF24Mesh::setStaticAddress(uint8_t nodeID, uint16_t address){ void RF24Mesh::setAddress(uint8_t nodeID, uint16_t address){ - uint8_t position = addrListTop; + //Look for the node in the list for(uint8_t i=0; i 0 && addrListTop % 10 == 0){ + addrList = (addrListStruct*)realloc(addrList,(addrListTop + 10) * sizeof(addrListStruct)); } + addrList[addrListTop].address = address; + addrList[addrListTop++].nodeID = nodeID; //Set the value AND increment Top without another line of code #if defined (__linux) && !defined(__ARDUINO_X86__) //if(millis()-lastFileSave > 300){ @@ -462,7 +463,6 @@ void RF24Mesh::setAddress(uint8_t nodeID, uint16_t address){ saveDHCP(); //} #endif - } /*****************************************************/ @@ -473,19 +473,15 @@ void RF24Mesh::loadDHCP(){ std::ifstream infile ("dhcplist.txt",std::ifstream::binary); if(!infile){ return; } - addrList[addrListTop].nodeID = 255; - addrList[addrListTop].address = 01114; - infile.seekg(0,infile.end); int length = infile.tellg(); infile.seekg(0,infile.beg); - addrList = (addrListStruct*)realloc(addrList,length + sizeof(addrListStruct)); - - addrListTop = length/sizeof(addrListStruct); - for(int i=0; i network.routeTimeout){ - // return; - // } - // - //} - setAddress(from_id,newAddress); + }else{ + delay(2); + network.write(header,&newAddress,sizeof(newAddress),header.to_node); + } + + lastAddress = newAddress; + lastID = from_id; + + setAddress(from_id,newAddress); #ifdef MESH_DEBUG_PRINTF printf("Sent to 0%o phys: 0%o new: 0%o id: %d\n", header.to_node,MESH_DEFAULT_ADDRESS,newAddress,header.reserved); #endif - break; + break; }else{ #if defined (MESH_DEBUG_PRINTF) - printf("not allocated\n"); + printf("not allocated\n"); #endif } } - - //}else{ - //break; - //} - } /*****************************************************/ diff --git a/RF24Mesh.h b/RF24Mesh.h index f350466..33741b4 100644 --- a/RF24Mesh.h +++ b/RF24Mesh.h @@ -239,7 +239,7 @@ class RF24Mesh uint8_t _nodeID; -#if !defined RF24TINY +#if !defined (RF24_TINY) && !defined(MESH_NOMASTER) typedef struct{ uint8_t nodeID; /**< NodeIDs and addresses are stored in the addrList array using this structure */ uint16_t address; /**< NodeIDs and addresses are stored in the addrList array using this structure */ @@ -273,6 +273,7 @@ class RF24Mesh uint32_t lastFileSave; uint8_t radio_channel; uint16_t lastID,lastAddress; + bool addrMemAllocated; /** Date: Fri, 31 Jul 2020 11:19:22 -0600 Subject: [PATCH 46/71] BIg cleanup and some fixes - Adjust timeouts - Add defines for WRITE and LOOKUP timeouts + documentation - Allow user defined memory allocation for address list - Call stopListening() before adjusting radio channel - Change checkConnection to return true only if returned address is > 0. Allows master node to zero out unused network addresses to 'remove' nodes from the address list. - Make the master return -2 on address lookup timeout. Allows nodes to timeout quickly if lookup successful, but node not found - Cleanup & unify getNodeID and getAddress functions - Modify/Clean up defines for MESH_NOMASTER to reduce program space & memory when this is defined - General cleanup convert tabs to spaces, remove unused variables --- RF24Mesh.cpp | 270 ++++++++++++++++++++-------------------------- RF24Mesh.h | 46 ++++---- RF24Mesh_config.h | 35 ++++-- 3 files changed, 170 insertions(+), 181 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index d509a41..216f17b 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -16,8 +16,7 @@ RF24Mesh::RF24Mesh( RF24& _radio,RF24Network& _network ): radio(_radio),network( bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeout){ //delay(1); // Found problems w/SPIDEV & ncurses. Without this, getch() returns a stream of garbage radio.begin(); - radio_channel = channel; - radio.setChannel(radio_channel); + radio.setChannel(channel); radio.setDataRate(data_rate); network.returnSysMsgs = 1; @@ -30,7 +29,7 @@ bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeou #if !defined (RF24_TINY) && !defined(MESH_NOMASTER) if( !addrMemAllocated ){ addrMemAllocated = 1; - addrList = (addrListStruct*)malloc( (10 * sizeof(addrListStruct)) ); + addrList = (addrListStruct*)malloc( (MESH_MEM_ALLOC_SIZE * sizeof(addrListStruct)) ); addrListTop = 0; loadDHCP(); } @@ -44,56 +43,46 @@ bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeou /*****************************************************/ -uint8_t RF24Mesh::update(){ - - +uint8_t RF24Mesh::update(){ - uint8_t type = network.update(); + uint8_t type = network.update(); if(mesh_address == MESH_DEFAULT_ADDRESS){ return type; } - #if !defined (RF24_TINY) && !defined(MESH_NOMASTER) - if(type == NETWORK_REQ_ADDRESS){ - doDHCP = 1; - } - - if(!getNodeID()){ - if( (type == MESH_ADDR_LOOKUP || type == MESH_ID_LOOKUP)) { - RF24NetworkHeader& header = *(RF24NetworkHeader*)network.frame_buffer; - header.to_node = header.from_node; - - if(type==MESH_ADDR_LOOKUP){ - int16_t returnAddr = getAddress(network.frame_buffer[sizeof(RF24NetworkHeader)]); - network.write(header,&returnAddr,sizeof(returnAddr)); - }else{ - int16_t returnAddr = getNodeID(network.frame_buffer[sizeof(RF24NetworkHeader)]); - network.write(header,&returnAddr,sizeof(returnAddr)); - } - //printf("Returning lookup 0%o to 0%o \n",returnAddr,header.to_node); - //network.write(header,&returnAddr,sizeof(returnAddr)); - }else - if(type == MESH_ADDR_RELEASE ){ - uint16_t *fromAddr = (uint16_t*)network.frame_buffer; - for(uint8_t i=0; ito_node = header->from_node; + + if(type==MESH_ADDR_LOOKUP){ + int16_t returnAddr = getAddress(network.frame_buffer[sizeof(RF24NetworkHeader)]); + network.write(*header,&returnAddr,sizeof(returnAddr)); + }else{ + int16_t returnAddr = getNodeID(network.frame_buffer[sizeof(RF24NetworkHeader)]); + network.write(*header,&returnAddr,sizeof(returnAddr)); + } + + }else + if(type == MESH_ADDR_RELEASE ){ + uint16_t *fromAddr = (uint16_t*)network.frame_buffer; + for(uint8_t i=0; i lookupTimeout || toNode == -2){ return 0; } - retryDelay+=50; + retryDelay+=10; delay(retryDelay); - } + } } return write(toNode,data,msg_type,size); } @@ -126,11 +115,13 @@ bool RF24Mesh::write(const void* data, uint8_t msg_type, size_t size, uint8_t no void RF24Mesh::setChannel(uint8_t _channel){ - radio_channel = _channel; - radio.setChannel(radio_channel); - radio.startListening(); + radio.stopListening(); + radio.setChannel(_channel); + radio.startListening(); } + /*****************************************************/ + void RF24Mesh::setChild(bool allow){ //Prevent old versions of RF24Network from throwing an error //Note to remove this ""if defined"" after a few releases from 1.0.1 @@ -138,74 +129,79 @@ void RF24Mesh::setChild(bool allow){ network.networkFlags = allow ? network.networkFlags & ~FLAG_NO_POLL : network.networkFlags | FLAG_NO_POLL; #endif } + /*****************************************************/ bool RF24Mesh::checkConnection(){ - return (getAddress(_nodeID) >= 0 ? true : false); + return (getAddress(_nodeID) > 0 ? true : false); } /*****************************************************/ -int16_t RF24Mesh::getAddress(uint8_t nodeID){ - -//#if defined (ARDUINO_SAM_DUE) || defined (__linux) -#if !defined RF24_TINY && !defined(MESH_NOMASTER) - if(!getNodeID()){ //Master Node - uint16_t address = 0; - for(uint8_t i=0; i timeout){ return -1; } - } - }else{ - return -1; + if(mesh_address == MESH_DEFAULT_ADDRESS){ return -2; } + + + // Lets say 0 if nodeID 0, -1 if write failed or timed out, -2 if not found in list or address is default, + #if !defined(MESH_NOMASTER) + if(!getNodeID()){ //Master Node + for(uint8_t i=0; i= 0 ? address: -2; + #endif + + RF24NetworkHeader header( 00, MESH_ADDR_LOOKUP ); + if(network.write(header,&nodeID,sizeof(nodeID)) ){ + uint32_t timer = millis(), timeout = MESH_LOOKUP_TIMEOUT; + while(network.update() != MESH_ADDR_LOOKUP){ + if(millis()-timer > timeout){ return -1; } + } + int16_t address = 0; + memcpy(&address,network.frame_buffer+sizeof(RF24NetworkHeader),sizeof(address)); + return address; + } + return -1; } +/*****************************************************/ + int16_t RF24Mesh::getNodeID(uint16_t address){ - if(address == MESH_BLANK_ID){ - return _nodeID; - }else - if(address == 0){ - return 0; - } + if(address == MESH_BLANK_ID){ return _nodeID; } + if(address == 0){ return 0; } + if(mesh_address == MESH_DEFAULT_ADDRESS){ return -2; } + + + #if !defined(MESH_NOMASTER) if(!mesh_address){ //Master Node - for(uint8_t i=0; i timeout){ return -1; } - } - int16_t ID; - memcpy(&ID,&network.frame_buffer[sizeof(RF24NetworkHeader)],sizeof(ID)); - return ID; } + return -2; + } + #endif + + RF24NetworkHeader header( 00, MESH_ID_LOOKUP ); + if(network.write(header,&address,sizeof(address)) ){ + uint32_t timer=millis(), timeout = MESH_LOOKUP_TIMEOUT; + while(network.update() != MESH_ID_LOOKUP){ + if(millis()-timer > timeout){ return -1; } + } + int16_t ID; + memcpy(&ID,&network.frame_buffer[sizeof(RF24NetworkHeader)],sizeof(ID)); + return ID; } return -1; } @@ -390,17 +386,6 @@ bool RF24Mesh::requestAddress(uint8_t level){ radio.stopListening(); delay(10); network.begin(mesh_address); - //header.to_node = 00; - //header.type = MESH_ADDR_CONFIRM; - - /*while( !network.write(header,0,0) ){ - if(registerAddrCount++ >= 6 ){ - network.begin(MESH_DEFAULT_ADDRESS); - mesh_address = MESH_DEFAULT_ADDRESS; - return 0; - } - delay(3); - }*/ if(getNodeID(mesh_address) != getNodeID()){ if(getNodeID(mesh_address) != getNodeID()){ @@ -433,6 +418,7 @@ void RF24Mesh::setNodeID(uint8_t nodeID){ } /*****************************************************/ +#if !defined(MESH_NOMASTER) void RF24Mesh::setStaticAddress(uint8_t nodeID, uint16_t address){ setAddress(nodeID,address); @@ -447,22 +433,21 @@ void RF24Mesh::setAddress(uint8_t nodeID, uint16_t address){ for(uint8_t i=0; i 0 && addrListTop % 10 == 0){ - addrList = (addrListStruct*)realloc(addrList,(addrListTop + 10) * sizeof(addrListStruct)); + if(addrListTop > 0 && addrListTop % MESH_MEM_ALLOC_SIZE == 0){ + addrList = (addrListStruct*)realloc(addrList,(addrListTop + MESH_MEM_ALLOC_SIZE) * sizeof(addrListStruct)); } addrList[addrListTop].address = address; - addrList[addrListTop++].nodeID = nodeID; //Set the value AND increment Top without another line of code - - #if defined (__linux) && !defined(__ARDUINO_X86__) - //if(millis()-lastFileSave > 300){ - // lastFileSave = millis(); - saveDHCP(); - //} - #endif + addrList[addrListTop++].nodeID = nodeID; //Set the value AND increment Top without another line of code + #if defined (__linux) && !defined(__ARDUINO_X86__) + saveDHCP(); + #endif } /*****************************************************/ @@ -490,36 +475,20 @@ void RF24Mesh::loadDHCP(){ /*****************************************************/ void RF24Mesh::saveDHCP(){ -#if defined (__linux) && !defined(__ARDUINO_X86__) - std::ofstream outfile ("dhcplist.txt",std::ofstream::binary | std::ofstream::trunc); + #if defined (__linux) && !defined(__ARDUINO_X86__) + std::ofstream outfile ("dhcplist.txt",std::ofstream::binary | std::ofstream::trunc); - //printf("writingToFile %d 0%o size %d\n",addrList[0].nodeID,addrList[0].address,sizeof(addrListStruct)); - - for(int i=0; i< addrListTop; i++){ - outfile.write( (char*)&addrList[i],sizeof(addrListStruct)); + for(int i=0; i< addrListTop; i++){ + outfile.write( (char*)&addrList[i],sizeof(addrListStruct)); } - outfile.close(); - - /*addrListStruct aList; - std::ifstream infile ("dhcplist.txt",std::ifstream::binary); - infile.seekg(0,infile.end); - int length = infile.tellg(); - infile.seekg(0,infile.beg); - //addrList = (addrListStruct*)malloc(length); - - //infile.read( (char*)&addrList,length); - infile.read( (char*)&aList,sizeof(addrListStruct)); - //addrListTop = length/sizeof(addrListStruct); - //for(int i=0; i< addrListTop; i++){ - printf("ID: %d ADDR: 0%o \n",aList.nodeID,aList.address); - //} - infile.close();*/ -#endif + outfile.close(); + + #endif// __linux not X86 } /*****************************************************/ -#if !defined (RF24_TINY) && !defined(MESH_NOMASTER) + void RF24Mesh::DHCP(){ @@ -607,9 +576,6 @@ void RF24Mesh::DHCP(){ network.write(header,&newAddress,sizeof(newAddress),header.to_node); } - lastAddress = newAddress; - lastID = from_id; - setAddress(from_id,newAddress); #ifdef MESH_DEBUG_PRINTF printf("Sent to 0%o phys: 0%o new: 0%o id: %d\n", header.to_node,MESH_DEFAULT_ADDRESS,newAddress,header.reserved); @@ -625,4 +591,4 @@ void RF24Mesh::DHCP(){ /*****************************************************/ -#endif \ No newline at end of file +#endif // !MESH_NOMASTER diff --git a/RF24Mesh.h b/RF24Mesh.h index 33741b4..a331630 100644 --- a/RF24Mesh.h +++ b/RF24Mesh.h @@ -18,7 +18,8 @@ */ // Network ACK types -#define MESH_ADDR_CONFIRM 129 +// None defined + // No Network ACK types #define MESH_ADDR_LOOKUP 196 #define MESH_ADDR_RELEASE 197 @@ -126,12 +127,15 @@ class RF24Mesh */ void setNodeID(uint8_t nodeID); + #if !defined(MESH_NOMASTER) /** * Only to be used on the master node. Provides automatic configuration for sensor nodes, similar to DHCP. * Call immediately after calling network.update() to ensure address requests are handled appropriately */ void DHCP(); + #endif + /**@}*/ /** * @name Advanced Operation @@ -208,6 +212,7 @@ class RF24Mesh */ void setChild(bool allow); + #if !defined(MESH_NOMASTER) /** * Set/change a nodeID/RF24Network Address pair manually on the master node. * @@ -221,11 +226,25 @@ class RF24Mesh * @param address The octal RF24Network address to assign * @return If the nodeID exists in the list, */ - void setAddress(uint8_t nodeID, uint16_t address); + void setAddress(uint8_t nodeID, uint16_t address); void saveDHCP(); void loadDHCP(); + /** + * @name Deprecated + * + * Methods provided for backwards compabibility with old/testing code. + */ + /**@{*/ + + /** + * Calls setAddress() + */ + void setStaticAddress(uint8_t nodeID, uint16_t address); + + #endif + /**@}*/ /** * @name Address list struct @@ -239,7 +258,7 @@ class RF24Mesh uint8_t _nodeID; -#if !defined (RF24_TINY) && !defined(MESH_NOMASTER) +#if !defined(MESH_NOMASTER) typedef struct{ uint8_t nodeID; /**< NodeIDs and addresses are stored in the addrList array using this structure */ uint16_t address; /**< NodeIDs and addresses are stored in the addrList array using this structure */ @@ -249,31 +268,18 @@ class RF24Mesh addrListStruct *addrList; /**< See the addrListStruct class reference */ uint8_t addrListTop; /**< The number of entries in the assigned address list */ #endif - - /** - * @name Deprecated - * - * Methods provided for backwards compabibility with old/testing code. - */ - /**@{*/ - - /** - * Calls setAddress() - */ - void setStaticAddress(uint8_t nodeID, uint16_t address); private: RF24& radio; RF24Network& network; - bool findNodes(RF24NetworkHeader& header, uint8_t level, uint16_t *address); /**< Broadcasts to all multicast levels to find available nodes **/ + bool requestAddress(uint8_t level); /**< Actual requesting of the address once a contact node is discovered or supplied **/ bool waitForAvailable(uint32_t timeout); /**< Waits for data to become available */ + + #if !defined(MESH_NOMASTER) bool doDHCP; /**< Indicator that an address request is available */ - uint32_t lastSaveTime; - uint32_t lastFileSave; - uint8_t radio_channel; - uint16_t lastID,lastAddress; bool addrMemAllocated; /** Date: Sat, 1 Aug 2020 03:11:47 -0600 Subject: [PATCH 47/71] Update version & architectures --- library.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index 85d5dcc..afe973c 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ name=RF24Mesh -version=1.1.0 +version=1.1.1 author=TMRh20 maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. paragraph=Provides a simple and seamless 'mesh' layer for sensor networks, allowing automatic and dynamic configuration that can be customized to suit many scenarios. It is currently designed to interface directly with with the RF24Network Development library, an OSI Network Layer using nRF24L01(+) radios driven by the newly optimized RF24 library fork. category=Communication url=https://tmrh20.github.io/RF24Mesh/ -architectures=avr,esp8266 +architectures=* depends=RF24,RF24Network From 7e5e920ae82fa03942505fccba1e78ed7aa734d4 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sat, 1 Aug 2020 03:12:12 -0600 Subject: [PATCH 48/71] Update version for release --- library.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.json b/library.json index 8b7a4cc..bbefd52 100644 --- a/library.json +++ b/library.json @@ -7,7 +7,7 @@ "type": "git", "url": "https://github.com/TMRh20/RF24Mesh.git" }, - "version": "1.1.0", + "version": "1.1.1", "dependencies": [ { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } From 2af965350d55a219bed9344fc79b7e28fe9b8207 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Tue, 4 Aug 2020 15:00:26 -0600 Subject: [PATCH 49/71] Address request/renew improvement - When requesting an address, nodes use multicast so it is normal to receive NETWORK_ADDR_RESPONSE payloads destined for other nodes - Instead of accepting incorrect responses then returning 0 later, nodes will filter out those responses and continue with the next received response or iteration of the loop - Improves renewals when a number of nodes are requesting addresses simultaneously --- RF24Mesh.cpp | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 216f17b..9146b8d 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -321,6 +321,7 @@ bool RF24Mesh::requestAddress(uint8_t level){ printf("%u MSH: Got poll from level %d count %d\n",millis(),level,pollCount); #endif + bool gotResponse = 0; uint8_t type=0; for(uint8_t i=0; i Date: Tue, 4 Aug 2020 20:01:32 -0600 Subject: [PATCH 50/71] Fixes,cleanup and improvements - Have the checkConnection function check a second time if it fails the first time, to bring stability back in line with previous iterations - Add private beginDefault() function since the same code was being called multiple times, and one was missing call to stopListening() (a likely cause of issues) - Fix debugging printouts - Remove some unnecessary delays --- RF24Mesh.cpp | 48 +++++++++++++++++++++++++++--------------------- RF24Mesh.h | 1 + 2 files changed, 28 insertions(+), 21 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 9146b8d..c1da963 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -26,7 +26,7 @@ bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeou return 0; } }else{ - #if !defined (RF24_TINY) && !defined(MESH_NOMASTER) + #if !defined(MESH_NOMASTER) if( !addrMemAllocated ){ addrMemAllocated = 1; addrList = (addrListStruct*)malloc( (MESH_MEM_ALLOC_SIZE * sizeof(addrListStruct)) ); @@ -134,8 +134,12 @@ void RF24Mesh::setChild(bool allow){ bool RF24Mesh::checkConnection(){ - return (getAddress(_nodeID) > 0 ? true : false); - + if(getAddress(_nodeID) < 1){ + if(getAddress(_nodeID) < 1){ + return false; + } + } + return true; } /*****************************************************/ @@ -205,6 +209,15 @@ int16_t RF24Mesh::getNodeID(uint16_t address){ } return -1; } + +/*****************************************************/ + +void RF24Mesh::beginDefault(){ + radio.stopListening(); + network.begin(MESH_DEFAULT_ADDRESS); + mesh_address=MESH_DEFAULT_ADDRESS; +} + /*****************************************************/ bool RF24Mesh::releaseAddress(){ @@ -213,9 +226,8 @@ bool RF24Mesh::releaseAddress(){ RF24NetworkHeader header(00,MESH_ADDR_RELEASE); if(network.write(header,0,0)){ - network.begin(MESH_DEFAULT_ADDRESS); - mesh_address=MESH_DEFAULT_ADDRESS; - return 1; + beginDefault(); + return 1; } return 0; } @@ -227,13 +239,9 @@ uint16_t RF24Mesh::renewAddress(uint32_t timeout){ if(radio.available()){ network.update(); } uint8_t reqCounter = 0; uint8_t totalReqs = 0; - radio.stopListening(); - - network.networkFlags |= 2; - delay(10); - network.begin(MESH_DEFAULT_ADDRESS); - mesh_address = MESH_DEFAULT_ADDRESS; + beginDefault(); + network.networkFlags |= 2; uint32_t start = millis(); while(!requestAddress(reqCounter)){ @@ -261,7 +269,7 @@ bool RF24Mesh::requestAddress(uint8_t level){ network.multicast(header,0,0,level); uint32_t timr = millis(); - #define MESH_MAXPOLLS 4 + #define MESH_MAXPOLLS 4 uint16_t contactNode[MESH_MAXPOLLS]; uint8_t pollCount=0; @@ -348,16 +356,15 @@ bool RF24Mesh::requestAddress(uint8_t level){ } } } - delay(5); } if(!gotResponse){ return 0; } - //Serial.print("response took"); - //Serial.println(millis()-timr); #ifdef MESH_DEBUG_SERIAL - uint8_t mask = 7; char addrs[5] = " ", count=3; uint16_t newAddr; + uint8_t mask = 7, count=3; + char addrs[5] = " "; + uint16_t newAddr; #endif uint16_t newAddress=0; @@ -379,13 +386,11 @@ bool RF24Mesh::requestAddress(uint8_t level){ mesh_address = newAddress; radio.stopListening(); - delay(10); network.begin(mesh_address); if(getNodeID(mesh_address) != getNodeID()){ if(getNodeID(mesh_address) != getNodeID()){ - network.begin(MESH_DEFAULT_ADDRESS); - mesh_address = MESH_DEFAULT_ADDRESS; + beginDefault(); return 0; } } @@ -538,7 +543,8 @@ void RF24Mesh::DHCP(){ #if !defined (__linux) && !defined ARDUINO_SAM_DUE || defined TEENSY || defined(__ARDUINO_X86__) Serial.print("ID: ");Serial.print(addrList[i].nodeID,DEC);Serial.print(" ADDR: "); uint16_t newAddr = addrList[i].address; - char addr[5] = " ", count=3, mask=7; + char addr[5] = " "; + uint8_t count=3,mask=7; while(newAddr){ addr[count] = (newAddr & mask)+48; //get the individual Octal numbers, specified in chunks of 3 bits, convert to ASCII by adding 48 newAddr >>= 3; diff --git a/RF24Mesh.h b/RF24Mesh.h index a331630..7eef04f 100644 --- a/RF24Mesh.h +++ b/RF24Mesh.h @@ -280,6 +280,7 @@ class RF24Mesh bool doDHCP; /**< Indicator that an address request is available */ bool addrMemAllocated; /** Date: Tue, 4 Aug 2020 20:35:34 -0600 Subject: [PATCH 51/71] One little adjustment - Found this value should be higher. Lower value works on most devices, but not one RPi Model B --- RF24Mesh_config.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RF24Mesh_config.h b/RF24Mesh_config.h index e8c7436..c5fc4ea 100644 --- a/RF24Mesh_config.h +++ b/RF24Mesh_config.h @@ -35,7 +35,7 @@ * For Level 1 nodes a response typically takes 2-3ms in good conditions. * For Level 2 nodes: 4-5ms, Level 3: 6-15ms, Level 4: 10-25ms **/ -#define MESH_LOOKUP_TIMEOUT 55 +#define MESH_LOOKUP_TIMEOUT 135 #define MESH_WRITE_TIMEOUT 115 /** How long mesh.write retries address lookups before timing out. Allows multiple attempts */ #define MESH_DEFAULT_ADDRESS NETWORK_DEFAULT_ADDRESS From bbc996bbf33501deee153fea3c6a627cc534445f Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Tue, 4 Aug 2020 22:00:43 -0600 Subject: [PATCH 52/71] Minor correction on master nodes - Found if DHCP() function is not immediately called after update() function, bad information can be processed. Should never happen but can if code is out of order etc. (See RF24Gateway lol) - Check for valid header type. - Also remove unneccessary value from_id --- RF24Mesh.cpp | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index c1da963..410824e 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -500,11 +500,10 @@ void RF24Mesh::DHCP(){ uint16_t newAddress; - // Get the unique id of the requester - uint8_t from_id = header.reserved; - if(!from_id){ + // Get the unique id of the requester (ID is in header.reserved) + if(!header.reserved || header.type != NETWORK_REQ_ADDRESS){ #ifdef MESH_DEBUG_PRINTF - printf("MSH: Invalid id 0 rcvd\n"); + printf("MSH: Invalid id or type rcvd\n"); #endif return; } @@ -529,7 +528,7 @@ void RF24Mesh::DHCP(){ } #ifdef MESH_DEBUG_PRINTF - // printf("%u MSH: Rcv addr req from_id %d \n",millis(),from_id); + // printf("%u MSH: Rcv addr req from_id %d \n",millis(),header.reserved); #endif for(int i=MESH_MAX_CHILDREN+extraChild; i> 0; i--){ // For each of the possible addresses (5 max) @@ -555,7 +554,7 @@ void RF24Mesh::DHCP(){ printf("ID: %d ADDR: 0%o\n", addrList[i].nodeID,addrList[i].address); #endif #endif - if( (addrList[i].address == newAddress && addrList[i].nodeID != from_id ) || newAddress == MESH_DEFAULT_ADDRESS){ + if( (addrList[i].address == newAddress && addrList[i].nodeID != header.reserved ) || newAddress == MESH_DEFAULT_ADDRESS){ found = 1; break; } @@ -577,7 +576,7 @@ void RF24Mesh::DHCP(){ network.write(header,&newAddress,sizeof(newAddress),header.to_node); } - setAddress(from_id,newAddress); + setAddress(header.reserved,newAddress); #ifdef MESH_DEBUG_PRINTF printf("Sent to 0%o phys: 0%o new: 0%o id: %d\n", header.to_node,MESH_DEFAULT_ADDRESS,newAddress,header.reserved); #endif From c957217c3cd4951c5dfa98139112c049e504be7f Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Wed, 5 Aug 2020 05:22:54 -0600 Subject: [PATCH 53/71] More minor cleanup - Don't set default address in begin(), it gets set in renewAddress - Remove unused variable 'type' - Re-order confusing looking double network.write --- RF24Mesh.cpp | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 410824e..ee380a0 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -21,7 +21,6 @@ bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeou network.returnSysMsgs = 1; if(getNodeID() > 0){ //Not master node - mesh_address = MESH_DEFAULT_ADDRESS; if(!renewAddress(timeout)){ return 0; } @@ -330,7 +329,6 @@ bool RF24Mesh::requestAddress(uint8_t level){ #endif bool gotResponse = 0; - uint8_t type=0; for(uint8_t i=0; i Date: Thu, 6 Aug 2020 23:11:01 -0600 Subject: [PATCH 54/71] Adjust for RF24Network change - Removal of network holds functionality in RF24Network allows removal of a couple lines of code - Remove old #if defined line per notes --- RF24Mesh.cpp | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index ee380a0..571b48d 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -122,11 +122,8 @@ void RF24Mesh::setChannel(uint8_t _channel){ /*****************************************************/ void RF24Mesh::setChild(bool allow){ - //Prevent old versions of RF24Network from throwing an error - //Note to remove this ""if defined"" after a few releases from 1.0.1 - #if defined FLAG_NO_POLL - network.networkFlags = allow ? network.networkFlags & ~FLAG_NO_POLL : network.networkFlags | FLAG_NO_POLL; - #endif + + network.networkFlags = allow ? network.networkFlags & ~FLAG_NO_POLL : network.networkFlags | FLAG_NO_POLL; } /*****************************************************/ @@ -240,11 +237,10 @@ uint16_t RF24Mesh::renewAddress(uint32_t timeout){ uint8_t totalReqs = 0; beginDefault(); - network.networkFlags |= 2; uint32_t start = millis(); while(!requestAddress(reqCounter)){ - if(millis()-start > timeout){ network.networkFlags &= ~2; return 0; } + if(millis()-start > timeout){ return 0; } delay(50 + ( (totalReqs+1)*(reqCounter+1)) * 2); reqCounter++; reqCounter = reqCounter%4; @@ -252,7 +248,6 @@ uint16_t RF24Mesh::renewAddress(uint32_t timeout){ totalReqs = totalReqs%10; } - network.networkFlags &= ~2; return mesh_address; } From 951691059b7f49a0aa741f9a873f8fc5baad26cb Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Fri, 7 Aug 2020 12:06:07 -0600 Subject: [PATCH 55/71] Address one more issue - Since many examples restart the mesh if address renewal fails, the radio should be put into standby mode before reconfiguring - Add meshStarted variable, stopListening if restarting the mesh - Use true/false instead of 1/0 - Removal of BCM2835 constants --- RF24Mesh.cpp | 12 ++++++++---- RF24Mesh.h | 1 + examples_RPi/RF24Mesh_Example.cpp | 2 +- examples_RPi/RF24Mesh_Example.py | 2 +- examples_RPi/RF24Mesh_Example_Master.cpp | 2 +- examples_RPi/RF24Mesh_Example_Master.py | 2 +- 6 files changed, 13 insertions(+), 8 deletions(-) diff --git a/RF24Mesh.cpp b/RF24Mesh.cpp index 571b48d..804579a 100755 --- a/RF24Mesh.cpp +++ b/RF24Mesh.cpp @@ -15,19 +15,23 @@ RF24Mesh::RF24Mesh( RF24& _radio,RF24Network& _network ): radio(_radio),network( bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeout){ //delay(1); // Found problems w/SPIDEV & ncurses. Without this, getch() returns a stream of garbage + if(meshStarted){ + radio.stopListening(); + } + meshStarted = true; radio.begin(); radio.setChannel(channel); radio.setDataRate(data_rate); - network.returnSysMsgs = 1; + network.returnSysMsgs = true; if(getNodeID() > 0){ //Not master node if(!renewAddress(timeout)){ - return 0; + return false; } }else{ #if !defined(MESH_NOMASTER) if( !addrMemAllocated ){ - addrMemAllocated = 1; + addrMemAllocated = true; addrList = (addrListStruct*)malloc( (MESH_MEM_ALLOC_SIZE * sizeof(addrListStruct)) ); addrListTop = 0; loadDHCP(); @@ -37,7 +41,7 @@ bool RF24Mesh::begin(uint8_t channel, rf24_datarate_e data_rate, uint32_t timeou network.begin(mesh_address); } - return 1; + return true; } /*****************************************************/ diff --git a/RF24Mesh.h b/RF24Mesh.h index 7eef04f..6797f19 100644 --- a/RF24Mesh.h +++ b/RF24Mesh.h @@ -281,6 +281,7 @@ class RF24Mesh bool addrMemAllocated; /** -RF24 radio(RPI_V2_GPIO_P1_15, BCM2835_SPI_CS0, BCM2835_SPI_SPEED_8MHZ); +RF24 radio(22,0); RF24Network network(radio); RF24Mesh mesh(radio,network); diff --git a/examples_RPi/RF24Mesh_Example.py b/examples_RPi/RF24Mesh_Example.py index 01ad639..ae41944 100755 --- a/examples_RPi/RF24Mesh_Example.py +++ b/examples_RPi/RF24Mesh_Example.py @@ -18,7 +18,7 @@ def delay(ms): sleep(ms/1000.0) # radio setup for RPi B Rev2: CS0=Pin 24 -radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) +radio = RF24(22,0); network = RF24Network(radio) mesh = RF24Mesh(radio, network) diff --git a/examples_RPi/RF24Mesh_Example_Master.cpp b/examples_RPi/RF24Mesh_Example_Master.cpp index a1a9c01..e0bf957 100644 --- a/examples_RPi/RF24Mesh_Example_Master.cpp +++ b/examples_RPi/RF24Mesh_Example_Master.cpp @@ -18,7 +18,7 @@ #include -RF24 radio(RPI_V2_GPIO_P1_15, BCM2835_SPI_CS0, BCM2835_SPI_SPEED_8MHZ); +RF24 radio(22,0); RF24Network network(radio); RF24Mesh mesh(radio,network); diff --git a/examples_RPi/RF24Mesh_Example_Master.py b/examples_RPi/RF24Mesh_Example_Master.py index 4b7a1a2..963269b 100755 --- a/examples_RPi/RF24Mesh_Example_Master.py +++ b/examples_RPi/RF24Mesh_Example_Master.py @@ -8,7 +8,7 @@ # radio setup for RPi B Rev2: CS0=Pin 24 -radio = RF24(RPI_V2_GPIO_P1_15, RPI_V2_GPIO_P1_24, BCM2835_SPI_SPEED_8MHZ) +radio = RF24(22,0); network = RF24Network(radio) mesh = RF24Mesh(radio, network) From b1430b1a1f71f8949977503e0b07eb833074cf2c Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Fri, 7 Aug 2020 18:55:16 -0600 Subject: [PATCH 56/71] Update for release --- library.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.json b/library.json index bbefd52..6be0d10 100644 --- a/library.json +++ b/library.json @@ -7,7 +7,7 @@ "type": "git", "url": "https://github.com/TMRh20/RF24Mesh.git" }, - "version": "1.1.1", + "version": "1.1.2", "dependencies": [ { "name": "RF24", "authors": "TMRh20", "frameworks": "arduino" }, { "name": "RF24Network", "authors": "TMRh20", "frameworks": "arduino" } From c051d87e689caee48a378d7cff316bc1461d4296 Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Fri, 7 Aug 2020 18:55:35 -0600 Subject: [PATCH 57/71] Update for release --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index afe973c..71d8462 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=RF24Mesh -version=1.1.1 +version=1.1.2 author=TMRh20 maintainer=TMRh20,Avamander sentence=A library for NRF24L01(+) devices mesh. From 43f84455ce75acf69eb73f748f7f739708a98e1b Mon Sep 17 00:00:00 2001 From: TMRh20 Date: Sat, 15 Aug 2020 20:48:11 -0600 Subject: [PATCH 58/71] Doc update --- Doxyfile | 2580 ++++++++++++++++++++++++++++++++++++++++++++ RF24Mesh.h | 82 +- doxygen-custom.css | 804 ++++++++++++++ 3 files changed, 3428 insertions(+), 38 deletions(-) create mode 100644 Doxyfile create mode 100644 doxygen-custom.css diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..f953eeb --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2580 @@ +# Doxyfile 1.8.18 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "RF24Mesh - Automated Networking for nrf24L01 radios" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = V1.1.2 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "TMRh20 2020 - A user friendly mesh overlay for sensor neworks using RF24Network" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = "../../ArduinoBuilds/RF24Mesh Docs" + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = ino=c \ + pde=c + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = YES + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = NO + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js \ + Makefile + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = readme* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = _ + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = examples \ + examples_RPi + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 10 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = doxygen-custom.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png The default and svg Looks nicer but requires the +# pdf2svg tool. +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /