Giter VIP home page Giter VIP logo

esxp1302's Introduction

About ESXP1302 LoRa Gateway

ESXP1302 Logo

ESXP1302 = ESP32 + SX1302.

ESXP1302 is a low cost 8 channel LoRa gateway design, based on ESP32 platform and porting of SX1302_HAL, based on Version 1.0.5 (update to the latest v2.1.0 is ongoing).

ESXP1302 pic

Upgrade and Usage guide

The documents about how to upgrade the released binaries, and how to use this gateway are both located under the doc folder. Below is mainly for development and other utilities.

How to Compile

There are two ways to compile this project.

By PlatformIO IDE

PlatformIO is a development environment that enables easy multi-platform development and centralized tooling. PlatformIO IDE bases on Visual Studio Code.

Follow these steps to compile ESXP1302 and flash the produced firmware.

  • Clone this project with: git clone https://github.com/lora-gateway/esxp1302.
  • Open the newly cloned folder in VS Code. If you do this for the first time, this can take quite some while as PlatformIO will download all the necessary tooling and libraries. Also if platformio is not installed, VS Code will ask you to install it.
  • Open your command palette with below shortcuts:
    • Windows/Linux: Ctrl + Shift + P
    • Mac: Command + Shift + P
  • To build the firmware, simply run PlatformIO: Build from your command palette.
  • To flash the firmware to your device, just run PlatformIO: Upload from your command palette.

By Command line

You need ESP32 development environment esp-idf.

Please follow the guide to install the SDK and the tools, or just follow below simplified steps:

git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
git checkout v4.4.5  # this branch surely works; the latest v5.x branches not yet
git submodule update --init --recursive

# below 2 steps are for Linux. For windows, use `install.bat` and `export.bat` instead.
./install.sh  # install the compilers etc.
. export.sh   # export and set up the environment

Then compile this project follow below steps:

git clone https://github.com/lora-gateway/esxp1302
cd esxp1302
./run_me.sh make  # compile
./run_me.sh flash_all  # flash 3 images: bootloader, partition_table and esxp1302
# ./run_me.sh flash  # use this to only flash esxp1302 firmware

Script run_me.sh can compile the code, flash the ESP32 board, and open minicom to monitor the output, so make sure your ESP32 board is connected. If you are not under Linux, you need to change run_me.sh to use other terminal tool instead or just run your terminal tool manually.

Run ./run_me.sh -h for its whole usage.

Configurations

There are some compile targets indeed, just as under the original sx1302_hal project under libloragw/tst/test_*. But you have to choose only one for compilation by change the file main/main.c, which is a symbol link to one of test/test_* files. The default is test/lora_pkt_fwd.c, but you can change to others such as test/test_loragw_hal_rx.c before you run run_me.sh.

Usage

At the terminal, you should be able to input the command with your argument of option, such as:

test_loragw_hal_tx -r 1250 -c 0 -f 505.5 --pwid 22 -b 125 -n 20
test_loragw_hal_tx -r 1250 -c 0 -f 505.5 --pwid 22 -b 125 -n 20 -m CW
test_network_connection -u wireless_ssid -p wireless_password --host 192.168.1.200 --port 2000
pkt_fwd -u wireless_ssid -p wireless_password --host 192.168.1.200 --port 1680

Issues and TODOs

There are some issues need to be fixed, and more features under development.

Below is the list of some of them:

  1. A few test targets do no work: test_loragw_cal.c, test_loragw_counter.c, test_loragw_capture_ram.c and test_loragw_gps.c.
  2. GPS can output raw data with the module ATGM336H but hasn't been fully verified yet.
  3. Needs to upgrade to sx1302_hal v2.1.0 to support SF5 and SF6.

esxp1302's People

Contributors

chunis avatar danielkucera avatar dennis4lora avatar lora-gateway avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.