Merge pull request #217 from psa-jforestier/sendookdemo

Sendook : a new tool to send OOK packet

src/Makefile

@@ -1,4 +1,4 @@
-all: ../pisstv ../piopera ../pifsq ../pichirp ../sendiq ../tune ../freedv ../dvbrf ../pocsag ../spectrumpaint ../pifmrds ../rpitx ../corel8 ../pift8
+all: ../pisstv ../piopera ../pifsq ../pichirp ../sendiq ../tune ../freedv ../dvbrf ../pocsag ../spectrumpaint ../pifmrds ../rpitx ../corel8 ../pift8 ../sendook
 
 CFLAGS	= -Wall -g -O2 -Wno-unused-variable
 CXXFLAGS = -std=c++11 -Wall -g -O2 -Wno-unused-variable
@@ -63,6 +63,9 @@ LDFLAGS_Pissb	= librpitx/src/librpitx.a -lm -lrt -lpthread -lsndfile -lliquid -L
 ../pift8 : pift8/pift8.cpp pift8/ft8_lib/ft8/constants.cpp pift8/ft8_lib/ft8/text.cpp pift8/ft8_lib/ft8/pack.cpp pift8/ft8_lib/ft8/encode.cpp librpitx/src/librpitx.a
 	$(CCP) $(CXXFLAGS) -Wno-write-strings -o ../pift8 pift8/pift8.cpp pift8/ft8_lib/ft8/constants.cpp pift8/ft8_lib/ft8/text.cpp pift8/ft8_lib/ft8/pack.cpp pift8/ft8_lib/ft8/encode.cpp  $(LDFLAGS)
 
+../sendook: ook/sendook.cpp librpitx/src/librpitx.a
+	$(CCP) $(CXXFLAGS) -Wno-write-strings -o ../sendook ook/sendook.cpp $(LDFLAGS)
+
 CFLAGS_Pifm	= -Wall -g -O2 -Wno-unused-variable
 LDFLAGS_Pifm	= librpitx/src/librpitx.a -lm -lrt -lpthread -lsndfile -L/opt/vc/lib -lbcm_host
 ../pifm : ../fm/pifm.c
@@ -78,7 +81,7 @@ LDFLAGS_Pidcf77	= librpitx/src/librpitx.a -lm -lrt -lpthread -L/opt/vc/lib -lbcm
 ../pidcf77 : ../dcf77/pidcf77.c
 	$(CC) $(CFLAGS_Piam) -o ../pidcf77 ../dcf77/pidcf77.c  $(LDFLAGS_Piam)
 clean:
-	rm -f  ../dvbrf ../sendiq ../pissb ../pisstv ../pifsq ../pifm ../piam ../pidcf77 ../pichirp ../tune ../freedv ../piopera ../spectrumpaint ../pocsag ../pifmrds ../rpitx
+	rm -f  ../dvbrf ../sendiq ../pissb ../pisstv ../pifsq ../pifm ../piam ../pidcf77 ../pichirp ../tune ../freedv ../piopera ../spectrumpaint ../pocsag ../pifmrds ../rpitx ../sendook
 
 install: all
 	install -m 0755 ../pisstv /usr/bin
@@ -91,3 +94,4 @@ install: all
 	install -m 0755 ../dvbrf /usr/bin
 	install -m 0755 ../rpitx /usr/bin
 	install -m 0755 ../pift8 /usr/bin
+	install -m 0755 ../sendook /usr/bin

src/ook/README.md

@@ -0,0 +1,42 @@
+# SendOOK
+
+`sendook` allow you to send On Off Keying packend with librpitx.
+
+## Usage
+
+Run the program in SUDO, even if using the "dry run" switch. It is because of the DMA things of librpitx.
+```
+usage : sendook [options] "binary code"
+Options:
+-h : this help
+-v : verbose (-vv : more verbose)
+-d : dry run : do not send anything
+-f freq : frequency in Hz (default : 433.92MHz)
+-0 nb : duration in microsecond of 0 bit (by default : 500us). Use integer only.
+-1 nb : duration in microsecond of 1 bit (by default : 250us)
+-r nb : repeat nb times the message (default : 3)
+-p nb : pause between each message (default : 1000us=1ms)
+
+"binary code":
+  a serie of 0 or 1 char (space allowed and ignored)
+
+Examples:
+  sendook -f 868.3M -0 500 -1 250 -r 3 1010101001010101
+    send 0xaa55 three times (with the default pause of 1ms) on 868.3MHz. A 0 is a gap of 500us, a 1 is a pulse of 250us
+```
+The program return 0 if message send.
+
+### Known limitation
+
+- a gap or a pulse can not be shorter than 10us (options `-0` or `-1`).
+- the pulse is not really a pulse : it is not modulated (you cant have a pulse of 7Khz for ex.)
+- but the signal is not really a square signal too, because librpitx, for an unkown reason, modulate the generated signal globally :
+-- for example, the command `sendook -f 868.3M -0 500 -1 250 -r 3 101010` should generate :
+```
+| ....    ....    ....
+| :  :    :  :    :  :
++-+--+----+--+----+--+----------------------->
+```
+-- but if record the I/Q of the signal, you will see :
+
+![IQ_sendook.png](IQ_sendook.png)

src/ook/sendook.cpp

@@ -0,0 +1,203 @@
+#include <unistd.h>
+#include "../librpitx/src/librpitx.h"
+#include "../librpitx/src/optparse.h"
+#include <unistd.h>
+#include "stdio.h"
+#include <cstring>
+#include <signal.h>
+#include <time.h>
+#include <inttypes.h>
+
+bool running = true;
+
+void print_usage(void)
+{
+/** Future options :
+-g nb : power output
+-o nb : GPIO out port
+-p freq : frequency of the bit 1 pulse (0 : continuous pulse)
+**/
+	fprintf(stderr,"sendook : a program to send On-Off-Keying with a Raspberry PI.\n\
+usage : sendook [options] \"binary code\"\n\
+Options:\n\
+-h : this help\n\
+-v : verbose (-vv : more verbose)\n\
+-d : dry run : do not send anything\n\
+-f freq : frequency in Hz (default : 433.92MHz)\n\
+-0 nb : duration in microsecond of 0 bit (by default : 500us). Use integer only.\n\
+-1 nb : duration in microsecond of 1 bit (by default : 250us)\n\
+-r nb : repeat nb times the message (default : 3)\n\
+-p nb : pause between each message (default : 1000us=1ms)\n\
+\n\
+\"binary code\":\n\
+  a serie of 0 or 1 char (space allowed and ignored)\n\
+\n\
+Examples:\n\
+  sendook -f 868.3M -0 500 -1 250 -r 3 1010101001010101\n\
+    send 0xaa55 three times (with the default pause of 1ms) on 868.3MHz. A 0 is a gap of 500us, a 1 is a pulse of 250us\n\
+");
+
+} /* end function print_usage */
+
+static void
+terminate(int num)
+{
+	running = false;
+	fprintf(stderr, "Caught signal - Terminating\n");
+}
+
+// MIN_DURATION (in us) is based on limitation of the ookbursttiming object
+#define MIN_DURATION 10
+void FATAL_ERROR(const int exitcode, const char *fmt, ...)
+{
+	va_list args;
+	va_start(args, fmt);
+	fprintf(stderr, "FATAL : ");
+	vfprintf(stderr, fmt, args);
+	va_end(args);
+	exit(exitcode);
+}
+
+/**
+ **/
+int main(int argc, char *argv[])
+{
+	int anyargs = 1;
+	int a;
+	uint64_t Freq = 433920000;
+	uint64_t bit0duration = 500; // in microsecond
+	uint64_t bit1duration = 500;
+	int nbrepeat = 3;
+	int pause = 1000; // in us
+	int dryrun = 0; // if 1 : hte message is not really transmitted
+	char *bits = NULL;
+	
+	for (int i = 0; i < 64; i++)
+	{
+		struct sigaction sa;
+		std::memset(&sa, 0, sizeof(sa));
+		sa.sa_handler = terminate;
+		sigaction(i, &sa, NULL);
+	}
+	while(1)
+	{
+		a = getopt(argc, argv, "f:0:1:r:p:hvd");
+		if(a == -1)
+		{
+			if(anyargs) break;
+			else a='h'; //print usage and exit
+		}
+		anyargs = 1;
+		switch(a)
+		{
+			case 'f': // Frequency
+				Freq = atouint32_metric(optarg, "Error with -f : ");
+				break;
+			case '0': // bit 0 duration
+				bit0duration = atouint32_metric(optarg, "Error with -0 : ");
+				break;
+			case '1': // bit 0 duration
+				bit1duration = atouint32_metric(optarg, "Error with -1 : ");
+				break;
+			case 'r':
+				nbrepeat = atoi(optarg);
+				break;
+			case 'p':
+				pause = atoi(optarg);
+				break;
+			case 'h' :
+				print_usage();
+				exit(0);
+				break;
+			case 'v': // verbose
+				dbg_setlevel(dbg_getlevel() + 1);
+				break;
+			case 'd': // Dry run
+				dryrun = 1;
+				break;
+			case -1:
+				break;
+			default:
+				print_usage();
+				exit(1);
+				break;
+		}/* end switch a */
+	}/* end while getopt() */
+	if (optind >= argc) {
+		FATAL_ERROR(-2, "Missing bit message.\n");
+	}
+	bits = argv[optind];
+	printf("Frequency set to : %" PRIu64 "Hz \n", Freq);
+	printf("Bit duration 0 : %" PRIu64 "us ; 1 : %" PRIu64 "us\n",
+		bit0duration, bit1duration);
+	printf("Send message %d times with a pause of %dus\n", nbrepeat, pause);
+	if (dryrun) 
+		printf("Dry run mode enabled : no message will be sent\n");
+	dbg_printf(1, "Verbose mode enabled, level %d.\n", dbg_getlevel());
+	// Simplify the message to send
+	int computed_duration = 0; // in us	
+	int nbbits = 0;
+	for(size_t i = 0; i < strlen(bits); i++)
+	{
+		char c = bits[i];
+		if (c == '0')
+		{
+			nbbits ++;
+			computed_duration += bit0duration;
+		} else if (c == '1')
+		{
+			nbbits ++;
+			computed_duration += bit1duration;
+		}
+		// any other char is ignored (it allows to speparate nibble with a space for example)
+		// improvement : allow "." and "-" or "i" and "a" to create a MORSE sender
+	}
+	dbg_printf(1, "Send %d bits, with a total duration of %d us.\n", nbbits, computed_duration);
+	if (computed_duration == 0 || nbbits == 0)
+	{
+		FATAL_ERROR(-2, "Message duration or number of bits invalid.\n");
+	}
+	if (bit0duration < MIN_DURATION || bit1duration < MIN_DURATION)
+	{
+		FATAL_ERROR(-2, "Currently, sendook support only bit longer than 10us.\n");
+	}
+	
+	// Prepare the message
+	ookbursttiming ooksender(Freq, computed_duration);
+	ookbursttiming::SampleOOKTiming Message[nbbits];
+	for(size_t i = 0; i < strlen(bits); i++)
+	{
+		char c = bits[i];
+		if (c == '0')
+		{
+			Message[i].value = 0; 
+			Message[i].duration = bit0duration;
+		} else if (c == '1')
+		{
+			Message[i].value = 1; 
+			Message[i].duration = bit1duration;
+		}
+	}
+	
+	// Send the message
+	for (int i = 0; i < nbrepeat; i++)
+	{
+		if (!dryrun)
+			ooksender.SendMessage(Message, nbbits); 
+		else
+		{
+			printf("Simulating SendMessage of %d bits\n", nbbits);
+			usleep(computed_duration);
+		}
+		if(!running)
+			break;
+		if (i<nbrepeat-1)
+		{
+			usleep(pause);
+		}
+		if(!running)
+			break;
+	}
+	printf("Message successfuly transmitted\n");
+	return 0;
+}