BaseSubscriber.hpp
3.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/****************************************************************************
*
* Copyright (c) 2021 PX4 Development Team. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name PX4 nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/**
* @file BaseSubscriber.hpp
*
* Defines basic functionality of UAVCAN v1 subscriber class
*
* @author Jacob Crabill <jacob@flyvoly.com>
*/
#pragma once
#include <px4_platform_common/px4_config.h>
#include <lib/parameters/param.h>
#include "../CanardInterface.hpp"
class UavcanBaseSubscriber
{
public:
static constexpr uint16_t CANARD_PORT_ID_UNSET = 65535U;
UavcanBaseSubscriber(CanardInstance &ins, const char *subject_name, uint8_t instance = 0) :
_canard_instance(ins), _instance(instance)
{
_subj_sub._subject_name = subject_name;
}
virtual void subscribe() = 0;
virtual void unsubscribe()
{
SubjectSubscription *curSubj = &_subj_sub;
while (curSubj != NULL) {
canardRxUnsubscribe(&_canard_instance, CanardTransferKindMessage, curSubj->_canard_sub._port_id);
curSubj = curSubj->next;
}
};
virtual void callback(const CanardTransfer &msg) = 0;
CanardPortID id(uint32_t instance = 0)
{
uint32_t i = 0;
SubjectSubscription *curSubj = &_subj_sub;
while (curSubj != NULL) {
if (instance == i) {
return curSubj->_canard_sub._port_id;
}
curSubj = curSubj->next;
i++;
}
return CANARD_PORT_ID_UNSET; // Wrong id return unset
}
bool hasPortID(CanardPortID port_id)
{
SubjectSubscription *curSubj = &_subj_sub;
while (curSubj != NULL) {
if (port_id == curSubj->_canard_sub._port_id) {
return true;
}
curSubj = curSubj->next;
}
return false;
}
void printInfo()
{
SubjectSubscription *curSubj = &_subj_sub;
while (curSubj != NULL) {
if (curSubj->_canard_sub._port_id != CANARD_PORT_ID_UNSET) {
PX4_INFO("Subscribed %s.%d on port %d", curSubj->_subject_name, _instance, curSubj->_canard_sub._port_id);
}
curSubj = curSubj->next;
}
}
protected:
struct SubjectSubscription {
CanardRxSubscription _canard_sub;
const char *_subject_name;
struct SubjectSubscription *next {NULL};
};
CanardInstance &_canard_instance;
SubjectSubscription _subj_sub;
uint8_t _instance {0};
/// TODO: 'type' parameter? uavcan.pub.PORT_NAME.type (see 384.Access.1.0.uavcan)
};