Customizing the KontroLIR Firmware: Difference between revisions

From AnalysIR WiKi
Jump to navigation Jump to search
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''''[[KontroLIR - Arduino compatible IR remote control|> KontroLIR Home]]'''''
'''''[[KontroLIR - Arduino compatible IR remote control|> KontroLIR Home]]'''''
__TOC__


We explore this topic of "customizing KontroLIR Firmware" by going through each firmware file individually
We explore this topic of "customizing KontroLIR Firmware" by going through each firmware file individually


== Default Firmware Resource usage ==
The default reference firmware uses only a fraction of FLASH(~25%) & SRAM(~35%), leaving ample resources to extend the number of devices, signals and features. The output of the Arduino IDE is shown below, for reference.
''<q>Sketch uses 8278 bytes (25%) of program storage space. Maximum is 32256 bytes. Global variables use 727 bytes (35%) of dynamic memory, leaving 1321 bytes for local variables. Maximum is 2048 bytes.</q>''
Note: The above information is based on the initial pre-release version and is subject to variation over time.
== KIR ==
KIR is used throughout the firmware source code and is short for KontroLIR.


== KontroLIR Firmware ==
== KontroLIR Firmware ==
Line 38: Line 52:


[[KIR_Vars.h]] - all '''non'''-local variables are defined here
[[KIR_Vars.h]] - all '''non'''-local variables are defined here
[[KIR_Macros.ino]] - all macros are defined here


[[NOTES.ino]] - A collection of misc. placeholder notes for internal use only
[[NOTES.ino]] - A collection of misc. placeholder notes for internal use only
Line 43: Line 59:


The files above represent the KontroLIR reference firmware. You will have to modify some of these to configure your own KontroLIR remote. A copy of the firmware source is provided with your order.
The files above represent the KontroLIR reference firmware. You will have to modify some of these to configure your own KontroLIR remote. A copy of the firmware source is provided with your order.


== KontroLIR Macros ==
== KontroLIR Macros ==

Latest revision as of 08:58, 10 December 2019

> KontroLIR Home

We explore this topic of "customizing KontroLIR Firmware" by going through each firmware file individually


Default Firmware Resource usage

The default reference firmware uses only a fraction of FLASH(~25%) & SRAM(~35%), leaving ample resources to extend the number of devices, signals and features. The output of the Arduino IDE is shown below, for reference.

Sketch uses 8278 bytes (25%) of program storage space. Maximum is 32256 bytes. Global variables use 727 bytes (35%) of dynamic memory, leaving 1321 bytes for local variables. Maximum is 2048 bytes.

Note: The above information is based on the initial pre-release version and is subject to variation over time.

KIR

KIR is used throughout the firmware source code and is short for KontroLIR.

KontroLIR Firmware

KontrolIR_V1.00.ino - The main Arduino sketch file

KIR_buttons.ino - functions related to KontrolIR buttons

KIR_Copyright.h - Copyright and Licence Information (applies to all code)

KIR_extEEPROM.ino - functions related to (optional) external I2C EEPROM

KIR_header.h - KontroLIR definitions and macros

KIR_Infrared_Tx.ino - functions related to IR signal sending

KIR_Interrupts.ino - functions related to Pin Change and other Interrupts

KIR_IRremote.ino - functions related to any future IRremote modifications/workarounds

KIR_Misc_Functions.ino - a bundle of general KontroLIR system functions

KIR_Mode1_Functions.ino - Mode1 button / function mapping

KIR_Mode2_Functions.ino - Mode2 button / function mapping

KIR_Mode3_Functions.ino - Mode3 button / function mapping

KIR_Mode4_Functions.ino - Mode4 button / function mapping

KIR_Mode5_Functions.ino - Mode5 button / function mapping

KIR_RAW_Signals.h - Definition of Flash based RAW signals used

KIR_Vars.h - all non-local variables are defined here

KIR_Macros.ino - all macros are defined here

NOTES.ino - A collection of misc. placeholder notes for internal use only


The files above represent the KontroLIR reference firmware. You will have to modify some of these to configure your own KontroLIR remote. A copy of the firmware source is provided with your order.

KontroLIR Macros

KontroLIR Macros - information about adding IR macros to KontroLIR


> KontroLIR Home