Fix license

This commit is contained in:
Manuel Bleichenbacher 2018-07-21 21:54:29 +02:00
parent e6b5f2f0d5
commit 0d2fc70abb
9 changed files with 36 additions and 53 deletions

View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2018 Manuel Bl. Copyright (c) 2018 Manuel Bleichenbacher
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -13,27 +13,3 @@ Follow the detailed [Get Started Guide](https://github.com/manuelbl/ttn-esp32/wi
## Supported Boards ## Supported Boards
All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF. All boards with Semtech SX127x chips, RFM9x and compatibles are supported. It includes boards from ttgo, Heltec and HopeRF.
## Resources
### SPI bus and pins
Before the TTN device is configured, the SPI bus / host (`SPI_HOST`, `HSPI_HOST` or `VSPI_HOST`) must be configured by calling `spi_bus_initialize()`. In the SPI configuration, the pin number for SCK, MISO and MOSI are specified.
The pin number of NSS (the radio chip's SPI chip select) is specified by calling `TheThingsNetwork::configurePins()`.
The SPI bus frequency can be changed by running `make menuconfig`.
### SX127x pins
Except for the SPI pins, the pins connected to the SX127x radio chip are configured by calling `TheThingsNetwork::configurePins()`. The pins *RXTX* and *RTS* are optional. The chip can be used without connecting them.
### Timer
To implement the LoRaWAN protocol, a timer is needed. The ESP32 has four timers. By default,
timer 1 of timer group 0 is used. It can be changed by running `make menuconfig`.
### Background thread
Most of the LoRaWAN code is run in a background process with high priority (as the timing is crucial). The default priority is 10. It can be changed by running `make menuconfig`.

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* Sample program showing how to send a test message every 30 second. * Sample program showing how to send a test message every 30 second.
*******************************************************************************/ *******************************************************************************/

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* Sample program showing how to send and receive messages. * Sample program showing how to send and receive messages.
*******************************************************************************/ *******************************************************************************/

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* This the hardware abstraction layer to run LMIC in on ESP32 using ESP-iDF. * This the hardware abstraction layer to run LMIC in on ESP32 using ESP-iDF.
*******************************************************************************/ *******************************************************************************/

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* This the hardware abstraction layer to run LMIC in on ESP32 using ESP-iDF. * This the hardware abstraction layer to run LMIC in on ESP32 using ESP-iDF.
*******************************************************************************/ *******************************************************************************/

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* This the hardware abstraction layer to run LMIC in on ESP32 using ESP-iDF. * This the hardware abstraction layer to run LMIC in on ESP32 using ESP-iDF.
*******************************************************************************/ *******************************************************************************/

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* Hardware abstraction layer to run LMIC on a ESP32 using ESP-iDF. * Hardware abstraction layer to run LMIC on a ESP32 using ESP-iDF.
*******************************************************************************/ *******************************************************************************/

View File

@ -1,10 +1,11 @@
/******************************************************************************* /*******************************************************************************
*
* ttn-esp32 - The Things Network device library for ESP-IDF / SX127x
*
* Copyright (c) 2018 Manuel Bleichenbacher * Copyright (c) 2018 Manuel Bleichenbacher
* *
* All rights reserved. This program and the accompanying materials * Licensed under MIT License
* are made available under the terms of the Eclipse Public License v1.0 * https://opensource.org/licenses/MIT
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
* *
* Hardware abstraction layer to run LMIC on a ESP32 using ESP-iDF. * Hardware abstraction layer to run LMIC on a ESP32 using ESP-iDF.
*******************************************************************************/ *******************************************************************************/