-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Expand file tree
/
Copy pathdoc.txt
More file actions
230 lines (208 loc) · 8.12 KB
/
doc.txt
File metadata and controls
230 lines (208 loc) · 8.12 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
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
/*
* Copyright (C) 2013 Freie Universität Berlin
* 2015 INRIA
* 2018 RWTH
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @defgroup drivers Drivers
* @brief Drivers for external devices as radios, sensors, memory etc.
*
* The module contains all kind of drivers for specific devices.
*/
/**
* @defgroup drivers_multimedia Multimedia Device Drivers
* @ingroup drivers
* @brief Drivers for external multimedia devices.
*/
/**
* @defgroup drivers_netdev Network Device Drivers
* @ingroup drivers
* @brief Drivers for external network devices.
*/
/**
* @defgroup drivers_sensors Sensor Device Drivers
* @ingroup drivers
* @brief Drivers for external sensors.
*
* Most of these drivers will be connected over some bus or serial connection
* to the MCU.
*/
/**
* @defgroup drivers_actuators Actuator Device Drivers
* @ingroup drivers
* @brief Drivers for actuating devices
*
* The group of actuators includes all kind of devices that can actively
* interact with the physical world, as e.g. motors, lights, sound devices, etc.
*/
/**
* @defgroup drivers_storage Storage Device Drivers
* @ingroup drivers
* @brief Drivers for storage devices
*/
/**
* @defgroup drivers_crypto Crypto Device Drivers
* @ingroup drivers
* @brief Drivers for crypto devices
*/
/**
* @defgroup drivers_display Display Device Drivers
* @ingroup drivers
* @brief Drivers for display devices
*/
/**
* @defgroup drivers_soft_periph Soft Peripheral Driver Interface
* @ingroup drivers
* @brief Software emulated @ref drivers_periph for UART, SPI, etc
*/
/**
* @defgroup drivers_power Power Supply Drivers
* @ingroup drivers
* @brief Drivers for power supply devices
*
* The group of power supply drivers indludes all kinds of AC/DC, DC/DC supply devices
* or charger ICs which can be controlled from the host e.g by config pin settings or by bus.
*/
/**
* @defgroup drivers_misc Miscellaneous Drivers
* @ingroup drivers
* @brief Drivers for different kinds of devices that do not match any
* other category
*/
/**
* @defgroup config_drivers_netdev Network Device Configurations
* @ingroup config
* @brief Compile time configurations for external network devices
*/
/**
* @defgroup config_drivers_sensors Sensor Device Configurations
* @ingroup config
* @brief Compile time configurations for Sensors
*/
/**
* @defgroup config_drivers_actuators Actuator Device Configurations
* @ingroup config
* @brief Compile time configurations for actuating devices
*/
/**
* @defgroup config_drivers_storage Storage Device Configurations
* @ingroup config
* @brief Compile time configurations for storage devices
*/
/**
* @defgroup config_drivers_display Display Device Configurations
* @ingroup config
* @brief Compile time configurations for display devices
*/
/**
* @defgroup config_drivers_soft_periph Soft Peripheral Configurations
* @ingroup config
* @brief Compile time configurations for Software emulated
* @ref drivers_periph for UART, SPI, etc
*/
/**
* @defgroup config_drivers_misc Miscellaneous Device Configurations
* @ingroup config
* @brief Compile time configurations for different kinds of
* devices that do not match any other category
*/
/**
* @defgroup drivers_shield Shields - hardware extension daughter board drivers
* @ingroup drivers
* @brief Provides drivers for hardware extension daughter boards such as
* Arduino Shields
*/
/**
* @defgroup drivers_shield_w5100 W5100 Ethernet Shield driver
* @ingroup drivers_shield
* @brief Driver for the Arduino W5100 Ethernet Shield
*
* Overview
* ========
*
* @image html https://docs.arduino.cc/static/61f89cdbee1f4b4d00168ea63d9fbd6a/6aca1/a000072_featured.jpg "Photo of the Arduino Ethernet Shield" width=50%
*
* | Key | Value |
* |:---------------------- |:--------------------------------------------------------------------- |
* | Abstract | Ethernet Network Card |
* | Product Name | Arduino Ethernet Shield |
* | Vendor | Arduino |
* | Vendor Doc | [Product Homepage][shield_w5100_hp] |
* | Attachment Standard | Arduino UNO Shield (ISP-SPI required) |
*
* [shield_w5100_hp]: http://web.archive.org/web/20240910190853/https://docs.arduino.cc/retired/shields/arduino-ethernet-shield-without-poe-module/
*
*
* Usage
* =====
*
* The driver is enabled by using the module `shield_w5100`, e.g. with:
*
* ```
* USEMODULE=shield_w5100 make BOARD=arduino-due -C examples/networking/gnrc/networking
* ```
*
* It depends on @ref drivers_w5100 and provides nothing more than the providing
* the correct configuration. For this, it depends on the `arduino_pins`,
* `arduino_spi`, `arduino_shield_uno` and the `arduino_shield_isp` feature.
* It should work out of the box for any fully Arduino UNO compatible board
* (including the ISP header) and correct I/O mapping (`arduino_*`) features.
*/
/**
* @defgroup drivers_shield_llcc68 LLCC68 Arduino LoRa Shield
* @ingroup drivers_shield
* @brief LLCC68 Arduino LoRa Shield
*
* # Overview
*
* @image html https://www.semtech.com/uploads/products/product/LLCC68MB2BAS_image2_horiz_300x300px.jpg "Photo of the LLCC68 Shield" width=50%
*
* | Key | Value |
* |:---------------------- |:--------------------------------------------------------------------- |
* | Abstract | LoRa Transceiver |
* | Product Name | LLCC68MB2CAS0 |
* | Vendor | Semtech |
* | Vendor Doc | [Product Homepage][shield_llcc68_hp] |
* | Attachment Standard | Arduino UNO Shield (Side SPI used, no ISP-SPI required) |
*
* [shield_llcc68_hp]: http://web.archive.org/web/20240528223141/https://www.semtech.com/products/wireless-rf/lora-connect/llcc68mb2cas
*
* # Usage
*
* Use the `shield_llcc68` module, e.g. using
*
* ```
* USEMODULE=shield_llcc68 make BOARD=arduino-zero -C examples/networking/misc/lorawan
* ```
*/
/**
* @defgroup drivers_shield_sx1262 SX1262 Arduino LoRa Shield
* @ingroup drivers_shield
* @brief SX1262 Arduino LoRa Shield
*
* # Overview
*
* @image html https://www.semtech.com/uploads/products/SX1262MB2CAS_shield_1_fixed.png "Photo of the SX1262 Shield" width=50%
*
* | Key | Value |
* |:---------------------- |:--------------------------------------------------------------------- |
* | Abstract | LoRa Transceiver |
* | Product Name | SX1262MB2CAS |
* | Vendor | Semtech |
* | Vendor Doc | [Product Homepage][shield_sx1262_hp] |
* | Attachment Standard | Arduino UNO Shield (Side SPI used, no ISP-SPI required) |
*
* [shield_sx1262_hp]: https://www.semtech.com/products/wireless-rf/lora-connect/sx1262mb2cas
*
* # Usage
*
* Use the `shield_sx1262` module, e.g. using
*
* ```
* USEMODULE=shield_sx1262 make BOARD=arduino-zero -C examples/networking/misc/lorawan
* ```
*/