Difference between revisions of "Axidraw Software Installation"

From Evil Mad Scientist Wiki
Jump to: navigation, search
m (Reverted edits by 15.204.142.214 (talk) to last revision by Windell)
 
(125 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{AxiDrawDocs}}
 
{{AxiDrawDocs}}
−
'''This page of [[AxiDraw]] documentation is under construction -- check back soon.'''
 
  
−
AxiDraw is designed to work well on Mac, Windows, and Linux computers.   To use it, you'll need to install certain software on your computer.
+
AxiDraw is designed to work well on Mac, Windows, and Linux computers. To use it, you'll need to install certain software on your computer.  
 +
Please read below for specific instructions for [[#Mac|Mac]], [[#Windows|Windows]], and [[#Linux|Linux]]. 
  
 +
The current software version is v. 3.9.5, released in December 2023, and requires Inkscape 1.0 or newer. Inkscape 1.2 or newer is recommended. The AxiDraw software installers (and manual installation bundles) include the AxiDraw, EggBot, and WaterColorBot software for Inkscape.
  
 
== Mac ==
 
== Mac ==
  
 +
=== For recent macOS, 10.15, up through macOS 13 Ventura ===
  
−
=== Easy install (Most users) ===
+
Our primary release of the AxiDraw software is available for Inkscape 1.3, and works under macOS 10.15 through macOS 13 Ventura, and both
 +
Intel and Apple Silicon architectures.
  
−
:Download the all-in-one software bundle: [http://evilmadscience.s3.amazonaws.com/wiki/axidraw/software/AxiDraw%20Mac%20Bundle.dmg Download link] (138 MB)
+
:1. Download and run [https://cdn.evilmadscientist.com/dl/ad/public/395/AxiDraw_395_Mac.app.zip the AxiDraw installer] (32 MB).
−
::* This bundle includes Inkscape, XQuartz, and the AxiDraw driver.
 
−
::* When your download finishes, you will have a file called "AxiDraw Software.dmg".  Double click that file and agree to the license.
 
−
::* Run the XQuartz installer, and drag Inkscape to your Applications folder. Eject the installer disk image (DMG) file.
 
  
−
:When you open up Inkscape, you may be met by a message saying that "Inkscape.app" can’t be opened because it is from an unidentified developer. If so, right-click (or hold down the "control" key on your keyboard while you click) on the Inkscape Icon, and select "open" from the menu. You will only have to do this once.
+
:2. Download and install [https://inkscape.org/release/1.3.2/mac-os-x/ Inkscape for Mac]. (Versions for Intel and Apple Silicon processors are available. If you have an older computer and aren't sure which you have, pick Intel.)
  
  
−
=== Alternate install (If you already use Inkscape) ===
+
=== For older macOS, 10.13 - 10.14  ===
  
−
:If you already have XQuartz and Inkscape installed on your computer, you can also install the AxiDraw extensions alone: [http://evilmadscience.s3.amazonaws.com/wiki/axidraw/software/AxiDraw_V1.0.0.dmg Download link] (1 MB)
+
Download and run the same AxiDraw software installer as above, but install [https://inkscape.org/release/1.2.2/mac-os-x/ Inkscape 1.2 for Mac].
−
::* When your download finishes, open the resulting DMG file, and run the installer. This installer requires Inkscape 0.91, installed in your main applications folder.
 
−
::* The "AxiDraw" submenu should appear in the Extensions menu of Inkscape after you restart Inkscape.
 
  
  
−
=== For Older MacOS versions (older than 10.7) ===
+
=== For older macOS, 10.11 - 10.12 ===
  
−
: The instructions above are for MacOS 10.7 and newer. Please [http://shop.evilmadscientist.com/contact contact technical support] if you need to install AxiDraw software on an older Mac.
+
Download and run the same AxiDraw software installer as above, but install [https://inkscape.org/release/inkscape-1.1.2/mac-os-x/dmg/ Inkscape 1.1 for Mac].
 +
 
 +
 
 +
=== Legacy install for older macOS 10.7 - 10.10 ===
 +
 
 +
An older release of the software is based on Inkscape 0.92, and works under macOS 10.7-10.10.
 +
 
 +
:1. Download and open the [https://github.com/evil-mad/axidraw/releases/download/v2.5.6/AxiDraw_v256_r1_Mac.dmg AxiDraw 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).
 +
 
 +
 
 +
 
 +
=== Alternative (Manual) install for Mac ===
 +
 
 +
:If you already have Inkscape 1.0 or newer installed on your computer, you can also manually install the AxiDraw extensions.
 +
 
 +
::1. Download the software in [https://cdn.evilmadscientist.com/dl/ad/public/395/AxiDraw_395_Mac.zip this ZIP archive] (31 MB), and unzip it. (Your computer may unzip the archive automatically for you.)
 +
::2. Locate and open your Inkscape user extensions directory. You can find this location as follows:
 +
:::A. Open Inkscape
 +
:::B. From the menu, select '''Inkscape > Preferences'''
 +
:::C. Select '''System''' from the list on the left panel of the preferences window.
 +
:::D. On the right-hand panel is a list of directory locations. Click the "Open" button to the right of the "User extensions" folder location.
 +
::3. Copy the contents of the ZIP archive that you downloaded (35 items total; 32 files and 3 subfolders) into your Inkscape extensions directory, overwriting any files and directories with the same names.
 +
::4. Launch Inkscape, or quit and re-launch it if it is open.
  
  
 
=== Troubleshooting ===
 
=== Troubleshooting ===
  
−
: Your software should now be set up to work correctly. 
+
:* If you are using macOS Ventura and have trouble connecting, [https://support.apple.com/guide/mac-help/allow-accessories-to-connect-mchlf779ae93/mac check to see if your computer has blocked access] to USB accessories.
−
:* Because Inkscape runs on X11's architecture, keyboard shortcuts use control (^) instead of Cmd (⌘) as modifier key.
+
:* If you encounter difficulty installing or using the software, please request assistance through [https://shop.evilmadscientist.com/contact our contact form] or through our [https://axidraw.com/chat Discord chat].
−
:* 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 AxiDraw extensions for Inkscape (or with plotting, in the next stage), please request assistance through the AxiDraw forum, which you can find on our [[AxiDraw|front page]]. 
 
−
:* For older Macs (MacOS 10.4 - 10.6), please contact Evil Mad Scientist for tech support. You will need older versions of Inkscape and XQuartz.
 
 
:* If there is any chance that a problem you encounter is specific to AxiDraw 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 AxiDraw. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.
 
:* If there is any chance that a problem you encounter is specific to AxiDraw 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 AxiDraw. 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 the latest version of Inkscape (Version 0.91 or newer) from [http://inkscape.org/en/download/ the download page] at Inkscape.org.  
+
=== Installation ===
−
:* 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 AxiDraw-specific issues-- see note below about troubleshooting.''
+
:1. Download and run the AxiDraw software installer for Windows: [https://cdn.evilmadscientist.com/dl/ad/public/395/AxiDraw_395_Win.exe.zip Download link] (24 MB ZIP archive)
 +
::* The installer is an executable, named "AxiDraw Install.exe"; Unzip, open, and run it.
 +
 
 +
:2. Download and install Inkscape from [https://inkscape.org/release/1.3/windows/ the download page] at Inkscape.org. (Most users will want the 64-bit version and the "MSI" installer.)
 +
::* 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 [https://inkscape.org/forums/ Inkscape Forums].  ''Please do not use Inkscape support resources for AxiDraw-specific issues-- see note below about troubleshooting.''
 +
 
  
  
−
2. Download and run the AxiDraw installer for Windows: [http://evilmadscience.s3.amazonaws.com/wiki/axidraw/software/AxiDraw_100A.zip Download link] (0.5 MB)
+
=== Alternative (Manual) install for Windows ===
−
:* The installer is an executable, named "AxiDraw_100A.exe".
 
−
:* After running the installer, launch (or restart) Inkscape. The "AxiDraw" submenu should appear in the Extensions menu.
 
  
 +
:If you already have Inkscape 1.0 or newer installed on your computer, you also manually install the AxiDraw extensions. For Windows 8 and older versions, please use the installer above for the first time that you install AxiDraw software, as the installer also includes a necessary USB driver. (You can use the manual method for subsequent installs and upgrades, and for Windows 10, which does not require the USB driver.)
  
−
3. Troubleshooting
+
::1. Download the software in [https://cdn.evilmadscientist.com/dl/ad/public/395/AxiDraw_395_Win.zip this ZIP archive] (27 MB), and unzip it. (Your computer may unzip the archive automatically for you.)
 +
::2. Locate and open your Inkscape user extensions directory. You can find this location as follows:
 +
:::A. Open Inkscape
 +
:::B. From the menu, select '''Edit > Preferences'''
 +
:::C. Select '''System''' from the list on the left panel of the preferences window.
 +
:::D. On the right-hand panel is a list of directory locations. Click the "Open" button to the right of the "User extensions" folder location.
 +
::3. Copy the contents of the ZIP archive (approximately 35 items including 3 subdirectories) into your Inkscape User extensions directory. Make sure that you copy all of these files, not just some of the files, and not just a folder containing these files.
 +
::4. Launch Inkscape, or quit and re-launch it if it is open.
 +
 
 +
 
 +
=== Troubleshooting ===
  
 
: Your software should now be set up to work correctly.   
 
: Your software should now be set up to work correctly.   
−
:* If 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 or using the software, please request assistance through [https://shop.evilmadscientist.com/contact our contact form] or through our [https://axidraw.com/chat Discord chat].
−
:* If you encounter difficulty installing the AxiDraw extensions for Inkscape (or with plotting, in the next stage), please request assistance through the AxiDraw mailing list or forum, which you can find on our [[AxiDraw|front page]].
 
 
:* If there is any chance that a problem you encounter is specific to AxiDraw 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 AxiDraw. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.
 
:* If there is any chance that a problem you encounter is specific to AxiDraw 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 AxiDraw. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.
 +
  
 
== Linux ==
 
== Linux ==
  
−
The AxiDraw extension for Inkscape has been developed and tested extensively under Ubuntu 10.04 - 12.04.
+
The AxiDraw extensions for Inkscape have been developed and tested extensively under Ubuntu. We expect them 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''. If you are unsure if your distribution will work, try to install Inkscape, and see if it appears to launch and run correctly. (We do also have python-based [https://axidraw.com/doc/cli_api/ command-line tools] available to run the AxiDraw, even on systems where Inkscape is not supported.)  We are currently producing separate builds for linux on x86 and ARM (e.g., Linux on Apple Silicon).
−
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''.  
 
  
 +
===Working with Inkscape===
 +
:* Install Inkscape 1.0 or newer on your computer. Where possible, we recommend to install via the appimage version [https://inkscape.org/release/1.3/gnulinux/ available here]. For some Linux  distributions, installing Inkscape may require looking up distribution-specific information.  See [http://wiki.inkscape.org/wiki/index.php/Installing_Inkscape#Installing_on_Linux 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.
 +
:* For x86, download the software in [https://cdn.evilmadscientist.com/dl/ad/public/395/AxiDraw_395_LinX86.zip this ZIP archive] (39 MB).
 +
:* For ARM, download the software in [https://cdn.evilmadscientist.com/dl/ad/public/395/AxiDraw_395_LinARM.zip this ZIP archive] (41 MB).
 +
:* Unzip the archive and copy its contents (approximately 35 items including 3 subdirectories) into your Inkscape User extensions directory and ''relaunch'' Inkscape. Make sure that you copy all of these items, not just some of them, and not just a folder containing these files.
  
−
Ubuntu install instructions:
 
−
:* Use the Ubuntu Software Center to install Inkscape 0.91 or newer
 
−
:* Launch Inkscape from the Applications menu, and then quit it.
 
−
:* Download the latest Inkscape extensions .ZIP file from the downloads section of the [https://github.com/evil-mad/AxiDraw/releases github site].
 
−
:* 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 "AxiDraw" submenu should appear in the Extensions menu of Inkscape when you start Inkscape.
 
  
 +
===About adding your user account to the "dialout" group===
 +
: In modern Linux releases, it is often necessary to change your user permissions, to explicitly grant access to the USB port where the AxiDraw is located.  This can be done by adding your user group to the "dialout" user group on your system. 
  
−
About adding your user account to the "dialout" group:
+
:* Open up a terminal window
−
: 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 AxiDraw is located. This can be done by adding your user group to the "dialout" user group on your system.   
+
:* For most distributions (including Fedora and Ubuntu), enter the command <code>sudo usermod -a -G dialout <myUserName></code> <return>,  replacing the <myUserName> part with the user that is running Inkscape (and without the angle brackets!).
 +
::* If you are unsure of your user name, enter the command "whoami" <return>, and the computer will remind you. 
 +
::* If you are unsure whether you are already in the "dialout" group, enter the command <code>groups</code> <return>, and the computer will list the groups that you are in.
 +
:* After changing groups, you need to fully log out and log back in for the change to take effect.
 +
 
 +
 
 +
===Troubleshooting===
 +
: If your permissions are not correct (your user is not in the dialout group), you may get consistent "Unable to connect to AxiDraw" type error messages.
 +
: Some linux distributions use a ''different'' group name than dialout, which could possibly be one of the following: "[https://wiki.archlinux.org/title/Users_and_groups#User_groups uucp]", "serial", "tty", "plugdev", or something else entirely. If dialout doesn't seem to be working, try <code>ls -l /dev/ttyACM*</code>. The result will usually look something like "crw-rw---- 1 root dialout [...]". If something other than "dialout" is listed there, that is the name of the [https://wiki.archlinux.org/title/Users_and_groups#Group_management group] that has permission ownership of the serial ports.
 +
: If nothing appears under <code>ls -l /dev/ttyACM*</code>, then one of the following is likely the case:
 +
::* The USB cable is not connected
 +
::* The USB cable or adapter is not functional, or does not have the right internal wiring.
 +
::* Your linux kernel was compiled without the necessary support for USB devices, typically "CDC ACM", which is disabled by default on some distributions.
 +
: If you encounter difficulty installing or using the software, please request assistance through [https://shop.evilmadscientist.com/contact our contact form] or through our [https://axidraw.com/chat Discord chat].
 +
 
 +
== Firmware Update ==
  
−
:* Open up a terminal window
+
We encourage all AxiDraw users to update the latest firmware version, if you are not already using it. Once your AxiDraw software is up and running, you can check which version of the firmware you have by selecting the "Config" tab of AxiDraw Control and clicking Apply.
−
:* 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. 
+
EBB Firmware versions 2.4.6 and newer contain performance improvements and bug fixes that can prevent certain types of errors.
−
::* 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.
 
  
 +
To update your firmware, please follow the directions [[Updating_EBB_firmware|here]].
  
−
sudo usermod -a -G dialout <myUserName>"
 
  
−
Debian Wheezy install instructions(command line):
+
== AxiDraw APIs ==
−
:* Download the latest Inkscape extension .ZIP file from the downloads section of the [https://github.com/evil-mad/AxiDraw/releases/latest AxiDraw 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 AxiDraw extension for Inkscape by type:
 
−
"inkscape"  <return>
 
  
−
Troubleshooting
+
In addition to the Inkscape-based software discussed on this page, the AxiDraw software is also available in a full featured [https://axidraw.com/doc/cli_api/ CLI version]  (command-line interface) and [https://axidraw.com/doc/py_api/ Python library], both of which are suitable for use when you don't need a graphical interface, or for working with scripting and automation.
−
: If your permissions are not correct (your user is not in the dialout group), you may get consistent "Unable to find an AxiDraw" type error messages.
 
−
: If the AxiDraw 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 AxiDraw folder, and .py files might be misplaced)
 

Latest revision as of 15:41, 29 February 2024

  This wiki page is part of our AxiDraw documentation

Please click here to return to the AxiDraw overview.

AxiDraw is designed to work well on Mac, Windows, and Linux computers. To use it, you'll need to install certain software on your computer. Please read below for specific instructions for Mac, Windows, and Linux.

The current software version is v. 3.9.5, released in December 2023, and requires Inkscape 1.0 or newer. Inkscape 1.2 or newer is recommended. The AxiDraw software installers (and manual installation bundles) include the AxiDraw, EggBot, and WaterColorBot software for Inkscape.

Mac[edit]

For recent macOS, 10.15, up through macOS 13 Ventura[edit]

Our primary release of the AxiDraw software is available for Inkscape 1.3, and works under macOS 10.15 through macOS 13 Ventura, and both Intel and Apple Silicon architectures.

1. Download and run the AxiDraw installer (32 MB).
2. Download and install Inkscape for Mac. (Versions for Intel and Apple Silicon processors are available. If you have an older computer and aren't sure which you have, pick Intel.)


For older macOS, 10.13 - 10.14[edit]

Download and run the same AxiDraw software installer as above, but install Inkscape 1.2 for Mac.


For older macOS, 10.11 - 10.12[edit]

Download and run the same AxiDraw software installer as above, but install Inkscape 1.1 for Mac.


Legacy install for older macOS 10.7 - 10.10[edit]

An older release of the software is based on Inkscape 0.92, and works under macOS 10.7-10.10.

1. Download and open the AxiDraw 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).


Alternative (Manual) install for Mac[edit]

If you already have Inkscape 1.0 or newer installed on your computer, you can also manually install the AxiDraw extensions.
1. Download the software in this ZIP archive (31 MB), and unzip it. (Your computer may unzip the archive automatically for you.)
2. Locate and open your Inkscape user extensions directory. You can find this location as follows:
A. Open Inkscape
B. From the menu, select Inkscape > Preferences
C. Select System from the list on the left panel of the preferences window.
D. On the right-hand panel is a list of directory locations. Click the "Open" button to the right of the "User extensions" folder location.
3. Copy the contents of the ZIP archive that you downloaded (35 items total; 32 files and 3 subfolders) into your Inkscape extensions directory, overwriting any files and directories with the same names.
4. Launch Inkscape, or quit and re-launch it if it is open.


Troubleshooting[edit]

  • If you are using macOS Ventura and have trouble connecting, check to see if your computer has blocked access to USB accessories.
  • If you encounter difficulty installing or using the software, please request assistance through our contact form or through our Discord chat.
  • If there is any chance that a problem you encounter is specific to AxiDraw 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 AxiDraw. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.


Windows[edit]

Installation[edit]

1. Download and run the AxiDraw software installer for Windows: Download link (24 MB ZIP archive)
  • The installer is an executable, named "AxiDraw Install.exe"; Unzip, open, and run it.
2. Download and install Inkscape from the download page at Inkscape.org. (Most users will want the 64-bit version and the "MSI" installer.)
  • If you need additional assistance for installing Inkscape, you may be able to find good advice at the the Inkscape wiki and/or the Inkscape Forums. Please do not use Inkscape support resources for AxiDraw-specific issues-- see note below about troubleshooting.


Alternative (Manual) install for Windows[edit]

If you already have Inkscape 1.0 or newer installed on your computer, you also manually install the AxiDraw extensions. For Windows 8 and older versions, please use the installer above for the first time that you install AxiDraw software, as the installer also includes a necessary USB driver. (You can use the manual method for subsequent installs and upgrades, and for Windows 10, which does not require the USB driver.)
1. Download the software in this ZIP archive (27 MB), and unzip it. (Your computer may unzip the archive automatically for you.)
2. Locate and open your Inkscape user extensions directory. You can find this location as follows:
A. Open Inkscape
B. From the menu, select Edit > Preferences
C. Select System from the list on the left panel of the preferences window.
D. On the right-hand panel is a list of directory locations. Click the "Open" button to the right of the "User extensions" folder location.
3. Copy the contents of the ZIP archive (approximately 35 items including 3 subdirectories) into your Inkscape User extensions directory. Make sure that you copy all of these files, not just some of the files, and not just a folder containing these files.
4. Launch Inkscape, or quit and re-launch it if it is open.


Troubleshooting[edit]

Your software should now be set up to work correctly.
  • If you encounter difficulty installing or using the software, please request assistance through our contact form or through our Discord chat.
  • If there is any chance that a problem you encounter is specific to AxiDraw 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 AxiDraw. And, we'd like the Inkscape team to be ready to help us when we do encounter Inkscape-specific issues.


Linux[edit]

The AxiDraw extensions for Inkscape have been developed and tested extensively under Ubuntu. We expect them 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. If you are unsure if your distribution will work, try to install Inkscape, and see if it appears to launch and run correctly. (We do also have python-based command-line tools available to run the AxiDraw, even on systems where Inkscape is not supported.) We are currently producing separate builds for linux on x86 and ARM (e.g., Linux on Apple Silicon).

Working with Inkscape[edit]

  • Install Inkscape 1.0 or newer on your computer. Where possible, we recommend to install via the appimage version available here. For some Linux distributions, installing Inkscape may require looking up distribution-specific information. 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.
  • For x86, download the software in this ZIP archive (39 MB).
  • For ARM, download the software in this ZIP archive (41 MB).
  • Unzip the archive and copy its contents (approximately 35 items including 3 subdirectories) into your Inkscape User extensions directory and relaunch Inkscape. Make sure that you copy all of these items, not just some of them, and not just a folder containing these files.


About adding your user account to the "dialout" group[edit]

In modern Linux releases, it is often necessary to change your user permissions, to explicitly grant access to the USB port where the AxiDraw 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 angle brackets!).
  • If you are unsure of your user name, enter the command "whoami" <return>, and the computer will remind you.
  • If you are unsure whether you are already in the "dialout" group, enter the command groups <return>, and the computer will list the groups that you are in.
  • After changing groups, you need to fully log out and log back in for the change to take effect.


Troubleshooting[edit]

If your permissions are not correct (your user is not in the dialout group), you may get consistent "Unable to connect to AxiDraw" type error messages.
Some linux distributions use a different group name than dialout, which could possibly be one of the following: "uucp", "serial", "tty", "plugdev", or something else entirely. If dialout doesn't seem to be working, try ls -l /dev/ttyACM*. The result will usually look something like "crw-rw---- 1 root dialout [...]". If something other than "dialout" is listed there, that is the name of the group that has permission ownership of the serial ports.
If nothing appears under ls -l /dev/ttyACM*, then one of the following is likely the case:
  • The USB cable is not connected
  • The USB cable or adapter is not functional, or does not have the right internal wiring.
  • Your linux kernel was compiled without the necessary support for USB devices, typically "CDC ACM", which is disabled by default on some distributions.
If you encounter difficulty installing or using the software, please request assistance through our contact form or through our Discord chat.

Firmware Update[edit]

We encourage all AxiDraw users to update the latest firmware version, if you are not already using it. Once your AxiDraw software is up and running, you can check which version of the firmware you have by selecting the "Config" tab of AxiDraw Control and clicking Apply.

EBB Firmware versions 2.4.6 and newer contain performance improvements and bug fixes that can prevent certain types of errors.

To update your firmware, please follow the directions here.


AxiDraw APIs[edit]

In addition to the Inkscape-based software discussed on this page, the AxiDraw software is also available in a full featured CLI version (command-line interface) and Python library, both of which are suitable for use when you don't need a graphical interface, or for working with scripting and automation.

Retrieved from "https://wiki.evilmadscientist.com/index.php?title=Axidraw_Software_Installation&oldid=4117"