diff --git a/docs/docs.md b/docs/docs.md index d633ea8..4b74b7d 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -327,6 +327,7 @@ inside a radio packet (because from/to are broken out by the comms library) | want_response | [bool](#bool) | | Not normally used, but for testing a sender can request that recipient responds in kind (i.e. if it received a position, it should unicast back it's position). Note: that if you set this on a broadcast you will receive many replies. | | dest | [fixed32](#fixed32) | | The address of the destination node. This field is is filled in by the mesh radio device software, application layer software should never need it. RouteDiscovery messages _must_ populate this. Other message types might need to if they are doing multihop routing. | | source | [fixed32](#fixed32) | | The address of the original sender for this message. This field should _only_ be populated for reliable multihop packets (to keep packets small). | +| request_id | [fixed32](#fixed32) | | Only used in routing or response messages. Indicates the original message ID that this message is reporting failure on. (formerly called original_id) | @@ -619,9 +620,6 @@ A Routing control Data packet handled by the routing plugin | route_request | [RouteDiscovery](#RouteDiscovery) | | A route request going from the requester | | route_reply | [RouteDiscovery](#RouteDiscovery) | | A route reply | | error_reason | [Routing.Error](#Routing.Error) | | A failure in delivering a message (usually used for routing control messages, but might be provided in addition to ack.fail_id to provide details on the type of failure). | -| success_id | [fixed32](#fixed32) | | This is an ack. This packet is a requested acknoledgement indicating that we have received the specified message ID. This packet type can be used both for immediate (0 hops) messages or can be routed through multiple hops if dest is set. Note: As an optimization, recipients can _also_ populate a field in payload if they think the recipient would appreciate that extra state. | -| fail_id | [fixed32](#fixed32) | | This is a nak, we failed to deliver this message. | -| original_id | [fixed32](#fixed32) | | Only used in route_error messages. Indicates the original message ID that this message is reporting failure on. | diff --git a/mesh.proto b/mesh.proto index 8c9099f..de979ec 100644 --- a/mesh.proto +++ b/mesh.proto @@ -189,26 +189,22 @@ message Routing { */ Error error_reason = 3; - /* This is an ack. + /* Deprecated - this has been replced with error_reason == NONE && request_id != 0 + * This is an ack. * This packet is a requested acknoledgement indicating that we have received * the specified message ID. This packet type can be used both for immediate * (0 hops) messages or can be routed through multiple hops if dest is set. * Note: As an optimization, recipients can _also_ populate a field in payload * if they think the recipient would appreciate that extra state. - */ + fixed32 success_id = 4; + */ - /* + /* Deprecated - this has been replced with error_reason !== NONE && request_id != 0 * This is a nak, we failed to deliver this message. - */ fixed32 fail_id = 5; - } - - /* - * Only used in route_error messages. Indicates the original message ID that - * this message is reporting failure on. - */ - fixed32 original_id = 6; + */ + } } /* (Formerly called SubPacket) @@ -249,6 +245,12 @@ message Data { * packets small). */ fixed32 source = 5; + + /* + * Only used in routing or response messages. Indicates the original message ID that + * this message is reporting failure on. (formerly called original_id) + */ + fixed32 request_id = 6; } /*