ua1zbe
/
rpitx
mirror of https://github.com/F5OEO/rpitx
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
F5OEO 2018-03-22 12:06:42 +01:00 committed by GitHub
parent 12851bbc13
commit 96e884e4ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -1,10 +1,14 @@
**rpitx** is a radio transmitter for Raspberry Pi (B, B+, PI2, PI3 and PI zero) that transmits RF directly to GPIO. It can handle frequencies from 5 KHz up to 500 MHz. **rpitx** is a radio transmitter for Raspberry Pi (B, B+, PI2, PI3B,PI3B+,PIZero,PiZerow) that transmits RF directly to GPIO. It can handle frequencies from 5 KHz up to 1500 MHz.
Before you transmit, know your laws. **rpitx** has not been tested for compliance with regulations governing transmission of radio signals. You are responsible for using your **rpitx** legally. Before you transmit, know your laws. **rpitx** has not been tested for compliance with regulations governing transmission of radio signals. You are responsible for using your **rpitx** legally.
Rpitx is now based on a general Radio Frequency library : https://github.com/F5OEO/librpitx
_Created by Evariste Courjaud F5OEO. Code is GPL_ _Created by Evariste Courjaud F5OEO. Code is GPL_
# Installation # Installation
Assuming a Raspbian Lite installation (stretch) : https://www.raspberrypi.org/downloads/raspbian/
```sh ```sh
git clone https://github.com/F5OEO/rpitx git clone https://github.com/F5OEO/rpitx
cd rpitx cd rpitx
@ -13,13 +17,13 @@ cd rpitx
./install.sh ./install.sh
``` ```
# Hardware # Hardware
Plug a wire on GPIO 18, means Pin 12 of the GPIO header ([header P1](http://elinux.org/RPi_Low-level_peripherals#General_Purpose_Input.2FOutput_.28GPIO.29)). This acts as the antenna. The optimal lenght of the wire depends the frequency you want to transmit on, but it works with a few centimeters for local testing. Plug a wire on GPIO 4, means Pin 7 of the GPIO header ([header P1](http://elinux.org/RPi_Low-level_peripherals#General_Purpose_Input.2FOutput_.28GPIO.29)). This acts as the antenna. The optimal length of the wire depends the frequency you want to transmit on, but it works with a few centimeters for local testing.
# Short manual # Short manual
## General ## General
**rpitx** is the main software to transmit. It allows to transmit from: **rpitx** is the main software to transmit. It allows to transmit from:
- **IQ** files *.iq (can be generated by external software like [GNU Radio](http://gnuradio.org/)). - **IQ** files *.iq (can be generated by external software like [GNU Radio](http://gnuradio.org/)).
- **Frequency/Time** files *.ft (generally used to easily implement digital modes) - **Frequency/Time** files *.ft (generally used to easily implement digital modes)
Usage: Usage:
``` ```
@ -27,23 +31,23 @@ rpitx [-i File Input][-m ModeInput] [-f frequency output] [-s Samplerate] [-l] [
-m {IQ(FileInput is a Stereo Wav contains I on left Channel, Q on right channel)} -m {IQ(FileInput is a Stereo Wav contains I on left Channel, Q on right channel)}
{IQFLOAT(FileInput is a Raw float interlaced I,Q)} {IQFLOAT(FileInput is a Raw float interlaced I,Q)}
{RF(FileInput is a (double)Frequency,Time in nanoseconds} {RF(FileInput is a (double)Frequency,Time in nanoseconds}
{RFA(FileInput is a (double)Frequency,(int)Time in nanoseconds,(float)Amplitude} {RFA(FileInput is a (double)Frequency,(int)Time in nanoseconds,(float)Amplitude}
{VFO (constant frequency)} {VFO (constant frequency)}
-i path to File Input -i path to File Input
-f float frequency to output on GPIO_18 pin 12 in khz : (130 kHz to 750 MHz), -f float frequency to output on GPIO_18 pin 12 in khz : (130 kHz to 750 MHz),
-l loop mode for file input -l loop mode for file input
-p float frequency correction in parts per million (ppm), positive or negative, for calibration, default 0. -p float frequency correction in parts per million (ppm), positive or negative, for calibration, default 0.
-d int DMABurstSize (default 1000) but for very short message, could be decrease -d int DMABurstSize (default 1000) but for very short message, could be decrease
-c 1 Transmit on GPIO 4 (Pin 7) instead of GPIO 18 -c 1 Transmit on GPIO 4 (Pin 7) instead of GPIO 18
-h help (this help). -h help (this help).
``` ```
## Modulation samples ## Modulation samples
Some modulations are included in this repository and can be easily extended. These scripts create files which can be used by rpitx. Some modulations are included in this repository and can be easily extended. These scripts create files which can be used by rpitx.
Some output in IQ (like ssb) other in FT (like sstv). Some output in IQ (like SSB) other in FT (like SSTV).
### SSB modulation ### Single Side Band modulation (SSB)
**pissb** converts an audio file (Wav 48KHZ mono only!) to SSB (USB right now) and outputs it **pissb** converts an audio file (Wav 48KHZ mono only!) to [SSB](https://www.sigidwiki.com/wiki/Single_Sideband_Voice) (Upper Side Band right now) and outputs it
to an IQ file. to an IQ file.
Assuming your audio file is in your current working directory: Assuming your audio file is in your current working directory:
```sh ```sh
@ -55,40 +59,39 @@ sudo ./rpitx -m IQ -i ssbIQ.wav -f 50000 -l
``` ```
A sample script `testssb.sh` is included. A sample script `testssb.sh` is included.
### FM modulation ### Broadcat Frequency Modulation (FM)
**pifm** converts an audio file (Wav, 48KHz, 1 channel, pcm_s16le codec) to Narrow band FM (12.5khz excursion) and outputs it to a .ft file. **pifm** converts an audio file (Wav) to broadcast FM using Christophe Jacquet (F8FTK) PiFmRds project fork : https://github.com/F5OEO/PiFmRds
Assuming your audio file is in your current working directory
```sh See Readme from this project for instructions.
./pifm audio48mono.wav fm.ft
``` ### Slow Scan Television (SSTV)
You could then transmit it on 100MHZ (please set a correct frequency to be legal) **pisstv** converts an RGB picture to a [SSTV](https://www.sigidwiki.com/wiki/SSTV) .ft file.
```sh The SSTV module will transmit using the Martin M1 encoding mode.
sudo ./rpitx -m RF -i fm.ft -f 100000 -l
```
A sample script : `testfm.sh` is included.
### SSTV
**pisstv** converts an RGB picture to an SSTV .ft file.
If you have a JPEG picture 320x256 you can convert it to an RGB picture with: If you have a JPEG picture 320x256 you can convert it to an RGB picture with:
```sh ```sh
imagemagick convert -depth 8 picture.jpg picture.rgb imagemagick convert -depth 8 picture.jpg picture.rgb
``` ```
You can then transform it to a .ft file with: You can then transmit on 144.5Mhz (please set a correct frequency to be legal) :
```sh ```sh
./pisstv picture.rgb picture.ft ./pisstv picture.rgb 144.5e6
``` ```
And then transmit it to 100MHZ (please set a correct frequency to be legal) A sample script `snapsstv.sh` grabs a picture from a PiCamera and then transmits it on 144.5 MHz.
```sh
sudo ./rpitx -m RF -i picture.ft -f 100000 ### Fast Simple QSO (FSQ)
``` **pifsq** allows to send a text with the new [FSQ](https://www.sigidwiki.com/wiki/FSQ) modulation
A sample script `snapsstv.sh` grabs a picture from a PiCamera and then transmits it on 50.105 MHz.
### FSQ
**pifsq** allows to send a text with the new FSQ modulation
It is still under development. It is still under development.
A sample script `testfsq.sh` allows to send a text with FSQ A sample script `testfsq.sh` allows to send a text with FSQ
### VFO ### Weak Signal Propagation Reporter (WSPR)
**wsprrpi** allows to send wspr beacon https://en.wikipedia.org/wiki/WSPR_(amateur_radio_software)
It uses a fork from James (https://github.com/JamesP6000/WsprryPi) project and adpated to librpitx for frequency ehancement and cleaner spectrum (to be confirmed)
See https://github.com/F5OEO/WsprryPi for instructions
### Variable Frequency Offset (VFO)
A **VFO** mode is provided to allows precise frequency resolution. A **VFO** mode is provided to allows precise frequency resolution.
For example to set a carrier on 100MHz (please set a correct frequency to be legal) For example to set a carrier on 100MHz (please set a correct frequency to be legal)
```sh ```sh
@ -103,3 +106,4 @@ Inspired by
* http://www.icrobotics.co.uk/wiki/index.php/Turning_the_Raspberry_Pi_Into_an_FM_Transmitter * http://www.icrobotics.co.uk/wiki/index.php/Turning_the_Raspberry_Pi_Into_an_FM_Transmitter
* https://github.com/richardghirst/PiBits/pull/18 * https://github.com/richardghirst/PiBits/pull/18
* http://www.bellard.org/dvbt/ * http://www.bellard.org/dvbt/