Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 3.52 KB

format.md

File metadata and controls

70 lines (45 loc) · 3.52 KB

Schemascii Format

Wires

Wires are simply lines drawn using dashes or pipe symbols.

A corner or wire join (drawn as a dot) is notated by an asterisk (*)

Crossed wires (not joined) are notated with a ) or simply broken to allow the other wire to pass. Examples:

Crossed:         Joined:       Corner:     Crossed:      Crossed:    Dangling ends:
    |               |            |            |             |              |
 ---)---         ---*---         *---      -------       ---|---           |---
    |               |                         |             |

Components

Small components

Small components are notated with their reference designator: one or more uppercase letters followed by an ID, which can either be a number, or a period followed by some text.

They are always written horizontally even if the terminals are on the top and bottom.

IDs are allowed to be duplicated and result in the same component values.

Components can be padded on either side with #'s to make them bigger.

Examples:

  • C33
  • Q1001
  • L.Coil
  • F3#
  • D7#####
  • U1#####
  • ####R.Heater####

Components are able to accept "flags", which are other punctuation characters and lowercase letters touching them.

  • Polarized components (caps, diodes, etc.) accept a + to indicate the polarity,
  • Transistors use lowercase letters to indicate collector/emitter/base (for BJTs) or source/gate/drain (for FETs).

Big components

  • Big components are indicated with a box made of ~ (top and bottom), : (sides), and . (corners).
  • The inside of the box can contain anything you want, but it must include exactly one reference designator as to what component it is.

Reference designators

To include component values, pin numbers, etc, somewhere in the drawing but not touching any wires or other components, you can write component values - these are formatted as the reference designator (same as in circuit) followed by a : and the value parameter (which stops at the first whitespace). I usually put these in a "BOM section" below the circuit itself but you could also put them right next to the component.

For simple components, this is usually just a value rating, but without the units (only the Metric prefix). For more specific components (mostly semiconductor devices) this is usually the part number and/or some string to determine how to draw the component.

Examples:

  • C33:2.2u -- "2.2 µF"
  • Q1001:pnp:TIP102 -- "pnp", "npn", "pfet", or "nfet" to determine what kind of transistor, plus the part number; printed verbatim
  • L51:0.33 -- this is rewritten to "330 mH" so that it has no decimal point.
  • F3:1500m -- rewritten: "1.5 A"
  • D7:1N4001 -- again, part number
  • U1:SN74LS08N,14,1,2,7,3 -- some components let you label pins with whatever you want (in this case just numbers). They start at the top-leftmost and follow counterclockwise to follow with the pin-numbering of most IC's.
  • R2:10,5 -- this is formatted as "10 Ω 5 W". The second value is the rating; for resistors, this is a wattage, for most else, this is a maximum voltage.

Inline configuration values

New in 0.2.0!

You can specify configuration values for rendering the components inline in the document by writing !name=value! in your document. See the help output of the Schemascii CLI for the different options (in the README) or look at the config options at the top of configs.py. The most common options I use are scale and padding.