Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
blocks:drivers:tools [2019-06-05 14:51] admin Change to proper root name |
blocks:drivers:tools [2024-03-14 13:04] (current) mattias [Install the Scripts] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Development Tools and Code ====== | ====== Development Tools and Code ====== | ||
+ | This describes the recommended toolset for development. Other editors and IDEs may work as well (including [[blocks: | ||
- | This describes the recommended toolset for development. Other editors and IDEs may work as well, but this is probably the easiest way to get up and running. | + | :!: **NOTE**: The instructions below assume you have a working internet connection. |
- | * Install the [[https://atom.io|Atom]] editor. | + | ==== Install Visual Studio Code ==== |
- | | + | |
- | * Install | + | Install the [[https://code.visualstudio.com/ |
- | * Clone the [[https:// | + | |
- | * Alternatively, | + | ==== Install |
- | + | ||
- | :!: If you already have some of the files or directories included | + | Those programs are required for many script-related operations as well as in some cases to install typescript. |
+ | |||
+ | Follow | ||
+ | |||
+ | < | ||
+ | su pixi-admin | ||
+ | sudo apt install nodejs npm | ||
+ | exit | ||
+ | </ | ||
+ | |||
+ | ==== Install Typescript ==== | ||
+ | |||
+ | In a terminal window with administration privileges, now install | ||
+ | |||
+ | < | ||
+ | sudo npm install | ||
+ | </ | ||
+ | |||
+ | :!: If you're using our Linux based server, logged in as the pixi-server user (indicated in the terminal window) you must first switch to the pixi-admin user before you can run the command above. Switch to that user in a terminal window using the following command. | ||
+ | |||
+ | < | ||
+ | su pixi-admin | ||
+ | </ | ||
+ | |||
+ | Enter the password for the pixi-admin user. Then install typescript as described above. Finally, type exit to return to the pixi-server user (or just close the terminal window) | ||
+ | |||
+ | ==== Install the Scripts ==== | ||
+ | |||
+ | Download | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Decompress | ||
+ | :!: Please make a security copy of the script directory before installing | ||
+ | Normally any files in there should be overwritten by the new updated | ||
Once this is done, your PIXILAB-Blocks-root/ | Once this is done, your PIXILAB-Blocks-root/ | ||
Line 22: | Line 57: | ||
</ | </ | ||
- | The first three items shown above are directories, | + | The first three items shown above are directories, |
+ | |||
+ | :!: Please note that files made available to Blocks, which means files copied from the archive i.e drivers-archive to drivers is not updated automatically, | ||
+ | |||
+ | ==== Running VSCode for the First Time ==== | ||
+ | |||
+ | * Start Visual Studio Code. | ||
+ | * Open the PIXILAB-Blocks-root/ | ||
+ | * Open a new terminal in Visual Studio Code using Terminal > New Terminal. | ||
+ | * Install driver development dependencies by typing //npm install// in the terminal, followed by Enter. | ||
+ | * Select Terminal > Run Build Task > //tsc: watch// to automatically compile TypeScript files as they are saved. | ||
+ | |||
+ | **IMPORTANT: | ||
+ | |||
+ | Under Windows, an error message similar to //" | ||
Once you have those pieces in place, restart your local Blocks server and open the Blocks Editor using your web browser. You should now find the drivers on the Driver menu of a TCP Device added on the Manage page. If you don't see the drivers listed there, they' | Once you have those pieces in place, restart your local Blocks server and open the Blocks Editor using your web browser. You should now find the drivers on the Driver menu of a TCP Device added on the Manage page. If you don't see the drivers listed there, they' | ||
Proceed with learning about [[blocks: | Proceed with learning about [[blocks: |