mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
8c2f6ae9dc
This implements the `shield_llcc68` module that allows using the LLCC68 LoRa shield on Arduino UNO compatible boards (with Arduino IO mappings provided by the board) by just selecting the module.
197 lines
6.7 KiB
Plaintext
197 lines
6.7 KiB
Plaintext
/*
|
|
* 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_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/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/lorawan
|
|
* ```
|
|
*/
|