Difference between revisions of "Installing software"

From Evil Mad Scientist Wiki
Jump to: navigation, search
(Revert spacing)
(Update install docs)
Line 1: Line 1:
 
{{EggBotDocs}}
 
{{EggBotDocs}}
 
  
 
Eggbot is designed to work well on Mac, Windows, and Linux computers.  To use it, you'll need to install certain software on your computer.
 
Eggbot is designed to work well on Mac, Windows, and Linux computers.  To use it, you'll need to install certain software on your computer.
  
 +
The EggBot software actually consists of two main parts:
 +
# Inkscape, the superb freeware vector graphics application (''NOTE: Inkscape 0.92 is the recommended version at this time.'')
 +
# The EggBot extensions for Inkscape, which let you control the EggBot from within Inkscape
  
The Eggbot software actually consists of two main parts:
+
Optionally but suggested, you may also want to download the set of example files from the [https://github.com/evil-mad/EggBot/releases/latest EggBot Releases page]. The particulars of installation depend on the operating system; please see information for each type of computer below.
# Inkscape, the superb freeware vector graphics application (''NOTE: Inkscape 0.91 is the recommended version at this time.'')
 
# The Eggbot extensions for Inkscape, which let you control the Eggbot from within Inkscape
 
  
  
Optionally but suggested, you may also want to download the set of example files from the [https://github.com/evil-mad/EggBot/releases/latest EggBot Releases page].
+
== Mac ==
 
 
 
 
The particulars of installation depend on the operating system:
 
 
 
  
== Mac ==
+
The instructions below are for MacOS 10.7 and newer.
  
1. Download and install Inkscape version 0.91 from [https://inkscape.org/en/release/0.91/platforms/ this download page] at Inkscape.org.   (''We do not yet recommend Inkscape 0.92.'')
+
1. Download and open the [https://github.com/evil-mad/EggBot/releases/download/untagged-3d6267776a29271a93f4/EggBot.Mac.Bundle.dmg EggBot Mac bundle DMG]
Most users will want the "Mac-Os-X : 107-1010 : Dmg" version.
 
 
   
 
   
:* Install Inkscape in the default location, the main "Applications" folder.
+
2. Run the XQuartz installer included in that DMG (disk image) file.
:*Note that inkscape is an X11 application, and will require that X11 or XQuartz is installed on your Mac.
 
:: For MacOS 10.6 and newer (Snow Leopard, Lion, Mountain Lion, Mavericks, Yosemite, etc.), download and install the latest release of  [http://xquartz.macosforge.org/trac/wiki XQuartz].
 
:: For MacOS 10.5 (Leopard), download and install the "Final Leopard Release," from the [http://xquartz.macosforge.org/trac/wiki/Releases XQuartz site].
 
:: For MacOS 10.4, use the X11 that came on your system installer disks.
 
:* If you need additional assistance for installing Inkscape, you may be able to find good advice at the [http://wiki.inkscape.org/wiki/index.php/InstallHelp the Inkscape wiki] and/or the [http://www.inkscapeforum.com/ Inkscape Forums].  ''Please do not use Inkscape support resources for Eggbot-specific issues-- see note below about troubleshooting.''
 
  
 +
3. Drag the included copy of Inkscape to your "Applications" folder.
  
2. Download and install the Eggbot Extensions for Inkscape
+
4. Eject the disk image (DMG).
  
:* The Mac software for EggBot is available at [https://github.com/evil-mad/EggBot/releases/latest/ github].  Download and run the Mac installer.  We recommend that you also download the EggBot Example set.
 
:* The "Eggbot" submenu should appear in the Extensions menu of Inkscape after you restart Inkscape. It will not appear there until you both run the installer and restart Inkscape.
 
  
 +
==== Troubleshooting ====
  
3. Troubleshooting
+
: Your software should now be set up to work correctly. 
 +
:* If copy and paste are not working correctly in Inkscape, open the XQuartz preferences dialog, and disable the "Update Pasteboard when CLIPBOARD changes" option.
 +
:* If you encounter difficulty installing the Inkscape (or with plotting, in the next stage), please request assistance through the EggBot mailing list or forum, which you can find on our [[Eggbot|front page]]. 
 +
:* If there is any chance that a problem you encounter is specific to EggBot software or hardware, please request support from us, rather than through Inkscape's support resources. You're much more likely to get your problem solved by asking people who know about Eggbot.  
  
: Your software should now be set up to work correctly. 
 
:* If copy and paste are not working correctly in Inkscape, open the X11 preferences dialog, and disable the "Update Pasteboard when CLIPBOARD changes" option.
 
:* If you encounter difficulty installing the Eggbot extensions for Inkscape (or with plotting, in the next stage), please request assistance through the Eggbot mailing list or forum, which you can find on our [[Eggbot|front page]]. 
 
:* If there is any chance that a problem you encounter is specific to Eggbot software or hardware, it is important that you do not directly seek assistance through Inkscape's support resources. You're much more likely to get your problem solved by asking people who know about Eggbot. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.
 
  
 
== Windows ==
 
== Windows ==
  
1. Download and install Inkscape version 0.91 from [https://inkscape.org/en/release/0.91/platforms/ the download page] at Inkscape.org.    (Most users will want the "Windows : 64-Bit : Msi" download.)
+
1. Download and install Inkscape version 0.92.4 from [https://inkscape.org/release/0.92.4/windows/ the download page] at Inkscape.org.    (Most users will want the "Windows : 64-Bit : Msi" download.)
 
 
:* Install Inkscape in the default location, the main "Program Files" folder (or "Program Files (x86)" on newer systems).
 
:* If you need additional assistance for installing Inkscape, you may be able to find good advice at the [http://wiki.inkscape.org/wiki/index.php/InstallHelp the Inkscape wiki] and/or the [http://www.inkscapeforum.com/ Inkscape Forums].  ''Please do not use Inkscape support resources for Eggbot-specific issues-- see note below about troubleshooting.''
 
  
 +
:* Install Inkscape in the default location, the main "Program Files" folder.
  
 
2. Download and run the EggBot installer for Windows
 
2. Download and run the EggBot installer for Windows
  
:* Download the [https://github.com/evil-mad/EggBot/releases/download/v2.5.0/EggBot_250A.exe latest version of the Windows installer] (This is a direct download link to the "exe" version of the installer).  Run the EggBot installer to install the Eggbot extensions, its USB driver, and (optionally) a set of example files.
+
:* Download the [https://github.com/evil-mad/EggBot/releases/download/untagged-3d6267776a29271a93f4/EggBot_281.exe latest version of the Windows installer] (This is a direct download link to the "exe" version of the installer).  Run the EggBot installer to install the EggBot extensions and  its USB driver.
 
:* The "Eggbot" submenu should appear in the Extensions menu of Inkscape after you restart Inkscape.
 
:* The "Eggbot" submenu should appear in the Extensions menu of Inkscape after you restart Inkscape.
  
 +
==== Troubleshooting ====
  
3. Troubleshooting
+
: Your software should now be set up to work correctly. 
 +
:* If you encounter difficulty installing Inkscape or the extensions (or with plotting, in the next stage), please request assistance through the EggBot mailing list or forum, which you can find on our [[Eggbot|front page]]. 
 +
:* If there is any chance that a problem you encounter is specific to EggBot software or hardware, please request support from us, rather than through Inkscape's support resources. You're much more likely to get your problem solved by asking people who know about Eggbot.  
  
: Your software should now be set up to work correctly. 
 
:* If, when trying to run USBDriverInstaller.exe, you get a "Application failed to initialize (0x0000135)" error, it means that your copy of Windows does not have the .Net libraries installed. This is straightforward to fix - go to [http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=17718] and run the installer from Microsoft, then run USBDriverInstaller again.
 
:* If you encounter difficulty installing the Eggbot extensions for Inkscape (or with plotting, in the next stage), please request assistance through the Eggbot mailing list or forum, which you can find on our [[Eggbot|front page]]. 
 
:* If there is any chance that a problem you encounter is specific to Eggbot software or hardware, it is important that you do not directly seek assistance through Inkscape's support resources. You're much more likely to get your problem solved by asking people who know about Eggbot. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.
 
  
 
== Linux ==
 
== Linux ==
  
The Eggbot extension for Inkscape has been developed and tested extensively under Ubuntu 10.04 - 12.04.  
+
The EggBot extension for Inkscape has been developed and tested extensively under Ubuntu.  
 
We expect it to work equally well in most Ubuntu derivatives and other distributions where Inkscape is known to work.  However, ''we do not have the capability to test every distribution''.  
 
We expect it to work equally well in most Ubuntu derivatives and other distributions where Inkscape is known to work.  However, ''we do not have the capability to test every distribution''.  
  
  
Ubuntu install instructions:
+
EggBot software installation instructions for Linux:
:* Use the Ubuntu Software Center to install Inkscape 0.91 or newer
+
:* Install Inkscape 0.92 on your computer. The best way to do this will vary by distribution, but in most cases you can use the software installer provided with the OS. See [http://wiki.inkscape.org/wiki/index.php/Installing_Inkscape#Installing_on_Linux here] for additional information.
:* Launch Inkscape from the Applications menu, and then quit it.
+
:* Launch Inkscape, and select Edit > Preferences from the menu, and then select the System entry. That should list the location of your '''User extensions''' directory.
:* Download the latest Inkscape extensions .ZIP file from the downloads section of the [https://github.com/evil-mad/EggBot/releases github site].
+
:* Download and unzip EggBot_extensions_v281.zip . Copy its contents into your Inkscape User extensions directory and relaunch Inkscape.
:* From the "Places" menu, open your Home Folder.
 
:* From the "View" menu select "Show hidden files" -- the .config folder should be visible.
 
:* Place the contents of the folder inside the ZIP archive inside  .config/inkscape/extensions/
 
:* Add your user account to the "dialout" group. (See below for details.)
 
:* Log out and log back in, for that group change to take effect.
 
:* The "Eggbot" submenu should appear in the Extensions menu of Inkscape when you start Inkscape.
 
  
 
+
Adding your user account to the "dialout" group:
About adding your user account to the "dialout" group:
+
: In recent Linux releases, it is also necessary to change your user permissions, to explicitly grant access to the USB port where the EggBot is located.  This can be done by adding your user group to the "dialout" user group on your system.   
: In recent Linux releases (e.g., Ubuntu 12 and newer), it is also necessary to change your user permissions, to explicitly grant access to the USB port where the Eggbot is located.  This can be done by adding your user group to the "dialout" user group on your system.   
 
  
 
:* Open up a terminal window
 
:* Open up a terminal window
Line 89: Line 68:
 
::* If you are unsure whether you are already in the "dialup" group, enter the command "groups" <return>, and the computer will list the groups that you are in.
 
::* If you are unsure whether you are already in the "dialup" group, enter the command "groups" <return>, and the computer will list the groups that you are in.
 
:* After changing groups, you need to log out and log back in for the change to take effect.
 
:* After changing groups, you need to log out and log back in for the change to take effect.
 +
 +
sudo usermod -a -G dialout <myUserName>"
  
  
sudo usermod -a -G dialout <myUserName>"
 
  
 
Debian Wheezy install instructions(command line):
 
Debian Wheezy install instructions(command line):
Line 100: Line 80:
 
  unzip the latest Inkscape extension .ZIP file into  
 
  unzip the latest Inkscape extension .ZIP file into  
 
  /home/'UserName'/.config/inkscape/extensions
 
  /home/'UserName'/.config/inkscape/extensions
Than you can use the Eggbot extension for Inkscape by type:
+
Than you can use the EggBot extension for Inkscape by type:
 
"inkscape"  <return>
 
"inkscape"  <return>
  
 
Troubleshooting
 
Troubleshooting
 
: If your permissions are not correct (your user is not in the dialout group), you may get consistent "Unable to find an Eggbot" type error messages.
 
: If your permissions are not correct (your user is not in the dialout group), you may get consistent "Unable to find an Eggbot" type error messages.
: If the Eggbot menu doesn't appear in Inkscape, verify that when you've extract the zip file, all the .py files are inside .config/inkscape/extensions/ folder (you might have extracted the entire eggbot folder, and .py files might be misplaced)
+
: If the EggBot menu doesn't appear in Inkscape, verify that when you've extract the zip file, all the .py files are inside .config/inkscape/extensions/ folder (you might have extracted the entire EggBot folder, and .py files might be misplaced)
  
=== Additional linux configurations ===
+
==== Additional linux configurations ====
  
If you use Eggbot under Linux, please feel free to add your known-working linux distribution and/or configuration to this non-exhaustive list:
+
If you use EggBot under Linux, please feel free to add your known-working linux distribution and/or configuration to this non-exhaustive list:
  
 
* Ubuntu 18.04 with Inkscape 0.92
 
* Ubuntu 18.04 with Inkscape 0.92

Revision as of 15:06, 21 June 2019

This wiki page is part of the documentation for The Original Egg-Bot.
Click here to return to the Egg-Bot overview.

Eggbot is designed to work well on Mac, Windows, and Linux computers. To use it, you'll need to install certain software on your computer.

The EggBot software actually consists of two main parts:

  1. Inkscape, the superb freeware vector graphics application (NOTE: Inkscape 0.92 is the recommended version at this time.)
  2. The EggBot extensions for Inkscape, which let you control the EggBot from within Inkscape

Optionally but suggested, you may also want to download the set of example files from the EggBot Releases page. The particulars of installation depend on the operating system; please see information for each type of computer below.


Mac

The instructions below are for MacOS 10.7 and newer.

1. Download and open the EggBot Mac bundle DMG

2. Run the XQuartz installer included in that DMG (disk image) file.

3. Drag the included copy of Inkscape to your "Applications" folder.

4. Eject the disk image (DMG).


Troubleshooting

Your software should now be set up to work correctly.
  • If copy and paste are not working correctly in Inkscape, open the XQuartz preferences dialog, and disable the "Update Pasteboard when CLIPBOARD changes" option.
  • If you encounter difficulty installing the Inkscape (or with plotting, in the next stage), please request assistance through the EggBot mailing list or forum, which you can find on our front page.
  • If there is any chance that a problem you encounter is specific to EggBot software or hardware, please request support from us, rather than through Inkscape's support resources. You're much more likely to get your problem solved by asking people who know about Eggbot.


Windows

1. Download and install Inkscape version 0.92.4 from the download page at Inkscape.org. (Most users will want the "Windows : 64-Bit : Msi" download.)

  • Install Inkscape in the default location, the main "Program Files" folder.

2. Download and run the EggBot installer for Windows

  • Download the latest version of the Windows installer (This is a direct download link to the "exe" version of the installer). Run the EggBot installer to install the EggBot extensions and its USB driver.
  • The "Eggbot" submenu should appear in the Extensions menu of Inkscape after you restart Inkscape.

Troubleshooting

Your software should now be set up to work correctly.
  • If you encounter difficulty installing Inkscape or the extensions (or with plotting, in the next stage), please request assistance through the EggBot mailing list or forum, which you can find on our front page.
  • If there is any chance that a problem you encounter is specific to EggBot software or hardware, please request support from us, rather than through Inkscape's support resources. You're much more likely to get your problem solved by asking people who know about Eggbot.


Linux

The EggBot extension for Inkscape has been developed and tested extensively under Ubuntu. We expect it to work equally well in most Ubuntu derivatives and other distributions where Inkscape is known to work. However, we do not have the capability to test every distribution.


EggBot software installation instructions for Linux:

  • Install Inkscape 0.92 on your computer. The best way to do this will vary by distribution, but in most cases you can use the software installer provided with the OS. See here for additional information.
  • Launch Inkscape, and select Edit > Preferences from the menu, and then select the System entry. That should list the location of your User extensions directory.
  • Download and unzip EggBot_extensions_v281.zip . Copy its contents into your Inkscape User extensions directory and relaunch Inkscape.

Adding your user account to the "dialout" group:

In recent Linux releases, it is also necessary to change your user permissions, to explicitly grant access to the USB port where the EggBot is located. This can be done by adding your user group to the "dialout" user group on your system.
  • Open up a terminal window
  • For most distributions (including Fedora and Ubuntu), enter the command "sudo usermod -a -G dialout <myUserName>" <return>, replacing the <myUserName> part with the user that is running Inkscape (and without the quotation marks or angle brackets!).
  • If you are unsure of your user name, enter the command "whoami" <return>, and the computer will happily remind you.
  • If you are unsure whether you are already in the "dialup" group, enter the command "groups" <return>, and the computer will list the groups that you are in.
  • After changing groups, you need to log out and log back in for the change to take effect.

sudo usermod -a -G dialout <myUserName>"


Debian Wheezy install instructions(command line):

  • Download the latest Inkscape extension .ZIP file from the downloads section of the EggBot Releases page.
  • Open up a terminal window, enter the command ,<return>, where you type your user name instead of UserName (And, no quotation marks.):
"sudo apt-get install inkscape"
"sudo apt-get install unzip python-lxml"
unzip the latest Inkscape extension .ZIP file into 
/home/'UserName'/.config/inkscape/extensions

Than you can use the EggBot extension for Inkscape by type: "inkscape" <return>

Troubleshooting

If your permissions are not correct (your user is not in the dialout group), you may get consistent "Unable to find an Eggbot" type error messages.
If the EggBot menu doesn't appear in Inkscape, verify that when you've extract the zip file, all the .py files are inside .config/inkscape/extensions/ folder (you might have extracted the entire EggBot folder, and .py files might be misplaced)

Additional linux configurations

If you use EggBot under Linux, please feel free to add your known-working linux distribution and/or configuration to this non-exhaustive list:

  • Ubuntu 18.04 with Inkscape 0.92
  • Ubuntu 14.04 with Inkscape 0.91
  • Ubuntu 12.04 with Inkscape 0.48.2 - 0.48.4
  • Fedora Core 18 with Inkscape 0.48.4
  • Debian 7 Wheezy with Inkscape 0.48.3.1
  • Antergos 18.3 with Inkscape 0.92.2 2405546