Getting Started - Revision history

AnalysIR: /* Test Suite */

2021-01-13T18:20:08Z

Test Suite

← Older revision		Revision as of 11:20, 13 January 2021
Line 50:		Line 50:

	To upload the Test Suite Firmware Sketch:		To upload the Test Suite Firmware Sketch:
	* Copy the folder ~~KIR_Vx.xxTestSuite~~ to your Arduino sketch folder ~~''(Vx.xx is the version number - initially V1.00)''~~		* Copy the folder KIR_TestSuite to your Arduino sketch folder
	* Open it in the Arduino IDE		* Open it in the Arduino IDE
	* Under Tools menu, Select ATmega328PB Crystal Clock as the target board		* Under Tools menu, Select ATmega328PB Crystal Clock as the target board

AnalysIR: /* Required Libraries */

2020-03-01T19:06:21Z

Required Libraries

← Older revision		Revision as of 12:06, 1 March 2020
Line 18:		Line 18:


	== Required Libraries ==		== Required Arduino Libraries ==
	You will need to have several libraries installed & configured on the Arduino IDE.		You will need to have several libraries installed & configured on the Arduino IDE.

Line 24:		Line 24:
	* extEEPROM (via [https://github.com/JChristensen/extEEPROM GitHub])		* extEEPROM (via [https://github.com/JChristensen/extEEPROM GitHub])
	* Wire		* Wire

			Make sure to have these libraries installed, before proceeding.

	== Checklist ==		== Checklist ==

AnalysIR: /* Required Libraries */

2020-03-01T19:05:27Z

Required Libraries

← Older revision		Revision as of 12:05, 1 March 2020
Line 22:		Line 22:

	* IRremote (see [[Configuring IRremote]])		* IRremote (see [[Configuring IRremote]])
	* extEEPROM		* extEEPROM (via [https://github.com/JChristensen/extEEPROM GitHub])
	* Wire		* Wire

AnalysIR: /* Arduino IDE */

2020-03-01T19:04:29Z

Arduino IDE

← Older revision		Revision as of 12:04, 1 March 2020
Line 16:		Line 16:

	When using the Arduino IDE, you must always make sure that the folder Name & the name of the main '.ino' both match (including lower/upper case characters but excluding the '.ino' extension). Otherwise you will likely experience some compilations errors.		When using the Arduino IDE, you must always make sure that the folder Name & the name of the main '.ino' both match (including lower/upper case characters but excluding the '.ino' extension). Otherwise you will likely experience some compilations errors.


			== Required Libraries ==
			You will need to have several libraries installed & configured on the Arduino IDE.

			* IRremote (see [[Configuring IRremote]])
			* extEEPROM
			* Wire

	== Checklist ==		== Checklist ==

AnalysIR: /* Test Suite */

2020-03-01T19:03:19Z

Test Suite

← Older revision		Revision as of 12:03, 1 March 2020
Line 51:		Line 51:
	* Open the Arduino terminal window and set the BAUD rate to 19200.		* Open the Arduino terminal window and set the BAUD rate to 19200.
	* You should see a menu and initial test reporting displayed from the sketch.		* You should see a menu and initial test reporting displayed from the sketch.
	* Verify that the configured EEPROM size matches what you ordered in KBytes. If it doesn't, change the definitions for EEPROM size near the end of the ''KIR_Vars.h'' header file. ''(If you did not ~~oreder~~ an EEPROM option, you can ignore this. However, you will still need to install extEEPROM library for ~~hte~~ tests to compile.)''		* Verify that the configured EEPROM size matches what you ordered in KBytes. If it doesn't, change the definitions for EEPROM size near the end of the ''KIR_Vars.h'' header file. ''(If you did not order an EEPROM option, you can ignore this. However, you will still need to install extEEPROM library for the tests to compile.)''
	* CAUTION: Most of the files in the test suite are similar to the main KontroLIR file. Be aware they are not the same and may have minor differences - even though the files names are the same.		* CAUTION: Most of the files in the test suite are similar to the main KontroLIR file. Be aware they are not the same and may have minor differences - even though the files names are the same.

AnalysIR: /* Arduino IDE */

2020-01-28T17:36:12Z

Arduino IDE

← Older revision		Revision as of 10:36, 28 January 2020
Line 14:		Line 14:
	'''User feedback:''' If you manually installed extEEPROM previously, you may have to remove it and re-install using the library manager of the Arduino IDE '''''(via Menu->Sketch->Include Library->Manage Libraries)'''''		'''User feedback:''' If you manually installed extEEPROM previously, you may have to remove it and re-install using the library manager of the Arduino IDE '''''(via Menu->Sketch->Include Library->Manage Libraries)'''''
	''Also see forum post, in case you get related compiler errors. ([https://irforum.analysir.com/viewtopic.php?f=16&t=992#p2092 related IRforum post] )''		''Also see forum post, in case you get related compiler errors. ([https://irforum.analysir.com/viewtopic.php?f=16&t=992#p2092 related IRforum post] )''

			When using the Arduino IDE, you must always make sure that the folder Name & the name of the main '.ino' both match (including lower/upper case characters but excluding the '.ino' extension). Otherwise you will likely experience some compilations errors.

	== Checklist ==		== Checklist ==

AnalysIR: /* Arduino IDE */

2020-01-28T12:00:03Z

Arduino IDE

← Older revision		Revision as of 05:00, 28 January 2020
Line 13:		Line 13:

	'''User feedback:''' If you manually installed extEEPROM previously, you may have to remove it and re-install using the library manager of the Arduino IDE '''''(via Menu->Sketch->Include Library->Manage Libraries)'''''		'''User feedback:''' If you manually installed extEEPROM previously, you may have to remove it and re-install using the library manager of the Arduino IDE '''''(via Menu->Sketch->Include Library->Manage Libraries)'''''
			''Also see forum post, in case you get related compiler errors. ([https://irforum.analysir.com/viewtopic.php?f=16&t=992#p2092 related IRforum post] )''

	== Checklist ==		== Checklist ==

AnalysIR: /* Test Suite */

2020-01-16T15:15:25Z

Test Suite

← Older revision		Revision as of 08:15, 16 January 2020
Line 48:		Line 48:
	* Open the Arduino terminal window and set the BAUD rate to 19200.		* Open the Arduino terminal window and set the BAUD rate to 19200.
	* You should see a menu and initial test reporting displayed from the sketch.		* You should see a menu and initial test reporting displayed from the sketch.
	* Verify that the configured EEPROM size matches what you ordered in KBytes. If it doesn't, change the definitions for EEPROM size near the end of the ''KIR_Vars.h'' header file.		* Verify that the configured EEPROM size matches what you ordered in KBytes. If it doesn't, change the definitions for EEPROM size near the end of the ''KIR_Vars.h'' header file. ''(If you did not oreder an EEPROM option, you can ignore this. However, you will still need to install extEEPROM library for hte tests to compile.)''
	* CAUTION: Most of the files in the test suite are similar to the main KontroLIR file. Be aware they are not the same and may have minor differences - even though the files names are the same.		* CAUTION: Most of the files in the test suite are similar to the main KontroLIR file. Be aware they are not the same and may have minor differences - even though the files names are the same.

AnalysIR: /* Checklist */

2020-01-16T15:09:56Z

Checklist

← Older revision		Revision as of 08:09, 16 January 2020
Line 15:		Line 15:

	== Checklist ==		== Checklist ==
	* Make sure you have s SerialUSB adapter which has a pin-out for Vcc, GND, Tx, Rx and either DTR or RTS. ''(Note: some adapters do not have a DTR/RTS pin available, which is required for uploading firmware using the Arduino IDE)''. If you are in any way unsure about this, make sure to purchase the SerialUSB option when ordering your KontroLIR. Vcc & Signal pins should operate at 5V (not 3V3) levels.		* Make sure you have a SerialUSB adapter which has a pin-out for Vcc, GND, Tx, Rx and either DTR or RTS. ''(Note: some adapters do not have a DTR/RTS pin available, which is required for uploading firmware using the Arduino IDE)''. If you are in any way unsure about this, make sure to purchase the SerialUSB option when ordering your KontroLIR. Vcc & Signal pins should operate at 5V (not 3V3) levels.
	* Make sure you have a USB cable, of sufficient length, to use with the serialUSB adapter.		* Make sure you have a USB cable, of sufficient length, to use with the serialUSB adapter.
	* Double check your order to establish if you have one or more of the options (EEPROM or dual IR Receivers)		* Double check your order to establish if you have one or more of the options (EEPROM or dual IR Receivers)

AnalysIR: /* Arduino IDE */

2020-01-16T13:09:03Z

Arduino IDE

← Older revision		Revision as of 06:09, 16 January 2020
Line 12:		Line 12:
	[https://github.com/JChristensen/extEEPROM Install the extEEPROM library from here]		[https://github.com/JChristensen/extEEPROM Install the extEEPROM library from here]

	'''User feedback:''' If you manually installed extEEPROM previously, you may have to remove it and re-install using the library manager of the Arduino IDE '''(via Menu->Sketch->Include Library->Manage Libraries)'''~~''Italic text~~''		'''User feedback:''' If you manually installed extEEPROM previously, you may have to remove it and re-install using the library manager of the Arduino IDE '''''(via Menu->Sketch->Include Library->Manage Libraries)'''''

	== Checklist ==		== Checklist ==