Skip to content

Latest commit

 

History

History
72 lines (61 loc) · 3.83 KB

README.md

File metadata and controls

72 lines (61 loc) · 3.83 KB
Raw

faradayio-cli

Build Status Gitter

The faradayio-cli package provides a command line implementation of the faradayio module. Like the faradayio module this program is also radio agnostic and will work with any RF module that accepts serial port SLIP encoded IP frames. Running faradayio-cli results in a TUN/TAP adapter being implemented which persists as long as the program is running. This module then redirects any packets destined for the IP range assigned to the TUN/TAP adapter to the serial port specified.

The main use of faradayio-cli is to provide access to the FaradayRF Faraday radio using standard IP packets. It makes the Faraday radio appear as a normal network interface. Below is an example of faradayio-cli providing a network interface KB1LQC-1 for IP addresses 10.0.0.1 through 10.0.0.255 where the TUN adapter itself is located 10.0.0.1.

Installation

Install from PyPi for general use. If you would like to develop with the project them please follow these instructions to setup a virtual environment with a fork of the project and install the project in editable mode.

Recommended Environment

faradayio-cli was developed and tested with the following environments

  • Ubuntu 16.04
  • Python3
  • faradayio version 0.0.2 or greater

PyPi

To install faradayio-cli simply install with pip3

pip3 install faradayio-cli

Git Repository Editable Mode

$ git clone [email protected]:FaradayRF/faradayio-cli.git
$ cd faradayio-cli
$ pip3 install -r requirements.txt
$ pip3 install -e .

Usage

To run faradayio-cli one must be a sudo user due to the Linux requirements for TUN/TAP software. Additionally, if you are using a virtual environment you must also explicitly call the virtual environment installation of faradayio-cli

Basic Usage

faradayio-cli [-h] [-l] [-p PORT] callsign id

You are required to provide a callsign and id number as shown in the examples below. The /dev/ttyUSB0 serial port is used by default and should be specified with the --port or -p option. See the Command Line Options section below for more information.

System Wide installation

$ sudo faradayio-cli KB1LQC 1
Executing faradayio-cli version 0.0.1

Virtual Environment

$ (.venv)$ sudo .venv/bin/faradayio-cli KB1LQC 1
Executing faradayio-cli version 0.0.1

Exiting faradayio-cli

To exit, simply push cntl+c to perform a KeyboardInterrupt which will properly exit the TUN/TAP adapter.

Executing faradayio-cli version 0.0.1
^CTUN brought down...

Command Line Options

Several command line options are required while others are optional. Below is an example from faradayio-cli version 0.0.1 which is provided when the program is run with -h or --help.

$ sudo .venv/bin/faradayio-cli --help
Executing faradayio-cli version 0.0.1
usage: faradayio-cli [-h] [-l] [-p PORT] callsign id

positional arguments:
  callsign              Callsign of radio
  id                    ID number radio

optional arguments:
  -h, --help            show this help message and exit
  -l, --loopback        Use software loopback serial port
  -p PORT, --port PORT  Physical serial port of radio

FaradayRF

This project is provided by FaradayRF as GPLv3 software aimed at the amateur radio (ham radio) community. Please join us on our Gitter lobby if you have any questions. Send an email to [email protected] if you would like to contact us via email.