Editing Axidraw Software Installation
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 2: | Line 2: | ||
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]]. | + | Please read below for specific instructions for [[#Mac|Mac]], [[#Windows|Windows]], and [[#Linux|Linux]]. |
| − | The current software version is v. 3. | + | The current software version is v. 3.3.0, dated June 2022, and requires Inkscape 1.0 or newer. Inkscape 1.2 is recommended. |
== Mac == | == Mac == | ||
| − | === For recent macOS, 10.15, | + | === For recent macOS, 10.11 - 10.15 Catalina, and macOS 12 Monterey === |
| − | Our primary release of the AxiDraw software is available for Inkscape 1. | + | Our primary release of the AxiDraw software is available for Inkscape 1.2, and works under macOS 10.11 through macOS 12 Monterey, and both |
Intel and Apple Silicon architectures. | Intel and Apple Silicon architectures. | ||
| − | :1. Download and run [https://cdn.evilmadscientist.com/dl/ad/public/ | + | :1. Download and run [https://cdn.evilmadscientist.com/dl/ad/public/AxiDraw_Install_Mac_330.zip the AxiDraw installer] (10 MB). |
| − | :2. Download and install [https://inkscape.org/release/1 | + | :2. Download and install [https://inkscape.org/release/1.2/mac-os-x/ Inkscape 1.2 for Mac]. (Versions for Intel and Apple Silicon processors are available. If you aren't sure which you have, pick Intel.) |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Legacy install for older macOS 10.7 - 10.10 === | === Legacy install for older macOS 10.7 - 10.10 === | ||
| − | + | A previous release of our AxiDraw 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] | :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] | ||
| Line 46: | Line 36: | ||
:If you already have Inkscape 1.0 or newer installed on your computer, you can also manually install the AxiDraw extensions. | :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/ | + | ::1. Download the software in [https://cdn.evilmadscientist.com/dl/ad/public/ad-ink_330_r0.zip this ZIP archive] (8 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: | ::2. Locate and open your Inkscape user extensions directory. You can find this location as follows: | ||
:::A. Open Inkscape | :::A. Open Inkscape | ||
| Line 52: | Line 42: | ||
:::C. Select '''System''' from the list on the left panel of the preferences window. | :::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. | :::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 ( | + | ::3. Copy the contents of the ZIP archive that you downloaded (33 items total; 31 files and 2 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. | ::4. Launch Inkscape, or quit and re-launch it if it is open. | ||
| Line 58: | Line 48: | ||
=== Troubleshooting === | === Troubleshooting === | ||
| − | + | :* 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://discord.gg/axhTzmr Discord chat]. | |
| − | :* 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:// | ||
:* 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. | ||
| Line 67: | Line 56: | ||
=== Installation === | === Installation === | ||
| − | :1. Download and run the AxiDraw software installer for Windows: [https://cdn.evilmadscientist.com/dl/ad/public/ | + | :1. Download and run the AxiDraw software installer for Windows: [https://cdn.evilmadscientist.com/dl/ad/public/AxiDraw_330_Win.zip Download link] (6.5 MB) |
| − | ::* The installer is an executable, named " | + | ::* The installer is an executable, named "AxiDraw_330.exe"; open and run it. |
| − | :2. Download and install Inkscape from [https://inkscape.org/release/1. | + | :2. Download and install Inkscape '''version 1.2''' from [https://inkscape.org/release/1.2/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.'' | ::* 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.'' | ||
| Line 79: | Line 68: | ||
: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.) | :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 [https://cdn.evilmadscientist.com/dl/ad/public/ | + | ::1. Download the software in [https://cdn.evilmadscientist.com/dl/ad/public/ad-ink_330_r0.zip this ZIP archive] (8 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: | ::2. Locate and open your Inkscape user extensions directory. You can find this location as follows: | ||
:::A. Open Inkscape | :::A. Open Inkscape | ||
| Line 85: | Line 74: | ||
:::C. Select '''System''' from the list on the left panel of the preferences window. | :::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. | :::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 | + | ::3. Copy the contents of the ZIP archive (approximately 33 items including 2 subdirectories) into your Inkscape User extensions directory and ''relaunch'' Inkscape. 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. | ::4. Launch Inkscape, or quit and re-launch it if it is open. | ||
| Line 92: | Line 81: | ||
: Your software should now be set up to work correctly. | : Your software should now be set up to work correctly. | ||
| − | :* 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:// | + | :* 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://discord.gg/axhTzmr 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. | :* 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. | ||
| Line 98: | Line 87: | ||
== Linux == | == Linux == | ||
| − | 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.) | + | 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.) |
| − | + | '''Working with Inkscape 1.2:''' | |
| − | :* Install Inkscape 1. | + | :* Install Inkscape 1.2 on your computer. Where possible, we recommend to install via the [https://inkscape.org/release/inkscape-1.2/gnulinux/appimage/dl/ appimage version]. 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. | :* 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 the software in [https://cdn.evilmadscientist.com/dl/ad/public/ad-ink_330_r0.zip this ZIP archive]. Copy its contents (approximately 33 items including 2 subdirectories) into your Inkscape User extensions directory and ''relaunch'' Inkscape. Make sure that you copy all of these files, not just some of the files, and not just a folder containing these files. |
| − | |||
| − | |||
| − | + | 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. | : 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. | ||
| Line 115: | Line 102: | ||
::* If you are unsure of your user name, enter the command "whoami" <return>, and the computer will remind you. | ::* 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. | ::* 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 | + | :* After changing groups, you need to 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. | : 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: " | + | : 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 <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 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: | : 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 is not connected | ||
::* The USB cable or adapter is not functional, or does not have the right internal wiring. | ::* 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. | ::* 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:// | + | : 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://discord.gg/axhTzmr Discord chat]. |
== Firmware Update == | == Firmware Update == | ||
| Line 134: | Line 121: | ||
To update your firmware, please follow the directions [[Updating_EBB_firmware|here]]. | To update your firmware, please follow the directions [[Updating_EBB_firmware|here]]. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
