Skip to content
Brenton Salmi edited this page Nov 28, 2017 · 3 revisions

Overview

FaradayIO - Software is Python 3 module that enables a Faraday open source amateur radio hardware device to interact with computer applications using standard interfaces. These interfaces include:

  • TCP/IP
    • Enabled using a TUN network adapter
  • UART
    • SLIP protocol
  • Datalink/MAC
    • Datalink and MAC layer(s) are handled by the firmware on the Faraday device but are configured using this Python interface.

Structure/Organization

The project must follow good practices set out as described in: https://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/

The primary focuses are:

  • Clean single project structure
  • Self-Documentating code when possible
  • Automated testing (unit testing) and syntax verfication
  • Python installable module
Clone this wiki locally