Silinx · User's guideTry Silinx

Every feature, in detail

User's guide · English

The reference: every feature of Silinx, with the menu that has it and the issue that made it. The user's guide shows them one subject at a time.

A reprogrammable-hardware design platform in the style of the Xilinx ISE 14.x Project Navigator, for Xilinx FPGAs supported by ISE 14.7.

On an iPad or a tablet

The site (and Silinx.html) runs in Safari on an iPad (WebKit) and in a tablet's browser: the HDL editors and the drawings, simulation, and the Silinx toolchain (synthesis, place and route, the .bit), and in Chrome on an Android tablet board programming too. What is different from a computer:

Guided labs

Project ▸ Guided Labs… opens a step-by-step tutorial on the project, beside its documents: each step says what to do, and Check Step checks it on the project (a file, a module's ports, Check Syntax with exactly the expected warnings, the simulation's values at given times, a drawing's check, a port's pin, a process run on the sources as they are), ticking it in the Steps panel, or giving its hint and the reasons in the console. Silinx ships "First steps" on the gates example, "A state machine" on traffic, "The clock and the board" on blinky and "The emulator" on stopwatch (in English and Portuguese); a teacher writes a lab as a labs/<name>.lab.json file of a project (New Source ▸ Guided Lab starts one from a template; its format: core/labs.js), checked as it is edited (each save, and its Check Syntax, say its problems), and shares it with the project. A link opens a lab beside the project (lab=<its id>, e.g. …/Silinx/#open=example:stopwatch&lab=stopwatch-emulator; the MCP's project_link adds it to a project's link). The progress is the project's (labs/progress.json): a lab resumes where it was left.

A link opens Silinx on a design, straight in Try it, the simulation or the board emulator, with no project to create or import: Share Project… (the project's right-click menu in the Design pane, the Start page, the ISE style's File menu) or Share Module… (a module's right-click menu) makes it, A copy chosen in its window, the view and the module chosen, the link made by Generate and hidden until Show (Copy copies it all the same, Show QR Code shows its QR code, as large as the window) (its other way, Live, shares the project as you work: your name on the window, Start Sharing, then two links in the same window, each made by its own Generate and hidden with its Copy, Show and Show QR Code: the viewers' (#view=…), who follow it read only, and what you do: your documents, views and selection, your simulations and Board Emulators (run again on their page from the same files, with your time, inputs and view), your runs and the reports you open; and the editors' (#edit=…), who edit it with you; the toolbar's Sharing menu shows either (Show Sharing Link…: the role chosen, its link with Copy, Show and Show QR Code), Add a User… gives the link of the role you choose, and it lists who is in, each a viewer or an editor with its Viewer | Editor switch, which makes a viewer an editor or an editor a viewer and renews the editors' link: the old one then only follows, the other editors keep editing; Renew Editor Link renews it too, for a link that reached people it should not: copies of the old one no longer edit, nor do editors who are not in the project now, while those in it keep editing; the Collaboration tab's Sharing box shows the same, who is in and those commands, Share Live… opens the window with Live chosen, and Share a Copy… with A copy chosen). A live share outlives a dropped connection: its owner's page reconnects on its own (Reconnecting… in the toolbar; the relay keeps the room for 2 minutes and the followers keep the project), and so does a follower of a room the owner's page hosts (#3835). The whole project goes inside the link (#design=…, compressed: 5 to 25 KB for the examples; anyone with the link has every file, its comments too), so nothing has to be hosted. Share Project… can make a short link instead (#gist=…, about 140 characters, for a chat that refuses a long message), made by Generate, the window saying which GitHub account is signed in and which repository the project is in (private or public): the project is encrypted in your browser and saved as a secret gist of your GitHub account (the browser edition's Sign in with GitHub…; a server's GH_TOKEN), and the key is in the link, so GitHub keeps only what it cannot read; opening it needs no sign-in, and your links are your gists, which you list and delete on GitHub. A short link may expire (Expires: a week, a month, six months or a year; never by default): opened after its date it is refused, and making a short link deletes your expired ones. File ▸ Short Links… lists your short links (when each was made, when it expires), copies again those this browser made, and deletes the ones you choose (the header's check box selects them all), or the expired ones. Some slide tools cut a link longer than about 2 000 characters: a larger project goes as a zip hosted elsewhere (Export Project (.zip)… to Silinx, then …/Silinx/#open=https://…/lecture3.zip&view=simulate), and an example by its name (…/Silinx/#open=example:gates&view=try; #open=example:traffic&top=traffic&view=try its state diagram). view= is try (the Try it of a schematic, a state diagram, a Petri net, an ASM chart or a circuit), simulate (the test bench) or emulate (the board emulator); top= names the module (with simulate, the test bench). Opening a link makes a project named after the design; clicked again, that project is opened as it is when it has the same files, and one the student changed is replaced only when they say so. A zip from another site is fetched only once you agree (its address shown), and only from an https address that is not of this computer or a local network, the zip's own (a redirection is not followed); a broken link is said in the console, the workspace as it was.

Share Project… includes Silinx as it is when the link is copied (Include the current view): the open tabs, the one in front, the split and, in the Silinx interface, the task, the side panel, the messages and a maximized document; the link opens it so, for that page only (the viewer's own layout is not changed).

Editing in VS Code

On your computer, with Silinx's server (silinx serve, the launchers), a project's text files open in VS Code: Open in VS Code in a source's right-click menu in the Design pane (an HDL module, a C / C++ source of Silinx HLS) and the Files page (constraints, any text file), and in its tab's menu, at the cursor's line; Open Folder in VS Code in the project's menu opens its folder. What is saved there shows in Silinx at once; a file with changes not saved in Silinx asks which version to keep. A drawing's HDL is not offered (the drawing makes it). Silinx runs the editor's command (code, found on PATH or where VS Code is installed), or opens its vscode:// link when there is none. Another editor of the family is chosen in ~/.silinx/config.json: "editor": "code-insiders" (VS Code Insiders), "codium" (VSCodium), "cursor" (Cursor), a program's absolute path (with VS Code's command line), or "off" (also SILINX_EDITOR=off). It is not in the browser edition, nor for a page on another computer than the server's: the editor would open on the server's screen.

Merging a group's work (Merge Contribution…)

When several people work on copies of one project (each at home, on a copy a teacher handed out), Project ▸ Merge Contribution… brings a copy back into the project: its folder, or the .zip File ▸ Export Project (.zip)… made of it. A copy given out remembers where it came from (the project and its version then), so the merge is three-way:

A copy made before Silinx recorded this is merged two-way: each file that differs is a choice. Undo Merge puts the project back as it was. A merge that takes someone else's files makes the project untrusted until you trust it, as an import does. For a group working at the same time, Share Project's live editing needs no merge.

A project on GitHub (git, a GitHub Classroom assignment)

On your computer or a Silinx server, a project can live in a GitHub repository, through the system's git. The Collaboration tab (the side panel's last, after Teaching, in both interfaces; shown beside Start with no project open, for the sign-in and Open from GitHub Repository…) gathers its commands in its Git Repository box: the project's GitHub repository and branch (the commits to push or to pull, the files in conflict), Commit…, Push, Pull, Changes… (how many files changed), History…, the sign-in and the last push's checks; for a project with no repository, Store Project in a GitHub Repository… and Open from GitHub Repository…; and its Sharing box: Share a Copy… (Share Project…'s copy), and live sharing (Share Live…, who is in, the links, Stop Sharing, Follow, Stop Following). The menus keep the same commands:

git signs in to GitHub with its own credentials (GitHub's command line gh auth login, Git Credential Manager or an SSH key): Silinx never asks for, stores or logs a password or a token. A server's operator can turn git off with SILINX_GIT=off.

In the browser edition the same commands go through GitHub's API (there is no git in a browser):

A computer or a server with no git can use GitHub's API the same way, for the interface and the MCP's git tools: start Silinx with SILINX_GIT=github and a token in GH_TOKEN (GH_TOKEN=$(gh auth token)), which Silinx never stores.

Privacy and usage counts

The site (https://pmnmalo.github.io/Silinx/ and its dev/ edition) counts its visits and what is used in it (a new project, a simulation, Implement Design, a bitstream, a board programmed) with GoatCounter: no cookies, no personal data, never the content of a project. The application and the downloaded Silinx.html send nothing. The counter is added by the site's build (scripts/site-analytics.mjs, when the repository variable GOATCOUNTER_CODE is set).

Using Silinx in a course, a school or on your own? Tell us on GitHub Discussions (Help ▸ Tell Us Who You Are…).