79 lines
2.8 KiB
Markdown
79 lines
2.8 KiB
Markdown
|
# ATTMapper (WIP)
|
||
|
|
|
||
|
|
A TTN Mapper based on the ATTNode v3.
|
||
|
|
|
||
|
|
**Everything in this repository is work in progress, use at your own risk!**
|
||
|
|
|
||
|
|
## Hardware
|
||
|
|
|
||
|
|
* Attnode v3 with PCB-Edge SMA Antenna Mount
|
||
|
|
* Powerpack, LiPo Cell (500mA), LiPo Charger Board (You can use any 3,3V Power Source)
|
||
|
|
* NEO M8N GPS Breakout (Any 3.3V-Capable Module which is NMEA-Compatible should work)
|
||
|
|
* SSD1306 128x64 OLED-Display
|
||
|
|
* Button
|
||
|
|
|
||
|
|
### Connections
|
||
|
|
|
||
|
|
Connect the AttNode and Modules as follows:
|
||
|
|
|
||
|
|
#### GPS
|
||
|
|
|
||
|
|
| ATTNode | Module |
|
||
|
|
|---------|--------|
|
||
|
|
| Vin | VCC |
|
||
|
|
| GND | GND |
|
||
|
|
| Tx | RX |
|
||
|
|
| Rx | TX |
|
||
|
|
|
||
|
|
#### OLED
|
||
|
|
|
||
|
|
| ATTNode | Module |
|
||
|
|
|---------|--------|
|
||
|
|
| Vin | VCC |
|
||
|
|
| GND | GND |
|
||
|
|
| SDA | SDA |
|
||
|
|
| SCL | SCL |
|
||
|
|
|
||
|
|
#### Button
|
||
|
|
|
||
|
|
The Button has to be Connected between PC2 and GND on the ATTNode
|
||
|
|
|
||
|
|
## Software
|
||
|
|
|
||
|
|
This repository contains the PlatformIO project with the mapper firmware. Copy config.example.h to config.h and insert your keys and DeviceID from TTN. Compile and upload as normal (See AttNode v3 dokumentation for details).
|
||
|
|
|
||
|
|
### Usage
|
||
|
|
|
||
|
|
If a Button is connected you can use the following functions:
|
||
|
|
|
||
|
|
* **Short press:** Schedule an imideate send, regardless of interval
|
||
|
|
* **Long Press (>1s):** Enter Setup Mode, change interval with short press, use another long press to leave setup
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Unless stated otherwise, everything in this repository is under the BSD 3-Clause License as follows:
|
||
|
|
|
||
|
|
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 of the copyright holder 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 HOLDER 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.
|