SCON

https://github.com/wmacevoy/openscad-scon
Admin
SCON is a convenient configuration data subset for OpenSCAD similar to JSON for Javascript, enabling...
Tokens:1,570
Snippets:18
Trust Score:7.6
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Loading SCON from JSON using Python, Node.js, Bun, or QuickJS

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Provides command-line examples for converting JSON files to SCON files using different JavaScript runtimes and Python. This is useful for integrating SCON with external build processes.

```bash
# Python: python3 scon_from_json.py <cfg.json >cfg.scon
# Node: node scon_from_json.js <cfg.json >cfg.scon
# Bun: bun scon_from_json.js <cfg.json >cfg.scon
# [QuickJS](https://bellard.org/quickjs/): qjs --std -m scon_from_json.js <cfg.json >cfg.scon

```

--------------------------------

### SCON Configuration Structure Example

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Illustrates a more complex SCON configuration with nested lists and maps. This structure is suitable for defining hierarchical settings.

```openscad
cfg_scon = [
  ["fn",100],
  ["arms",[
    ["left",[["color","blue"],["length",6]]],
    ["right",[["color","white"],["length",3]]],
  ]],
  ["sequence",[3,5,8]],
];

```

--------------------------------

### Converting SCON to JSON with scon_to_json

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Shows examples of using the `scon_to_json` function to convert various SCON data types into their JSON string representations. This is useful for interoperability.

```openscad
scon_to_json(true) == "true"
scon_to_json(17) == "17"
scon_to_json("length") == "\"length\""
scon_to_json([["x",1],["y",2]]) == "{\"x\":1,\"y\":2}"
scon_to_json([]) == "{}"
scon_to_json([2,3,5,8]) == "[2,3,5,8]"

```

--------------------------------

### Creating Nested Configurations with scon_make

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Demonstrates how to create base configurations and derive new ones using `scon_make` with multiple arguments. This allows for efficient description of similar structures with variations.

```openscad
// arm is the base configuration
arm=scon_make([
  ["state","down"],
  ["length",10],
  ["radius",1],
]);

// left_arm is an arm, but with some changes & additions
left_arm=scon_make([
  ["state","up"],
],arm);

// right_arm is an arm, but with some changes & additions
right_arm=scon_make([
  ["length",8],
  ["tool",true],
],arm);

```

--------------------------------

### Using scon_make for Simplified Configuration Access

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Shows how `scon_make` creates a function for easier access to SCON configuration values. It also demonstrates providing default values for missing parameters.

```openscad
cfg = scon_make(cfg_scon);

arms_left_length=cfg(["arms","left","length"]);

// you can supply an optional replacement (default undef) for missing values...
arms_left_radius=cfg(["arms","left","radius"],missing=1);

```

--------------------------------

### Basic SCON Configuration and Usage

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Defines a SCON configuration and demonstrates how to access its values using `scon_make`. This is useful for setting up parameters for OpenSCAD modules.

```openscad
include <scon.scad>

cfg_scon = [
  ["fn",100],
  ["sphere",[
    ["radius",1],
    ["center",[1,2,3]],
  ]],
];

cfg=scon_make(cfg_scon);

fn = cfg(["fn"]);

sphere_center = cfg(["sphere","center"]);
sphere_radius = cfg(["sphere","radius"]);
sphere_fn = cfg(["sphere","fn"],fn); // missing value replacement

translate(sphere_center) sphere(sphere_radius,$fn=sphere_fn);

```

--------------------------------

### Integrating SCON with OpenSCAD Includes

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Demonstrates how to include SCON files within an OpenSCAD project and use `scon_make` to create a configuration object. This is a common pattern for managing project configurations.

```openscad
include <scon.scad>;
cfg_scon=include <cfg.scon>;
cfg=scon_make(cfg_scon);
echo(scon_to_json(cfg_scon));

```

```openscad
cfg=scon_make(include <cfg.scon>);
echo(scon_to_json(cfg([])));

```

--------------------------------

### Using SCON Configurations in OpenSCAD Modules

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Illustrates how to pass SCON configuration objects to OpenSCAD modules and access their properties within the module. This promotes modular and configurable designs.

```openscad
module arm_draw(me) {
  let (length=me(["length"]), radius=me(["radius"]), tool=me(["tool"],false)) {
    // generate arm of length and radius, etc...
  }
}
arm_draw(left_arm);
arm_draw(right_arm);

```

--------------------------------

### Loading JSON directly into SCON with OpenSCAD Developer Build

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Shows how to use `import()` and `scon_from_json()` within OpenSCAD (developer build) to load JSON configurations directly. This bypasses the need for external conversion scripts.

```openscad
include <scon.scad>;
cfg_json=import("cfg.json");
cfg_scon=scon_from_json(cfg_json);
cfg=scon_make(cfg_scon);
echo(scon_to_json(cfg_scon));

```

```openscad
// only if your OpenSCAD supports direct JSON import
cfg=scon_make(scon_from_json(import("cfg.json")));
echo(scon_to_json(cfg([])));

```

--------------------------------

### Running OpenSCAD Tests

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Command to execute OpenSCAD tests, which involves rendering a specific SCAD file to an STL. This is used to verify the functionality of the SCON library.

```bash
openscad -o pass.stl tests/scon_test.scad

```

--------------------------------

### Accessing SCON Values with scon_value

Source: https://github.com/wmacevoy/openscad-scon/blob/main/README.md

Demonstrates how to retrieve specific values from a SCON configuration using the `scon_value` function. This is useful for direct access to configuration parameters.

```openscad
arms_left_length=scon_value(cfg_scon,["arms","left","length"]);
eight=scon_value(cfg_scon,["sequence",2]);
arms_cfg=scon_value(cfg_scon,["arms"]);

```
Tokens:
Raw