Difference between revisions of "Getting started: Microduino IDE for Windows"

From Microduino Wiki
Jump to: navigation, search
(Download)
(Download)
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Language|Getting started: Windows}}
 
 
{| style="width: 80%;"
 
{| style="width: 80%;"
 
|-
 
|-
 
|
 
|
 +
The guide below is a software setup guide for Windows aimed for general use of Microduino products.
 +
 +
For kit specific getting started guides please follow the appropriate links in the [[#Kit_Specific_Software_Setup_Guides]] section:
 +
 +
=Kit Specific Software Setup Guides=
 +
{{Clickable_headed_image_table_box_small|header=Itty Bitty City|link=Getting_Started_with_Itty_Bitty_City_(Windows)|image=File:IBC.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_small|header=mCookie 101 Basic|link=Getting_Started_with_101_Basic_Kit_(Windows)|image=File:mCookie_Basic_Kit.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_small|header=mCookie 201 Advanced|link=Getting_Started_with_201_Advanced_Kit_(Windows)|image=File:mCookie_Advanced_Kit.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_small|header=mCookie 301 Expert|link=Getting_Started_with_301_Expert_Kit_(Windows)|image=File:mCookie_Expert_Kit.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_small|header=mCookie 102 Basic|link=Getting_Started_with_102_Basic_Kit_(Windows)|image=File:mCookie_102_Basic_Kit.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_small|header=mCookie 202 Advanced|link=Getting_Started_with_202_Advanced_Kit_(Windows)|image=File:mCookie_202_Advanced_Kit.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_small|header=mCookie 302 Expert|link=Getting_Started_with_302_Expert_Kit_(Windows)|image=File:mCookie_302_Expert_Kit.png|image_size=140px|table_width=175px|table_height=150px}}
 +
{{Clickable_headed_image_table_box_clear}}
 +
<big><b>If your kit is not listed, please proceed following the general setup guide below.</b></big>
 +
 +
=Previous Installations=
 +
{| class="wikitable" style="background-color:#FEF9E7;"
 +
|'''Note:''' If you have a previous version installed already, you must uninstall that version prior to installing a newer version.
 +
*Go to Control Panel and uninstall the '''Arduino IDE for Microduino'''.
 +
*Delete the '''C:\Program Files (x86)\Arduino IDE for Microduino''' folder as some legacy files may cause issues with a new installation.
 +
Then proceed to the next steps.
 +
|}
 +
 
=Download=
 
=Download=
*Download the latest Windows IDE: https://www.microduino.cc/download
+
Download the latest Windows IDE (Version 5.0, 2019-03-25): [https://microduinoinc.com/downloads/Arduino.IDE.for.Microduino-win-1.8.4-V5.0.exe <big>HERE</big>]
 +
[[File:Arduino_Download.png|link=https://microduinoinc.com/downloads/Arduino.IDE.for.Microduino-win-1.8.4-V5.0.exe|150px|left|thumb]]<br clear=all>
  
 
=Installation=
 
=Installation=
*Double click on the setup file '''Arduino IDE 1.X.X for Microduino.exe'''. Click '''[Next]'''.
+
1. Double click on the setup file to start the installation process. Click <b>Next</b>.
[[File:IDEsetup1.JPG|500px|center|thumb]]
+
[[File:WinInstallNew_01.png|500px|left|thumb]]<br clear=all>
*Make sure '''Arduino IDE''', '''USBTTL driver''', and '''Core USB driver''' are all checked. Click '''[Next]'''.
+
2. The next window will allow you to select which options to install. Leave all checked and click <b>Install</b>.
[[File:IDEsetup2.JPG|500px|center|thumb]]
+
[[File:WinInstallNew_02.png|500px|left|thumb]]<br clear=all>
*Click '''[Browse...]''' if you would like to choose a different installation destination. Then click '''[Next]''' and '''[Install]'''.
+
3. The installation process will begin for the Arduino IDE.  
[[File:IDEsetup3.JPG|500px|center|thumb]]
+
[[File:WinInstallNew_03.png|500px|left|thumb]]<br clear=all>
<br>
+
4. Wait until it is complete.
[[File:IDEsetup4.JPG|500px|center|thumb]]
+
[[File:WinInstallNew_04.png|500px|left|thumb]]<br clear=all>
*After the Arduino IDE has been installed, a window for driver installation will appear. Click '''[Extract]''' and follow the instructions.  
+
5. After the Arduino IDE has been installed, a window for driver installation will appear. Click <b>Next</b>.
[[File:IDEsetup5.JPG|500px|center|thumb]]
+
[[File:WinInstallNew_05.png|500px|left|thumb]]<br clear=all>
*Click '''[Finish]''' to complete the installation.
+
6. Click on "<b>I accept this agreement</b>" and click <b>Next</b> to start the drivers installation.
[[File:IDEsetup6.JPG|500px|center|thumb]]
+
[[File:WinInstallNew_06.png|500px|left|thumb]]<br clear=all>
*After installation, there will be a shortcut to the Arduino IDE on your desktop.  
+
7. After the drivers are installed, click <b>Finish</b>.
[[File:ArduinoIcon.png|200px|center|thumb]]
+
[[File:WinInstallNew_07.png|500px|left|thumb]]<br clear=all>
 +
8.Installation is now complete! Click on <b>Finish</b>.
 +
[[File:WinInstallNew_08.png|500px|left|thumb]]<br clear=all>
 +
9.If you left the run option checked, the software will start to launch. Otherwise locate the program shortcut on your desktop or start menu and launch it.
 +
[[File:WinInstallNew_09.png|500px|left|thumb]]<br clear=all>
 +
10. The software is now ready to be used!
 +
[[File:WinInstallNew_10.png|500px|left|thumb]]<br clear=all>
  
 
=Confirm Drivers Installed Successfully=
 
=Confirm Drivers Installed Successfully=
 +
Confirm that the drivers are installed successfully based on your hardware.
 +
 +
Refer to the table below for which programmer each kit uses:
 +
{| class="wikitable"
 +
|-
 +
! Programmer
 +
! Contained in Kit
 +
! Programmable Boards
 +
|-
 +
| USBTTL
 +
| 102 Basic Kit
 +
| Core, Core+, CoreRF
 +
|-
 +
| mBattery
 +
| Itty Bitty City, 202 Advanced Kit, 302 Expert Kit
 +
| Core, Core+, CoreRF
 +
|-
 +
| (CoreUSB)*
 +
| X01 Series Kits: 101 Basic Kit; 201 Advanced Kit; 301 Expert Kit
 +
| CoreUSB
 +
|}
 +
*NOTE: CoreUSB is a core module with an integrated programmer.
  
 
==USBTTL==
 
==USBTTL==
Line 33: Line 84:
 
*Connect [[mCookie-Battery]] to your computer.
 
*Connect [[mCookie-Battery]] to your computer.
 
[[File:MBattery-t.jpg|400px|center|thumb]]
 
[[File:MBattery-t.jpg|400px|center|thumb]]
<blockquote>IMPORTANT: Ensure that mBattery is "ON" by pressing and holding the button. A red LED should be on, which indicates that power is being supplied to the modules.</blockquote>
+
<blockquote>IMPORTANT: Ensure that mBattery is "ON" by pressing and holding the button. A red LED should be on, which indicates that power is being supplied to the modules. mBattery must be "ON" in order to program the modules.</blockquote>
 
*Verify that there are available Port options under Tools.
 
*Verify that there are available Port options under Tools.
 
[[File:microduinoGettingStart-USBTTL.jpg|500px|center|thumb]]
 
[[File:microduinoGettingStart-USBTTL.jpg|500px|center|thumb]]
Line 64: Line 115:
 
|-
 
|-
 
| Atmega328P@16M,5V
 
| Atmega328P@16M,5V
| Itty Bitty City Kit, X02 Series Kits: [[102 Basic Kit]]; [[202 Advanced Kit]]; [[302 Expert Kit]]
+
| [[Itty_Bitty_City|Itty Bitty City Kit]], '''X02 Series Kits''': [[MCookie_Basic_Kit|102 Basic Kit]]; [[MCookie_Advanced_Kit|202 Advanced Kit]]; [[MCookie_Expert_Kit|302 Expert Kit]]
 
|-
 
|-
 
| rowspan="2" | Core+ (644pa)
 
| rowspan="2" | Core+ (644pa)
Line 71: Line 122:
 
|-
 
|-
 
| Atmega644pa@16M,5V
 
| Atmega644pa@16M,5V
| 302 Expert Kit
+
| [[MCookie_Expert_Kit|302 Expert Kit]]
 
|-
 
|-
 
| rowspan="2" | Core+ (1284pa)
 
| rowspan="2" | Core+ (1284pa)
Line 82: Line 133:
 
| Microduino/mCookie-Core USB (32u4)
 
| Microduino/mCookie-Core USB (32u4)
 
| USB
 
| USB
| X01 Series Kits: [[101 Basic Kit]]; [[201 Advanced Kit]]; [[301 Expert Kit]]
+
| '''X01 Series Kits''': [[MCookie_Basic_Kit|101 Basic Kit]]; [[MCookie_Advanced_Kit|201 Advanced Kit]]; [[MCookie_Expert_Kit|301 Expert Kit]]
 
|-
 
|-
 
| CoreRF
 
| CoreRF
Line 103: Line 154:
 
===Interface===
 
===Interface===
 
[[File:Interface.png|400px|center|thumb]]
 
[[File:Interface.png|400px|center|thumb]]
*【Verify】: Checks for errors in the code.
+
*'''[Verify]''': Checks for errors in the code.
  
*【Upload】: Uploads the program to a MCU.
+
*'''[Upload]''': Uploads the program to a MCU.
  
*【Serial Monitor】: Useful in debugging programs.
+
*'''[Serial Monitor]''': Useful in debugging programs.
  
 
===Tools===
 
===Tools===
 
[[File:Tools.JPG|400px|center|thumb]]
 
[[File:Tools.JPG|400px|center|thumb]]
*【Board】: Select the corresponding core module to which the program is being uploaded.
+
*'''[Board]''': Select the corresponding core module to which the program is being uploaded.
  
*【Processor】: Select the corresponding processor.
+
*'''[Processor]''': Select the corresponding processor.
  
*【Port】: Select the common USB port.
+
*'''[Port]''': Select the common USB port.
  
 
===Uploading Code===
 
===Uploading Code===
Line 122: Line 173:
 
#Click upload.
 
#Click upload.
  
|}
+
 
 +
*Note: If using mBattery to upload to a core module. Ensure that mBattery is "ON" and supplying power to the modules. There will be a red LED on.
 +
[[File:MBattery-t.jpg|300px]]

Revision as of 16:11, 25 March 2019

The guide below is a software setup guide for Windows aimed for general use of Microduino products.

For kit specific getting started guides please follow the appropriate links in the #Kit_Specific_Software_Setup_Guides section:

Kit Specific Software Setup Guides

If your kit is not listed, please proceed following the general setup guide below.

Previous Installations

Note: If you have a previous version installed already, you must uninstall that version prior to installing a newer version.
  • Go to Control Panel and uninstall the Arduino IDE for Microduino.
  • Delete the C:\Program Files (x86)\Arduino IDE for Microduino folder as some legacy files may cause issues with a new installation.

Then proceed to the next steps.

Download

Download the latest Windows IDE (Version 5.0, 2019-03-25): HERE

Arduino Download.png

Installation

1. Double click on the setup file to start the installation process. Click Next.

WinInstallNew 01.png

2. The next window will allow you to select which options to install. Leave all checked and click Install.

WinInstallNew 02.png

3. The installation process will begin for the Arduino IDE.

WinInstallNew 03.png

4. Wait until it is complete.

WinInstallNew 04.png

5. After the Arduino IDE has been installed, a window for driver installation will appear. Click Next.

WinInstallNew 05.png

6. Click on "I accept this agreement" and click Next to start the drivers installation.

WinInstallNew 06.png

7. After the drivers are installed, click Finish.

WinInstallNew 07.png

8.Installation is now complete! Click on Finish.

WinInstallNew 08.png

9.If you left the run option checked, the software will start to launch. Otherwise locate the program shortcut on your desktop or start menu and launch it.

WinInstallNew 09.png

10. The software is now ready to be used!

WinInstallNew 10.png

Confirm Drivers Installed Successfully

Confirm that the drivers are installed successfully based on your hardware.

Refer to the table below for which programmer each kit uses:

Programmer Contained in Kit Programmable Boards
USBTTL 102 Basic Kit Core, Core+, CoreRF
mBattery Itty Bitty City, 202 Advanced Kit, 302 Expert Kit Core, Core+, CoreRF
(CoreUSB)* X01 Series Kits: 101 Basic Kit; 201 Advanced Kit; 301 Expert Kit CoreUSB
  • NOTE: CoreUSB is a core module with an integrated programmer.

USBTTL

  • Connect Microduino-USBTTL to your computer. Verify that there are available Port options under Tools.
MicroduinoGettingStart-USBTTL.jpg

CoreUSB

MicroduinoGettingStart-CoreUSB.jpg

mBattery

MBattery-t.jpg
IMPORTANT: Ensure that mBattery is "ON" by pressing and holding the button. A red LED should be on, which indicates that power is being supplied to the modules. mBattery must be "ON" in order to program the modules.
  • Verify that there are available Port options under Tools.
MicroduinoGettingStart-USBTTL.jpg

Selecting Board Type and Processor

Selecting the Board Type and Processor is required to compile the correct code for the core module.

Configuring the software is done under Tools > Board and Tools > Processor.

Below is the table which lists all the core modules with corresponding Board and Processor. The table also lists kits that contain specific core modules.

Example usage would be for the Core module in Itty Bitty City. Board is Microduino/mCookie-Core (328p) and Processor is Atmega328P@16M,5V.

Name Board Processor Contained in Kit
Core (168pa) Microduino/mCookie-Core (168pa) Atmega168pa@8M,3.3V
Atmega168pa@16M,5V
Core (328p) Microduino/mCookie-Core (328p) Atmega328P@8M,3.3V
Atmega328P@16M,5V Itty Bitty City Kit, X02 Series Kits: 102 Basic Kit; 202 Advanced Kit; 302 Expert Kit
Core+ (644pa) Microduino/mCookie-Core+ (644pa) Atmega644pa@16M,3.3V
Atmega644pa@16M,5V 302 Expert Kit
Core+ (1284pa) Microduino/mCookie-Core+ (1284pa) Atmega1284pa@8M,3.3V
Atmega1284pa@16M,5V
CoreUSB Microduino/mCookie-Core USB (32u4) USB X01 Series Kits: 101 Basic Kit; 201 Advanced Kit; 301 Expert Kit
CoreRF Microduino/mCookie RF (128rfa1)

Determining Processor Variant

Core

MicroduinoGettingStart-Core3V3.jpg MicroduinoGettingStart-Core+3V3.jpg

Core+

MicroduinoGettingStart-Core5V.jpg MicroduinoGettingStart-Core+5V.jpg

Arduino IDE Basics

Interface

Interface.png
  • [Verify]: Checks for errors in the code.
  • [Upload]: Uploads the program to a MCU.
  • [Serial Monitor]: Useful in debugging programs.

Tools

Tools.JPG
  • [Board]: Select the corresponding core module to which the program is being uploaded.
  • [Processor]: Select the corresponding processor.
  • [Port]: Select the common USB port.

Uploading Code

  1. Select board type and processor.
  2. Select the port.
  3. Click upload.


  • Note: If using mBattery to upload to a core module. Ensure that mBattery is "ON" and supplying power to the modules. There will be a red LED on.

MBattery-t.jpg