circuitscript 0.0.12 → 0.0.14

package/build/src/sizing.js

@@ -1,11 +1,9 @@
 import { SVG, registerWindow } from '@svgdotjs/svg.js';
 import { config, createSVGWindow } from 'svgdom';
 import { HorizontalAlign, VerticalAlign } from './geometry.js';
+import { defaultFont } from './globals.js';
 let MainCanvas = null;
-const supportedFonts = {
-    'Inter': 'Inter-Regular.ttf',
-    'Inter-Bold': 'Inter-Bold.ttf',
-};
+const supportedFonts = {};
 export async function prepareSizing(fontsPath) {
     await config.setFontDir(fontsPath)
         .setFontFamilyMappings(supportedFonts)
@@ -39,17 +37,13 @@ export function measureTextSize2(text, fontFamily, fontSize, fontWeight = 'regul
                 dominantBaseline = 'text-top';
                 break;
         }
-        if (fontWeight === 'bold') {
-            fontFamily = 'Inter-Bold';
-        }
-        else {
-            fontFamily = 'Inter-Regular';
-        }
+        fontFamily = defaultFont;
         const tmpTextElement = MainCanvas.text(text).font({
             family: fontFamily,
             size: fontSize,
             anchor: anchor,
             'dominant-baseline': dominantBaseline,
+            weight: fontWeight,
         }).fill('#333');
         const textbox = tmpTextElement.bbox();
         const { width, height } = textbox;

package/examples/example_arduino_uno.cst

@@ -42,6 +42,10 @@ def solder_bridge():
     return create component:
         pins: 2
 
+gnd = dgnd()
+v3v3 = supply("3V3")
+v5v = supply("5V")
+
 atmega = create component:
     pins:
         1: "XTAL1"
@@ -189,7 +193,7 @@ at atmega:
         wire left 40 
         branch:
             wire up 20
-            to net("5V")
+            to v5v
         wire down 20
         branch:
             wire auto 
@@ -223,7 +227,7 @@ at atmega:
             to icsp_conn2 pin 5
 
         branch:
-            at net("5V")
+            at v5v
             wire down 20 left 20
             to icsp_conn2 pin 2
             point tmp4
@@ -393,19 +397,19 @@ at atmega:
         wire right 40
         add label("RXLED")
         wire right 100 down 100 right 60
-        add led("yellow") pin 1 ..angle=180
+        add led("yellow") pin 2 right
         wire right 20
         add res(1k)
         wire right 20 up 80 
         point tmp6
         wire up 20 
-        to net("5V")
+        to v5v
 
     11:
         wire right 40
         add label("TXLED")
         wire right 120 down 40 right 40
-        add led("yellow") pin 1 ..angle=180
+        add led("yellow") pin 2 right
         wire right 20
         add res(1k)
         wire auto 
@@ -419,11 +423,11 @@ power_conn2 = create component:
 
 at power_conn2:
     2:
-        wire left 40
-        add label("3V3")
+        wire left 60 up 80
+        add v3v3
     3:
-        wire left 80 up 100
-        to net("5V")
+        wire left 100 up 100
+        to v5v
 
     4: 
         wire left 20 down 20
@@ -446,7 +450,7 @@ at atmega8:
             wire up 20
             add res(10k) pin 2 ..angle=90
             wire up 20
-            to net("5V")
+            to v5v
         branch:
             wire left 40 up 420 right 120
             to power_conn2 pin 1
@@ -482,7 +486,7 @@ at atmega8:
         wire left 40
         branch:
             wire up 20
-            to net("5V")
+            to v5v
         wire down 20
         add cap(100n)
         wire down 20
@@ -626,7 +630,7 @@ at icsp_conn:
         to gnd
     2:
         wire right 20 up 20
-        to net("5V")
+        to v5v
 
     5:
         wire left 140
@@ -649,23 +653,6 @@ at icsp_conn:
         to gnd
 
 
-# Block for 5V leds
-at net("5V")
-wire down 20
-branch:
-    wire right 20
-    add res(1k)
-    wire right 20
-    point tmp9
-    wire right 20
-    add led("green") pin 2
-    wire right 20 down 20
-    to gnd
-wire down 40 right 20
-add res(1k)
-wire auto_
-to tmp9
-
 # 3V3 output converter
 dcdc_3v3 = create component:
     pins:
@@ -724,123 +711,157 @@ fet = create component:
     param:
         manufacturer_pn: "FDN304V"
 
-at label("VIN")
-wire right 40 down 20
-add res(10k) ..angle=90
-wire down 20
-branch:
-    wire down 20
-    add res(10k) ..angle=90
-    to gnd
-wire right 80
-add label("CMP")
-wire right 20
-to opamp_1 pin 3
-
-at label("3V3")
-wire right 40
-to opamp_1 pin 2
-
-at label("USBVCC")
-wire right 40 to fet pin 1
-
-at opamp_1 pin 1
-wire right 80 down 100 left 20
-to fet pin 2
-
-at fet pin 3
-wire right 60
-branch:
-    wire up 20
-    to net("5V")
-wire right 60
-branch:
-    wire right 20
-    to dcdc_3v3 pin 1
-wire auto_
-to dcdc_3v3 pin 3
-
-at dcdc_3v3:
-    2:
-        wire left 20 down 20
-        to gnd
-
-    5:
-        wire right 20
-        add label("3V3")
-        wire right 20 down 20
-        add cap(1u)
-        to gnd
-    
-
-
-# Block for 5V power
-power_conn = create component:
-    pins: 3
-    arrange:
-        left: 1,3
-        right: 2
-
-at power_conn:
-    1:
-        wire left 20 down 20
-        branch:
-            wire auto
-            to power_conn pin 3
+frame: 
+    ..title = "Supply generation"
+    ..direction = "row"
+        
+    frame:
+        ..title = "3V3 power"
+            
+        at label("VIN")
+        wire right 40 down 20
+        add res(10k) ..angle=90
         wire down 20
-        to gnd
-    2:
-        wire right 20
-        add label("PWRIN")
-        wire right 40
-        add diode()
-        wire right 40
         branch:
             wire down 20
-            add cap(47u)
+            add res(10k) ..angle=90
             to gnd
+        wire right 80
+        add label("CMP")
         wire right 20
-        point tmp10
+        to opamp_1 pin 3
 
-at dcdc_5V:
-    1:
-        wire left 20 down 20
-        to gnd
-    3:
-        wire left 80
-        to tmp10
+        at v3v3 left
+        wire right 20
+        to opamp_1 pin 2
 
-        wire up 20
-        branch:
-            wire right 20
-            add label("VIN")
-            wire right 40
-        wire up 100 right 80
-        to dcdc_5V_2 pin 3
-    2:
-        wire right 40
-        point tmp11
+        at label("USBVCC")
+        wire right 40 to fet pin 1
+
+        at opamp_1 pin 1
+        wire right 80 down 100 left 20
+        to fet pin 2
+
+        at fet pin 3
+        wire right 60
         branch:
-            wire down 20
-            add cap(47u)
-            to gnd
+            wire up 20
+            to v5v
         wire right 60
         branch:
-            wire down 20
-            add cap(100n)
-            to gnd
-        wire right 20 up 20
-        to net("5V")
-
+            wire right 20
+            to dcdc_3v3 pin 1
+        wire auto_
+        to dcdc_3v3 pin 3
+
+        at dcdc_3v3:
+            2:
+                wire left 20 down 20
+                to gnd
+
+            5:
+                wire right 40
+                branch:
+                    wire up 20 
+                    to v3v3
+                wire down 20
+                add cap(1u)
+                to gnd
+        
 
-at dcdc_5V_2:
-    1:
-        wire left 20 down 20
-        to gnd
-    4:
-        wire right 20 down 20
-        branch:
-            wire auto 
-            to dcdc_5V_2 pin 2
-        wire auto
-        to tmp11
+    frame:
+        ..title = "5V power"
+
+        # Block for 5V power
+        power_conn = create component:
+            pins: 3
+            arrange:
+                left: 1,3
+                right: 2
+
+        at power_conn:
+            1:
+                wire left 20 down 20
+                branch:
+                    wire auto
+                    to power_conn pin 3
+                wire down 20
+                to gnd
+            2:
+                wire right 20
+                add label("PWRIN")
+                wire right 40
+                add diode()
+                wire right 40
+                branch:
+                    wire down 20
+                    add cap(47u)
+                    to gnd
+                wire right 20
+                point tmp10
+
+        at dcdc_5V:
+            1:
+                wire left 20 down 20
+                to gnd
+            3:
+                wire left 80
+                to tmp10
+
+                wire up 20
+                branch:
+                    wire right 20
+                    add label("VIN")
+                    wire right 40
+                wire up 100 right 80
+                to dcdc_5V_2 pin 3
+            2:
+                wire right 40
+                point tmp11
+                branch:
+                    wire down 20
+                    add cap(47u)
+                    to gnd
+                wire right 60
+                branch:
+                    wire down 20
+                    add cap(100n)
+                    to gnd
+                wire right 20 up 20
+                to v5v
+
+
+        at dcdc_5V_2:
+            1:
+                wire left 20 down 20
+                to gnd
+            4:
+                wire right 20 down 20
+                branch:
+                    wire auto 
+                    to dcdc_5V_2 pin 2
+                wire auto
+                to tmp11
+
+        frame:
+            ..title = "5V indication"
+            ..border = 0
+
+            # Block for 5V leds
+            at v5v
+            wire down 20
+            branch:
+                wire right 20
+                add res(1k)
+                wire right 20
+                point tmp9
+                wire right 20
+
+                add led("green")
+                wire right 20 down 20
+                to gnd
+
+            wire down 40 right 20
+            add res(1k)
+            wire auto_
+            to tmp9

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "circuitscript",
-    "version": "0.0.12",
+    "version": "0.0.14",
     "description": "Interpreter for the circuitscript language",
     "homepage": "https://circuitscript.net",
     "engines": {

package/src/draw_symbols.ts

@@ -1,6 +1,6 @@
 import { G } from "@svgdotjs/svg.js";
 
-import { SymbolPinSide, bodyColor, defaultFont } from "./globals.js";
+import { SymbolPinSide, bodyColor, defaultFontBold, defaultFont } from "./globals.js";
 import { Feature, Geometry, GeometryProp, HorizontalAlign, Label, LabelStyle, VerticalAlign } from "./geometry.js";
 import { Logger } from "./logger.js";
 
@@ -160,7 +160,9 @@ export abstract class SymbolGraphic {
             let dominantBaseline = 'auto';
 
             let useAnchor = anchor;
-            if (this.angle === 180){
+            const isRotation180 = Math.abs(this.angle) === 180;
+
+            if (isRotation180){
                 // Special case to flip the text instead of rotating
                 useAnchor = this.flipTextAnchor(anchor);
             }
@@ -194,11 +196,7 @@ export abstract class SymbolGraphic {
             }
 
             const position = tmpLabel.getLabelPosition();
-            
-            let useFont = defaultFont;
-            if (fontWeight === 'bold'){
-                useFont = 'Inter-Bold';
-            }
+            const useFont = defaultFont;
 
             const text = group.text(tmpLabel.text)
                 .fill('#333')
@@ -207,10 +205,10 @@ export abstract class SymbolGraphic {
                     size: fontSize,
                     anchor: anchorStyle,
                     'dominant-baseline': dominantBaseline,
-                    // weight: fontWeight,
+                    weight: fontWeight,
                 });
 
-            if (this.angle === 180){
+            if (isRotation180){
                 text.translate(-position[0], position[1]);
             } else {
                 text.translate(position[0], position[1])

package/src/geometry.ts

@@ -68,7 +68,8 @@ export class Label extends Flatten.Polygon {
             fontWeight = 'regular',
          } = style ?? {};
 
-        // Determine the size of the text
+        // Determine the size of the text, this is needed to determine the 
+        // bounding box of the text for layout purposes.
         const { width, height, box } =
             measureTextSize2(text, defaultFont, fontSize, fontWeight, 
                 anchor, vanchor);

package/src/globals.ts

@@ -33,7 +33,9 @@ export enum SymbolPinSide {
 export const portWidth = 20;
 export const portHeight = 2;
 
-export const defaultFont = 'Inter';
+export const defaultFont = 'Open Sans-Regular, Arial';
+export const defaultFontBold = 'Open Sans-Bold, Arial-Bold, Arial';
+
 export const defaultFontSize = 10;
 
 export const bodyColor = '#FFFEAF';

package/src/helpers.ts

@@ -0,0 +1,111 @@
+import { writeFileSync } from "fs";
+import { generateKiCADNetList } from "./export.js";
+import { LayoutEngine } from "./layout.js";
+import { SequenceAction } from "./objects/ExecutionScope.js";
+import { parseFileWithVisitor } from "./parser.js";
+import { generateSVG2 } from "./render.js";
+import { SimpleStopwatch } from "./utils.js";
+import { MainVisitor } from "./visitor.js";
+
+export function renderScript(scriptData: string, outputPath: string, options): string {
+
+    const {
+        currentDirectory = null, 
+        defaultLibsPath,
+        dumpNets = false,
+        dumpData = false,
+        kicadNetlistPath = null,
+        showStats = false} = options;
+
+    const visitor = new MainVisitor(true);
+
+    visitor.onImportFile = visitor.createImportFileHandler(currentDirectory, defaultLibsPath);
+
+    visitor.print('reading file');
+    visitor.print('done reading file');
+
+    const { tree, parser,
+        hasParseError, hasError, 
+        parserTimeTaken, 
+        lexerTimeTaken } = parseFileWithVisitor(visitor, scriptData);
+
+    showStats && console.log('Lexing took:', lexerTimeTaken);
+    showStats && console.log('Parsing took:', parserTimeTaken);
+    dumpNets && console.log(visitor.dumpNets());
+
+    dumpData && writeFileSync('dump/tree.lisp', tree.toStringTree(null, parser));
+    dumpData && writeFileSync('dump/raw-parser.txt', visitor.logger.dump());
+    
+    if (hasError || hasParseError) {
+        console.log('Error while parsing');
+        return null;
+    }
+
+    visitor.annotateComponents();
+
+    if (kicadNetlistPath) {
+        const kicadNetList = generateKiCADNetList(visitor.getNetList());
+        writeFileSync(kicadNetlistPath, kicadNetList);
+        console.log('Generated KiCad netlist file');
+    }
+    
+
+    // await writeFile('dump/raw-netlist.json', JSON.stringify(visitor.dump2(), null, 2));
+
+    const { sequence, nets } = visitor.getGraph();
+
+    // const tmpInstances = visitor.getExecutor().scope.instances;
+    // for (const [instanceName, instance] of tmpInstances){
+    //     console.log(instanceName);
+    //     console.log(instance.pinNets);
+    // }
+
+
+    const tmpSequence = sequence.map(item => {
+        const tmp = [...item];
+
+        const action = tmp[0];
+
+        if (action === SequenceAction.Wire) {
+            tmp[2] = tmp[2].map(item2 => {
+                return [item2.direction, item2.value].join(",");
+            }).join(" ");
+        } else if (action === SequenceAction.Frame) {
+            tmp[1] = item[1].frameId;
+            
+        } else if (action !== SequenceAction.WireJump) {
+            tmp[1] = item[1].instanceName;
+        }
+
+        return tmp.join(" | ");
+    });
+
+    dumpData && writeFileSync('dump/raw-sequence.txt', tmpSequence.join('\n'));
+    let svgOutput: string = null;
+
+    try {
+        const layoutEngine = new LayoutEngine();
+        const layoutTimer = new SimpleStopwatch();
+
+        const graph = layoutEngine.runLayout(sequence, nets);
+
+        layoutEngine.printWarnings();
+
+        showStats && console.log('Layout took:', layoutTimer.lap());
+
+        dumpData && writeFileSync('dump/raw-layout.txt', layoutEngine.logger.dump());
+
+        const generateSvgTimer = new SimpleStopwatch();
+        svgOutput = generateSVG2(graph);
+        showStats && console.log('Render took:', generateSvgTimer.lap());
+
+        if (outputPath){
+            writeFileSync(outputPath, svgOutput);
+        } 
+    } catch (err) {
+        console.log('Failed to render:');
+        console.log(err)
+    }
+
+    return svgOutput;
+}