Difference between revisions of "Quick Start Guide"

From KONNEKTING Wiki
Jump to navigation Jump to search
Line 7: Line 7:
  
 
== Download Arduino IDE ==
 
== Download Arduino IDE ==
 
  
 
Go to https://www.arduino.cc/en/Main/Software and download latest Arduino IDE for your OS. If possible, use 64bit version.
 
Go to https://www.arduino.cc/en/Main/Software and download latest Arduino IDE for your OS. If possible, use 64bit version.
Line 22: Line 21:
  
 
'''DO NOT USE ANY OTHER SOURCE FOR GETTING KONNEKTING DEVICE LIBRARY. DO NOT DOWNLOAD FROM GITHUB OR GITLAB.'''
 
'''DO NOT USE ANY OTHER SOURCE FOR GETTING KONNEKTING DEVICE LIBRARY. DO NOT DOWNLOAD FROM GITHUB OR GITLAB.'''
 +
  
 
== Download Boards ==
 
== Download Boards ==
Line 34: Line 34:
  
 
If you work with Atmel/Microchip based SAMD-Boards, install latest "'''Arduino SAMD Boards (32-bits ARM Cortex-M0+)''' by '''Arduino'''". Install latest version.
 
If you work with Atmel/Microchip based SAMD-Boards, install latest "'''Arduino SAMD Boards (32-bits ARM Cortex-M0+)''' by '''Arduino'''". Install latest version.
 
  
  
 
== Experts only: Setup Arduino IDE ==
 
== Experts only: Setup Arduino IDE ==
 
  
 
Open Arduino IDE an go to  
 
Open Arduino IDE an go to  
Line 47: Line 45:
 
** Compiler Warnings: '''[Default]''' (or more ...)
 
** Compiler Warnings: '''[Default]''' (or more ...)
 
** Display line numbers '''[x]'''
 
** Display line numbers '''[x]'''
 +
 +
== Compile first sketch ==
 +
 +
Now it's time to compile your first sketch to test your setup:
 +
 +
Open Arduino IDE an go to
 +
 +
* Menu: File
 +
* Sub menu: Examples
 +
* Section: Examples from custom libraries
 +
* Menu item: KONNEKTING Device Library
 +
* Sub menu item: DemoSketch
 +
 +
The sketch opens with three tabs: DemoSketch, EEPROM_24AA256.h and kdevice_DemoSketch.h
 +
 +
Go to:
 +
 +
* Menu: Tools
 +
* Sub menu: Board: ...
 +
* Section: Arduino AVR Boards
 +
* Menu item: Arduino Nano
 +
 +
Click the "checkmark" symbol in the toolbar. This "verifies" the sketch and checks for errors. The IDE will work a for a few seconds and put some output in the console window section. Finally it should tell you "Done compiling." and console window will tell you something similar to
 +
this
 +
 +
<pre>
 +
Sketch uses 25372 bytes (82%) of program storage space. Maximum is 30720 bytes.
 +
Global variables use 633 bytes (30%) of dynamic memory, leaving 1415 bytes for local variables. Maximum is 2048 bytes.
 +
</pre>
 +
 +
If you reached this point, your basic setup works and you can start working on your own sketch.

Revision as of 10:20, 5 January 2020

This is a very short quick start guide to help you setup your environment for KONNEKTING device development.

This guide has been written with following version(s):

  • Arduino IDE 1.8.10


Download Arduino IDE

Go to https://www.arduino.cc/en/Main/Software and download latest Arduino IDE for your OS. If possible, use 64bit version. Unzip/Install and run your Arduino IDE.


Download KONNEKTING Device Library

Open Arduino IDE an go to

  • Menu: Tools
  • Menu item: Manage Libraries
  • Search for "KONNEKTING" and install latest "KONNEKTING Device Library by Alexander Christian".

DO NOT USE ANY OTHER SOURCE FOR GETTING KONNEKTING DEVICE LIBRARY. DO NOT DOWNLOAD FROM GITHUB OR GITLAB.


Download Boards

Open Arduino IDE an go to

  • Menu: Tools
  • Menu item: "Board: ..."
  • Sub menu item: "Boards Manager ..."

Search for "Arduino AVR Boards by Arduino". Ensure you have the latest version installed.

If you work with Atmel/Microchip based SAMD-Boards, install latest "Arduino SAMD Boards (32-bits ARM Cortex-M0+) by Arduino". Install latest version.


Experts only: Setup Arduino IDE

Open Arduino IDE an go to

  • Menu: File
  • Menu item: Preferences
    • Show verbose output during [x] compilation [x] upload
    • Compiler Warnings: [Default] (or more ...)
    • Display line numbers [x]

Compile first sketch

Now it's time to compile your first sketch to test your setup:

Open Arduino IDE an go to

  • Menu: File
  • Sub menu: Examples
  • Section: Examples from custom libraries
  • Menu item: KONNEKTING Device Library
  • Sub menu item: DemoSketch

The sketch opens with three tabs: DemoSketch, EEPROM_24AA256.h and kdevice_DemoSketch.h

Go to:

  • Menu: Tools
  • Sub menu: Board: ...
  • Section: Arduino AVR Boards
  • Menu item: Arduino Nano

Click the "checkmark" symbol in the toolbar. This "verifies" the sketch and checks for errors. The IDE will work a for a few seconds and put some output in the console window section. Finally it should tell you "Done compiling." and console window will tell you something similar to this

Sketch uses 25372 bytes (82%) of program storage space. Maximum is 30720 bytes.
Global variables use 633 bytes (30%) of dynamic memory, leaving 1415 bytes for local variables. Maximum is 2048 bytes.

If you reached this point, your basic setup works and you can start working on your own sketch.