MySmartHome/MySensors
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improved parent node search

Browse Source 
Retry parent node search with each transmit when parent has not been
found.
Transmit does not block on transmit when no parent has been found as
this depletes batteries on battery powered nodes.
Fix nRF24 configuration for dynamic ACK's. This bug caused broadcasts to
be sent with auto-ACK's.
To not break existing functionality parent search can be started when
node ID is still unknown. In this case node ID is set to broadcast ID,
which can cause funky stuff to happen...
This commit is contained in:
Yveaux
2014-09-11 09:37:42 +02:00
parent ae9332b486
commit e5bd891a77
2 changed files with 85 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/MySensors/MySensor.cpp
+84 -57
View File
@@ -14,9 +14,11 @@
#include "utility/RF24.h" #include "utility/RF24.h"
#include "utility/RF24_config.h" #include "utility/RF24_config.h"
#define DISTANCE_INVALID (0xFF)
// Inline function and macros // Inline function and macros
inline MyMessage& build (MyMessage &msg, uint8_t sender, uint8_t destination, uint8_t sensor, uint8_t command, uint8_t type, bool enableAck) { static inline MyMessage& build (MyMessage &msg, uint8_t sender, uint8_t destination, uint8_t sensor, uint8_t command, uint8_t type, bool enableAck) {
msg.sender = sender; msg.sender = sender;
msg.destination = destination; msg.destination = destination;
msg.sensor = sensor; msg.sensor = sensor;
@@ -27,6 +29,13 @@ inline MyMessage& build (MyMessage &msg, uint8_t sender, uint8_t destination, ui
return msg; return msg;
} }
static inline bool isValidParent( const uint8_t parent ) {
return parent != AUTO;
}
static inline bool isValidDistance( const uint8_t distance ) {
return distance != DISTANCE_INVALID;
}
MySensor::MySensor(uint8_t _cepin, uint8_t _cspin) : RF24(_cepin, _cspin) { MySensor::MySensor(uint8_t _cepin, uint8_t _cspin) : RF24(_cepin, _cspin) {
} }
@@ -37,6 +46,7 @@ void MySensor::begin(void (*_msgCallback)(const MyMessage &), uint8_t _nodeId, b
isGateway = false; isGateway = false;
repeaterMode = _repeaterMode; repeaterMode = _repeaterMode;
msgCallback = _msgCallback; msgCallback = _msgCallback;
failedTransmissions = 0;
if (repeaterMode) { if (repeaterMode) {
setupRepeaterMode(); setupRepeaterMode();
@@ -52,11 +62,13 @@ void MySensor::begin(void (*_msgCallback)(const MyMessage &), uint8_t _nodeId, b
cc.isMetric = 0x01; cc.isMetric = 0x01;
} }
if (_parentNodeId != AUTO) { autoFindParent = _parentNodeId == AUTO;
if (!autoFindParent) {
nc.parentNodeId = _parentNodeId; nc.parentNodeId = _parentNodeId;
autoFindParent = false; nc.distance = 0;
} else { } else if (!isValidParent(nc.parentNodeId)) {
autoFindParent = true; // Auto find parent, but parent in eeprom is invalid. Force parent search on first transmit.
nc.distance = DISTANCE_INVALID;
} }
if (_nodeId != AUTO) { if (_nodeId != AUTO) {
@@ -64,17 +76,12 @@ void MySensor::begin(void (*_msgCallback)(const MyMessage &), uint8_t _nodeId, b
nc.nodeId = _nodeId; nc.nodeId = _nodeId;
} }
// If no parent was found in eeprom. Try to find one.
if (autoFindParent && nc.parentNodeId == 0xff) {
findParentNode();
}
// Try to fetch node-id from gateway // Try to fetch node-id from gateway
if (nc.nodeId == AUTO) { if (nc.nodeId == AUTO) {
requestNodeId(); requestNodeId();
} }
debug(PSTR("%s started, id %d\n"), repeaterMode?"repeater":"sensor", nc.nodeId); debug(PSTR("%s started, id=%d, parent=%d, distance=%d\n"), repeaterMode?"repeater":"sensor", nc.nodeId, nc.parentNodeId, nc.distance);
// Open reading pipe for messages directed to this node (set write pipe to same) // Open reading pipe for messages directed to this node (set write pipe to same)
RF24::openReadingPipe(WRITE_PIPE, TO_ADDR(nc.nodeId)); RF24::openReadingPipe(WRITE_PIPE, TO_ADDR(nc.nodeId));
@@ -93,8 +100,6 @@ void MySensor::begin(void (*_msgCallback)(const MyMessage &), uint8_t _nodeId, b
} }
void MySensor::setupRadio(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_e dataRate) { void MySensor::setupRadio(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_e dataRate) {
failedTransmissions = 0;
// Start up the radio library // Start up the radio library
RF24::begin(); RF24::begin();
@@ -104,13 +109,13 @@ void MySensor::setupRadio(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_
} }
RF24::setAutoAck(1); RF24::setAutoAck(1);
RF24::setAutoAck(BROADCAST_PIPE,false); // Turn off auto ack for broadcast RF24::setAutoAck(BROADCAST_PIPE,false); // Turn off auto ack for broadcast
RF24::enableAckPayload();
RF24::setChannel(channel); RF24::setChannel(channel);
RF24::setPALevel(paLevel); RF24::setPALevel(paLevel);
RF24::setDataRate(dataRate); RF24::setDataRate(dataRate);
RF24::setRetries(5,15); RF24::setRetries(5,15);
RF24::setCRCLength(RF24_CRC_16); RF24::setCRCLength(RF24_CRC_16);
RF24::enableDynamicPayloads(); RF24::enableDynamicPayloads();
RF24::enableDynamicAck(); // Required to disable ack-sending for broadcast messages
// All nodes listen to broadcast pipe (for FIND_PARENT_RESPONSE messages) // All nodes listen to broadcast pipe (for FIND_PARENT_RESPONSE messages)
RF24::openReadingPipe(BROADCAST_PIPE, TO_ADDR(BROADCAST_ADDRESS)); RF24::openReadingPipe(BROADCAST_PIPE, TO_ADDR(BROADCAST_ADDRESS));
@@ -139,14 +144,12 @@ void MySensor::requestNodeId() {
void MySensor::findParentNode() { void MySensor::findParentNode() {
failedTransmissions = 0;
// Set distance to max
nc.distance = 255;
// Send ping message to BROADCAST_ADDRESS (to which all relaying nodes and gateway listens and should reply to) // Send ping message to BROADCAST_ADDRESS (to which all relaying nodes and gateway listens and should reply to)
debug(PSTR("find parent\n"));
build(msg, nc.nodeId, BROADCAST_ADDRESS, NODE_SENSOR_ID, C_INTERNAL, I_FIND_PARENT, false).set(""); build(msg, nc.nodeId, BROADCAST_ADDRESS, NODE_SENSOR_ID, C_INTERNAL, I_FIND_PARENT, false).set("");
sendWrite(BROADCAST_ADDRESS, msg, true); // Write msg, but suppress recursive parent search
sendWrite(BROADCAST_ADDRESS, msg, false);
// Wait for ping response. // Wait for ping response.
waitForReply(); waitForReply();
@@ -182,44 +185,64 @@ boolean MySensor::sendRoute(MyMessage &message) {
} else if (isInternal && message.type == I_ID_RESPONSE && dest==BROADCAST_ADDRESS) { } else if (isInternal && message.type == I_ID_RESPONSE && dest==BROADCAST_ADDRESS) {
// Node has not yet received any id. We need to send it // Node has not yet received any id. We need to send it
// by doing a broadcast sending, // by doing a broadcast sending,
return sendWrite(BROADCAST_ADDRESS, message, true); return sendWrite(BROADCAST_ADDRESS, message);
} }
} }
if (!isGateway) { if (!isGateway) {
// --- debug(PSTR("route parent\n"));
// Should be routed back to gateway. // Should be routed back to gateway.
bool ok = sendWrite(nc.parentNodeId, message); return sendWrite(nc.parentNodeId, message);
if (!ok) {
// Failure when sending to parent node. The parent node might be down and we
// need to find another route to gateway.
if (autoFindParent && failedTransmissions > SEARCH_FAILURES) {
findParentNode();
}
failedTransmissions++;
} else {
failedTransmissions = 0;
}
return ok;
} }
return false; return false;
} }
boolean MySensor::sendWrite(uint8_t next, MyMessage &message, bool broadcast) { boolean MySensor::sendWrite(uint8_t next, MyMessage &message, const bool allowFindParent) {
uint8_t length = mGetLength(message); bool ok = true;
message.last = nc.nodeId; const bool broadcast = next == BROADCAST_ADDRESS;
mSetVersion(message, PROTOCOL_VERSION); const bool toParent = next == nc.parentNodeId;
// Make sure radio has powered up // With current implementation parent node Id can equal the broadcast address when
RF24::powerUp(); // starting with empty eeprom and AUTO node Id is active.
RF24::stopListening(); // This behavior is undesired, as possible parents will report back to broadcast address.
RF24::openWritingPipe(TO_ADDR(next)); // debug(PSTR("sendWrite next=%d, parent=%d, distance=%d\n"), next, nc.parentNodeId, nc.distance);
bool ok = RF24::write(&message, min(MAX_MESSAGE_LENGTH, HEADER_SIZE + length), broadcast); // If sending directly to parent node and distance is not set, then try to find parent now.
RF24::startListening(); if ( allowFindParent && toParent && !isValidDistance(nc.distance) ) {
findParentNode();
// Known distance indicates parent has been found
ok = isValidDistance(nc.distance);
}
debug(PSTR("send: %d-%d-%d-%d s=%d,c=%d,t=%d,pt=%d,l=%d,st=%s:%s\n"), if (ok) {
message.sender,message.last, next, message.destination, message.sensor, mGetCommand(message), message.type, mGetPayloadType(message), mGetLength(message), ok?"ok":"fail", message.getString(convBuf)); uint8_t length = mGetLength(message);
message.last = nc.nodeId;
mSetVersion(message, PROTOCOL_VERSION);
// Make sure radio has powered up
RF24::powerUp();
RF24::stopListening();
RF24::openWritingPipe(TO_ADDR(next));
// Send message. Disable auto-ack for broadcasts.
ok = RF24::write(&message, min(MAX_MESSAGE_LENGTH, HEADER_SIZE + length), broadcast);
RF24::startListening();
debug(PSTR("send: %d-%d-%d-%d s=%d,c=%d,t=%d,pt=%d,l=%d,st=%s:%s\n"),
message.sender,message.last, next, message.destination, message.sensor, mGetCommand(message), message.type,
mGetPayloadType(message), mGetLength(message), broadcast ? "bc" : (ok ? "ok":"fail"), message.getString(convBuf));
// If many successive transmissions to parent failed, the parent node might be down and we
// need to find another route to gateway.
if (toParent) {
if (ok) {
failedTransmissions = 0;
} else {
failedTransmissions++;
if ( autoFindParent && (failedTransmissions >= SEARCH_FAILURES)) {
debug(PSTR("lost parent\n"));
// Set distance invalid to trigger parent search on next write.
nc.distance = DISTANCE_INVALID;
failedTransmissions = 0;
}
}
}
}
return ok; return ok;
} }
@@ -267,7 +290,6 @@ boolean MySensor::process() {
uint8_t len = RF24::getDynamicPayloadSize(); uint8_t len = RF24::getDynamicPayloadSize();
RF24::read(&msg, len); RF24::read(&msg, len);
RF24::writeAckPayload(pipe,&pipe, 1 );
// Add string termination, good if we later would want to print it. // Add string termination, good if we later would want to print it.
msg.data[mGetLength(msg)] = '\0'; msg.data[mGetLength(msg)] = '\0';
@@ -287,10 +309,10 @@ boolean MySensor::process() {
if (repeaterMode && command == C_INTERNAL && type == I_FIND_PARENT) { if (repeaterMode && command == C_INTERNAL && type == I_FIND_PARENT) {
// Relaying nodes should always answer ping messages // Relaying nodes should always answer ping messages
// Wait a random delay of 0-2 seconds to minimize collision // Wait a random delay of 0-1.023 seconds to minimize collision
// between ping ack messages from other relaying nodes // between ping ack messages from other relaying nodes
delay(millis() & 0x3ff); delay(millis() & 0x3ff);
sendWrite(sender, build(msg, nc.nodeId, sender, NODE_SENSOR_ID, C_INTERNAL, I_FIND_PARENT_RESPONSE, false).set(nc.distance), true); sendWrite(sender, build(msg, nc.nodeId, sender, NODE_SENSOR_ID, C_INTERNAL, I_FIND_PARENT_RESPONSE, false).set(nc.distance));
return false; return false;
} else if (destination == nc.nodeId) { } else if (destination == nc.nodeId) {
// Check if sender requests an ack back. // Check if sender requests an ack back.
@@ -315,13 +337,18 @@ boolean MySensor::process() {
// We've received a reply to a FIND_PARENT message. Check if the distance is // We've received a reply to a FIND_PARENT message. Check if the distance is
// shorter than we already have. // shorter than we already have.
uint8_t distance = msg.getByte(); uint8_t distance = msg.getByte();
if (distance<nc.distance-1) { if (isValidDistance(distance))
// Found a neighbor closer to GW than previously found {
nc.distance = distance + 1; // Distance to gateway is one more for us w.r.t. parent
nc.parentNodeId = msg.sender; distance++;
eeprom_write_byte((uint8_t*)EEPROM_PARENT_NODE_ID_ADDRESS, nc.parentNodeId); if (isValidDistance(distance) && (distance < nc.distance)) {
eeprom_write_byte((uint8_t*)EEPROM_DISTANCE_ADDRESS, nc.distance); // Found a neighbor closer to GW than previously found
debug(PSTR("new parent=%d, d=%d\n"), nc.parentNodeId, nc.distance); nc.distance = distance;
nc.parentNodeId = msg.sender;
eeprom_write_byte((uint8_t*)EEPROM_PARENT_NODE_ID_ADDRESS, nc.parentNodeId);
eeprom_write_byte((uint8_t*)EEPROM_DISTANCE_ADDRESS, nc.distance);
debug(PSTR("new parent=%d, d=%d\n"), nc.parentNodeId, nc.distance);
}
} }
return false; return false;
} else if (sender == GATEWAY_ADDRESS) { } else if (sender == GATEWAY_ADDRESS) {
libraries/MySensors/MySensor.h
+1 -1
View File
@@ -264,7 +264,7 @@ class MySensor : public RF24
void setupRepeaterMode(); void setupRepeaterMode();
void setupRadio(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_e dataRate); void setupRadio(rf24_pa_dbm_e paLevel, uint8_t channel, rf24_datarate_e dataRate);
boolean sendRoute(MyMessage &message); boolean sendRoute(MyMessage &message);
boolean sendWrite(uint8_t dest, MyMessage &message, bool broadcast=false); boolean sendWrite(uint8_t dest, MyMessage &message, const bool allowFindParent = true );
private: private:
#ifdef DEBUG #ifdef DEBUG