AGirs
Macros
GirsFat.config.h File Reference

Complete configuration options. More...

#include <girs_hw_config.h>
Include dependency graph for GirsFat.config.h:

Go to the source code of this file.

Macros

#define PROGNAME   "AGirs"
 Program name, as displayed in greeting messages etc. More...
 
#define TRANSMIT
 Define to support transmission of IR signals. More...
 
#define RENDERER
 Define to support the rendering of some known protocols, presently NEC1 and RC5. More...
 
#define RECEIVE
 Define to support capturing of IR signals. More...
 
#define DECODER
 Define to support decoding of the received signal. More...
 
#define DECODELED
 Define to support blinking with LED according to decoding outcome. More...
 
#define LCD
 Define to support an LCD display with I2C connection. More...
 
#define LED
 Define to use signaling LEDs. More...
 
#define PARAMETERS
 Define to allow to change the parameters, like timeouts. More...
 
#define NAMED_COMMANDS
 Define to support commands called by names, grouped in sets, "remotes". More...
 
#define DONT_REPORT_DECODES
 Define to have the receive command report the durations, even if DECODE is defined and a decode was found. More...
 
#define CONFIGURABLE_LEDS
 Define to be able to reconfigure signaling LEDs during runtime. More...
 
#define NON_MOD
 Define to support sending signals without modulation, e.g. More...
 
#define RESET
 Define to support a reset command, Experimental!! More...
 
#define FREEMEM
 Define to support command "memory", reporting free (SRAM) memory. More...
 
#define INFO
 Define to support command "info". More...
 
#define PRONTO
 Define to support command "hex", sending Pronto hex signals. More...
 
#define TRANSMITLED   8
 Number of logical LED to light when transmission takings place. More...
 
#define RECEIVELED   7
 Number of logical LED to light when waiting for reception. More...
 
#define CAPTURELED   6
 Number of logical LED to light when waiting for capture. More...
 
#define COMMANDLED   5
 Number of logical LED to light when waiting for command. More...
 
#define SERIAL_DEBUG
 Define to use Ethernet (TCP) as the communication channel. More...
 
#define SDCARD_ON_ETHERSHIELD_PIN   4
 Pin to disable (put low) on Ethernet shield. More...
 
#define DHCP
 Define to do IP configuration using DHCP. More...
 
#define BEACON
 Define to invoke a AMX style beacon. More...
 
#define MACADDRESS   0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
 Must define MAC-Address to use here (!!). More...
 
#define PORT   33333
 TCP port to use. More...
 
#define EOLCHAR   '\r'
 Character that ends the command lines. More...
 
#define LCD_0x3F_20_4
 Define to use LCD display at I2C address 0x3F, 4 lines, 20 columns. More...
 
#define LCD_0x27_20_4
 Define to use LCD display at I2C address 0x27, 4 lines, 20 columns. More...
 
#define LCD_0x27_16_2
 Define to use LCD display at I2C address 0x27, 2 lines, 16 columns. More...
 
#define DEFAULT_BEGINTIMEOUT   10000UL
 Time to wait for signal to start. More...
 
#define DEFAULT_RECEIVE_ENDINGTIMEOUT   30L
 By receive, time to wait before signal is considered ended. More...
 
#define DEFAULT_CAPTURE_ENDINGTIMEOUT   100L
 By capture, time to wait before signal is considered ended. More...
 
#define DEFAULT_CAPTURESIZE   400U
 Size of capture and receive arrays. More...
 
#define IRRECEIVER_MARK_EXCESS   50
 This quantity is added to all gaps and subtracted from all marks when receiving. More...
 
#define IRSENSOR_MARK_EXCESS   -10
 This quantity is added to all gaps and subtracted from all marks when capturing. More...
 
#define SERIALBAUD   115200
 Configured speed of the serial port. More...
 
#define SERIALTIMEOUT   5000L
 Timeout for serial line. More...
 

Detailed Description

Complete configuration options.

Definition in file GirsFat.config.h.

Macro Definition Documentation

◆ BEACON

#define BEACON

Define to invoke a AMX style beacon.

Requires the Beacon library (https://github.com/bengtmartensson/ABeacon). For the time being, no-one takes advantage of this.

Definition at line 178 of file GirsFat.config.h.

◆ CAPTURELED

#define CAPTURELED   6

Number of logical LED to light when waiting for capture.

Definition at line 134 of file GirsFat.config.h.

◆ COMMANDLED

#define COMMANDLED   5

Number of logical LED to light when waiting for command.

Definition at line 141 of file GirsFat.config.h.

◆ CONFIGURABLE_LEDS

#define CONFIGURABLE_LEDS

Define to be able to reconfigure signaling LEDs during runtime.

Have parameters for transmitled etc.

Definition at line 85 of file GirsFat.config.h.

◆ DECODELED

#define DECODELED

Define to support blinking with LED according to decoding outcome.

Definition at line 47 of file GirsFat.config.h.

◆ DECODER

#define DECODER

Define to support decoding of the received signal.

Definition at line 42 of file GirsFat.config.h.

◆ DEFAULT_BEGINTIMEOUT

#define DEFAULT_BEGINTIMEOUT   10000UL

Time to wait for signal to start.

Definition at line 256 of file GirsFat.config.h.

◆ DEFAULT_CAPTURE_ENDINGTIMEOUT

#define DEFAULT_CAPTURE_ENDINGTIMEOUT   100L

By capture, time to wait before signal is considered ended.

Definition at line 272 of file GirsFat.config.h.

◆ DEFAULT_CAPTURESIZE

#define DEFAULT_CAPTURESIZE   400U

Size of capture and receive arrays.

Definition at line 282 of file GirsFat.config.h.

◆ DEFAULT_RECEIVE_ENDINGTIMEOUT

#define DEFAULT_RECEIVE_ENDINGTIMEOUT   30L

By receive, time to wait before signal is considered ended.

If using the decoder, be sure to end a capture before the repeat sequence.

Definition at line 263 of file GirsFat.config.h.

◆ DHCP

#define DHCP

Define to do IP configuration using DHCP.

Is rumored to consume rather much memory.

Definition at line 170 of file GirsFat.config.h.

◆ DONT_REPORT_DECODES

#define DONT_REPORT_DECODES

Define to have the receive command report the durations, even if DECODE is defined and a decode was found.

Use this for Lirc.

Definition at line 79 of file GirsFat.config.h.

◆ EOLCHAR

#define EOLCHAR   '\r'

Character that ends the command lines.

Definition at line 210 of file GirsFat.config.h.

◆ FREEMEM

#define FREEMEM

Define to support command "memory", reporting free (SRAM) memory.

Definition at line 100 of file GirsFat.config.h.

◆ INFO

#define INFO

Define to support command "info".

Definition at line 105 of file GirsFat.config.h.

◆ IRRECEIVER_MARK_EXCESS

#define IRRECEIVER_MARK_EXCESS   50

This quantity is added to all gaps and subtracted from all marks when receiving.

Definition at line 290 of file GirsFat.config.h.

◆ IRSENSOR_MARK_EXCESS

#define IRSENSOR_MARK_EXCESS   -10

This quantity is added to all gaps and subtracted from all marks when capturing.

Definition at line 297 of file GirsFat.config.h.

◆ LCD

#define LCD

Define to support an LCD display with I2C connection.

Defines a command "lcd".

Definition at line 52 of file GirsFat.config.h.

◆ LCD_0x27_16_2

#define LCD_0x27_16_2

Define to use LCD display at I2C address 0x27, 2 lines, 16 columns.

Definition at line 237 of file GirsFat.config.h.

◆ LCD_0x27_20_4

#define LCD_0x27_20_4

Define to use LCD display at I2C address 0x27, 4 lines, 20 columns.

Definition at line 228 of file GirsFat.config.h.

◆ LCD_0x3F_20_4

#define LCD_0x3F_20_4

Define to use LCD display at I2C address 0x3F, 4 lines, 20 columns.

Definition at line 221 of file GirsFat.config.h.

◆ LED

#define LED

Define to use signaling LEDs.

Defines command "led".

Definition at line 57 of file GirsFat.config.h.

◆ MACADDRESS

#define MACADDRESS   0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED

Must define MAC-Address to use here (!!).

Definition at line 192 of file GirsFat.config.h.

◆ NAMED_COMMANDS

#define NAMED_COMMANDS

Define to support commands called by names, grouped in sets, "remotes".

(Not yet implemented.)

Definition at line 70 of file GirsFat.config.h.

◆ NON_MOD

#define NON_MOD

Define to support sending signals without modulation, e.g.

with RF module.

Definition at line 90 of file GirsFat.config.h.

◆ PARAMETERS

#define PARAMETERS

Define to allow to change the parameters, like timeouts.

Defines command "parameters". The Lirc driver uses this, if available.

Definition at line 63 of file GirsFat.config.h.

◆ PORT

#define PORT   33333

TCP port to use.

Definition at line 204 of file GirsFat.config.h.

◆ PROGNAME

#define PROGNAME   "AGirs"

Program name, as displayed in greeting messages etc.

Definition at line 11 of file GirsFat.config.h.

◆ PRONTO

#define PRONTO

Define to support command "hex", sending Pronto hex signals.

Definition at line 110 of file GirsFat.config.h.

◆ RECEIVE

#define RECEIVE

Define to support capturing of IR signals.

Requires non-demodulating IR sensor (TSMP58000, QSE159, etc). Define to support reception of demodulated IR signals. Require demodulating IR sensor (TSMP* or equivalent).

Definition at line 37 of file GirsFat.config.h.

◆ RECEIVELED

#define RECEIVELED   7

Number of logical LED to light when waiting for reception.

Definition at line 126 of file GirsFat.config.h.

◆ RENDERER

#define RENDERER

Define to support the rendering of some known protocols, presently NEC1 and RC5.

Definition at line 23 of file GirsFat.config.h.

◆ RESET

#define RESET

Define to support a reset command, Experimental!!

Definition at line 95 of file GirsFat.config.h.

◆ SDCARD_ON_ETHERSHIELD_PIN

#define SDCARD_ON_ETHERSHIELD_PIN   4

Pin to disable (put low) on Ethernet shield.

Definition at line 164 of file GirsFat.config.h.

◆ SERIAL_DEBUG

#define SERIAL_DEBUG

Define to use Ethernet (TCP) as the communication channel.

Define to print some debug messages on the serial port when using Ethernet.

Definition at line 159 of file GirsFat.config.h.

◆ SERIALBAUD

#define SERIALBAUD   115200

Configured speed of the serial port.

Definition at line 304 of file GirsFat.config.h.

◆ SERIALTIMEOUT

#define SERIALTIMEOUT   5000L

Timeout for serial line.

Definition at line 309 of file GirsFat.config.h.

◆ TRANSMIT

#define TRANSMIT

Define to support transmission of IR signals.

Requires IR LEDs.

Definition at line 18 of file GirsFat.config.h.

◆ TRANSMITLED

#define TRANSMITLED   8

Number of logical LED to light when transmission takings place.

Definition at line 118 of file GirsFat.config.h.