/
registry.rst
292 lines (219 loc) · 4.99 KB
/
registry.rst
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
:wide_page: true
.. _registry:
########
Registry
########
The registry is a data structure that maintains a list of all known :class:`~rctclient.registry.ObjectInfo`. It is
implemented as :class:`~rctclient.registry.Registry`, please head to the API documentation for means to query it for
object ID information. As the registry is a heavy object, it is maintained as an instance ``REGISTRY`` in the
``registry`` module and can be imported where needed.
The following list is a complete index of all the object IDs currently maintained by the registry.
.. the following tables are generated from the registry in registry.py using generate_registry.py
acc_conv
========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_acc_conv.csv
adc
===
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_adc.csv
bat_mng_struct
==============
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_bat_mng_struct.csv
battery
=======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_battery.csv
buf_v_control
=============
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_buf_v_control.csv
can_bus
=======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_can_bus.csv
cs_map
======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_cs_map.csv
cs_neg
======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_cs_neg.csv
db
==
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_db.csv
dc_conv
=======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_dc_conv.csv
display_struct
==============
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_display_struct.csv
energy
======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_energy.csv
fault
=====
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_fault.csv
flash_param
===========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_flash_param.csv
flash_rtc
=========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_flash_rtc.csv
grid_lt
=======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_grid_lt.csv
grid_mon
========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_grid_mon.csv
g_sync
======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_g_sync.csv
hw_test
=======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_hw_test.csv
io_board
========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_io_board.csv
iso_struct
==========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_iso_struct.csv
line_mon
========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_line_mon.csv
logger
======
The `logger` group contains time series data and the event log. These are special, compound data structures that
require a bit of work to parse. They generally work by writing the timestamp of the newest element of interest to them
and respond with the entries or events **older** than that time stamp. For more details, take a look at the
:ref:`protocol-event-table` and :ref:`protocol-timeseries` pages.
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_logger.csv
modbus
======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_modbus.csv
net
===
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_net.csv
nsm
===
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_nsm.csv
others
======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_others.csv
power_mng
=========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_power_mng.csv
p_rec
=====
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_p_rec.csv
prim_sm
=======
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_prim_sm.csv
rb485
=====
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_rb485.csv
switch_on_cond
==============
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_switch_on_cond.csv
temperature
===========
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_temperature.csv
wifi
====
.. csv-table::
:header-rows: 1
:widths: 10, 5, 5, 5, 15, 40
:file: objectgroup_wifi.csv