====== Circuit_macros ======
Circuit_macros sind eine Sammlung von Makros zum Zeichnen von Schaltplänen, die sich gut in [[latex|LaTeX]]-Dokumente integrieren lassen.
Zur Verarbeitung werden die Programme m4 und [[https://ece.uwaterloo.ca/~aplevich/dpic/|dpic]] verwendet.
===== Vordefinierte Positionen =====
Der aktuellen Position bzw. dem aktuellen Element kann mit ''name:'' ein Namen gegeben werden, den man später verwenden kann:
<code>
R1: resistor()
</code>

^Code^Bedeutung^
|<code> Here</code>|aktuelle Position|
|<code> R1.x</code>|x-Koordinate von R1|
|<code> R1.y</code>|y-Koordinate von R1|
|<code> R1.start</code>|Start-Koordinate von R1|
|<code> R1.end</code>|End-Koordinate von R1|
|<code> R1.left</code>|linke Koordinate von R1 (in Zeichenrichtung)|
|<code> R1.right</code>|rechte Koordinate von R1 (in Zeichenrichtung)|
|<code> R1.center</code>|Mittelpunkt von R1|

<WRAP tip round>
Wird mit ''(A,B)'' eine Koordinate aus zwei Punkten zusammengebaut, ist es nicht notwendig explizit auf die jeweilige x- bzw. y-Koordinate (also ''(A.x,B.y)'') zuzugreifen.
</WRAP>
===== Vordefinierte Längen und Größen =====
^Code^Bedeutung^
|<code>elen_</code>|Länge eines zweipoliges Elementes (inkl. Anschlussleitungen)|
|<code>dotrad_</code>|Radius eines Punktes|

===== Häufig verwendete Elemente/Befehle ======
^Code^Bedeutung^Bild^
|<code>resistor(,,E) </code>|Widerstand (europäisch) | {{:resistor.svg|Widerstand}}|
|<code>capacitor(,,E) </code>|Kapazität (europäisch) | {{:capacitor.svg|Kapazität}}|
|<code>ebox(,,,0) </code>|Induktivität (europäisch)| {{:inductor.svg|Induktivität}}|
|<code>ground(,,E) </code>|Masse (europäisch)| {{:ground.svg|Masse}}|
|<code>dot </code>|Kreuzungspunkt\\ (dargestellt mit zusätzlichen Linien (''line''))| {{:dot.svg|Kreuzungspunkt )}}\\ |
|<code>gap(,1,) </code>|Anschlussklemme mit zwei Pins (unausgefüllt)| {{:gap.svg|Anschlussklemme}}|
|<code>source(,v) </code>|Spannungsquelle\\ [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/html/Sources.svg|weitere Varianten]]| {{:source_v.svg|Spannungsquelle}}|
|<code>source(,i) </code>|Stromquelle\\ [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/html/Sources.svg|weitere Varianten]]| {{:source_i.svg|Spannungsquelle}}|
|<code>tconn(,O,2*dotrad_) </code>|Anschlussklemme mit einem Pin\\ <wrap tip>Das zweite Argument ist ein "Oh", keine "Null"</wrap>\\ <wrap tip>Alternativ kann ''dot(,,1)'' verwendet werden</wrap>| {{:tconn_O.svg|Anschlussklemme}}|
|<code>opamp </code>|Operationsverstärker| {{:opamp.svg|Operationsverstärker}}|
|<code>opamp(,,,,R) </code>|Operationsverstärker (gespiegelt)| {{:opamp.svg|Operationsverstärker (gespiegelt)}}|
|<code>bi_tr()</code>|Bipolartransisitor, NPN| {{:npn.svg|Bipolartransistor (NPN)}}|
|<code>bi_tr(,,P)</code>|Bipolartransisitor, PNP| {{:pnp.svg|Bipolartransistor (PNP)}}|
|<code>e_fet(,,,S)</code>|N-MOS\\ [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/html/fet.svg|weitere Varianten]]| {{:nfet.svg|N-MOS}}|
|<code>e_fet(,,P,S)</code>|P-MOS \\ [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/html/fet.svg|weitere Varianten]]| {{:pfet.svg|P-MOS}}|
|<code>b_current()</code>|Stromzählpfeil (dargestellt mit einem Widerstand)| {{:b_current.svg|Stromzählpfeil}}|
|<code>larrow()</code>|Spannungszählpfeil (dargestellt mit einer Spannungsquelle und Label)\\ ''rarrow()'' erzeugt den Pfeil auf der anderen Seite| {{:larrow.svg|Spannungszählpfeil}}|
|<code>line</code>|Verbindungsleitung (dargestellt sind zwei Leitungen)\\ <wrap important>keine Klammern</wrap>| {{:line.svg|Verbindungsleitung}}|
|<code>move</code>|Cursorbewegung ohne Zeichnen einer Linie \\ <wrap important>keine Klammern</wrap>| |

===== Beschriftungen (Label) =====

==== Zweipolige Elemente ====
Zur Beschriftung zweipoliger Elemente gibt es spezielle Makros:

^Code ^Bedeutung ^
|<code latex>llabel(arg1,arg2,arg3)</code>|Beschriftung in Zeichenrichtung links vom Element|
|<code latex>clabel(arg1,arg2,arg3)</code>|Beschriftung zentriert zum Element|
|<code latex>rlabel(arg1,arg2,arg3)</code>|Beschriftung in Zeichenrichtung rechts vom Element|

Die Argumente ''arg1'', ''arg2'', ''arg3'' entsprechen dabei den Positionen Anfang, Mitte und Ende.
Werden die Argumente ohne Anführungszeichen verwendet, ist der Mathemodus von LaTeX aktiv.
Für Text im Textmodus müssen die Argumente in Anführungszeichen stehen.

Beispiele:
^Code^Bild^
|<code>resistor(,,E); llabel(,R_1,)</code>|{{:example_label_resistor.svg|Beispiel Label Widerstand}}|
|<code>resistor(,,E); llabel(,"R",)</code>|{{:example_label_resistor_text.svg|Beispiel Label Widerstand (Textmodus)}}|
|<code>gap(down_,1,A); llabel(+,V_1,-);</code>|{{:example_label_gap.svg|Beispiel Label Gap}} |

==== Andere Elemente ====
Andere Elemente lassen sich mit
<code>
"text" at location
</code>
beschriften.
Hier muss der Mathemodus explizit mit ''$'' aktiviert werden.
Die Ausrichtung kann mit ''ljust'', ''rjust'', ''above'' oder ''below'' bestimmt werden.

===== Platzierung von mehrpoligen Elementen =====
Mehrpolige Elemente können mit der Syntax
<code>
with .x at y
</code>
platziert werden.

Beispiele:
<code>
opamp() with .In1 at Here
</code>
<code>
R1: resistor(,,E)
...mehr Befehle...
bi_tr() with .B at R1.end
</code>

 

===== Tipps und Tricks =====
==== Anschlussklemme mit unausgefüllten Pins an Masse ====
Möchte man eine Anschlussklemme mit unausgefüllten Pins in der Größe anderer zweipoliger Elemente mit direkter Verbindung zu Masse zeichnen, sieht das ohne weitere Maßnahmen so aus:

{{  :example_gap_fail.svg?200  |Klemme mit Überlappung}}

Um dies zu vermeiden, muss die Klemme verkürzt und der Cursor weiterbewegt werden:
<code>
gap(down_ dimen_-dotrad_,1,A); llabel(,V_\text{out},)
move down_ dotrad_
ground(,,E)
</code>
Damit sieht das Beispiel so aus:
^Code^Bild^
|<code>
ground(,,E)
resistor(up_,E,)
line right_
gap(down_ dimen_-dotrad_,1,A); llabel(,V_\text{out},)
move down_ dotrad_
ground(,,E)
</code>|{{:example_gap_good.svg?200|Klemme ohne Überlappung}}|

==== Beschriftung innerhalb eines Operationsverstärkers ====
Soll die Beschriftung eines Operationsverstärker nicht über- oder innerhalb, sondern innerhalb gesetzt werden, kann dies nicht mit den Label-Befehlen, sondern so erreicht werden:
^Code^Bild^
|<code>
U1: opamp
"$U_1$" at U1.C
</code>| {{opamp_label.svg|Operationsverstärker, Beschriftung innerhalb}}|

<WRAP tip round>
Der Mathemodus (für tiefgestellte Zeichen wie ''1'' im Beispiel) muss hier im Gegensatz zu den Label-Befehlen explizit mit je einem ''$'' aktiviert und beendet werden. 
</WRAP>

==== Linienübergänge an Ecken ====
Stoßen Linien aufeinander, sind ihre Ende nicht vollständig verbunden (siehe 1. Beispiel).
Als Abhilfe kann eine Linie mit mehreren Segmenten (2. Beispiel) oder die Makros ''corner'' für rechtwinklige Ecken (3. Beispiel) bzw. ''round'' für abgerundete Ecken (4. Beispiel) verwendet werden. 

|<code>line up_ 0.2
line right_ 0.2</code>|<code>line up_ 0.2 then right_ 0.2</code>|<code>line up_ 0.2
corner
line right_ 0.2</code>|<code>line up_ 0.2
round
line right_ 0.2</code>|
|{{:line_wo_corner.svg?140}}|{{:line_then.svg?140}}|{{:line_corner.svg?140}}|{{:line_round.svg?140}}|

<WRAP info round>
Die Syntax ''corner(at location)'' existiert im Gegensatz zu ''round(at location)'' nicht, weil für das Makro ''corner'' die Richtung der letzten gezeichneten Linie bekannt sein muss. Als Workaround kann ''line right_ linethick bp%%__%% at location'' verwendet werden. Die Richtung muss dabei manuell angepasst werden.
</WRAP>

<WRAP info round>
''round(at location)'' verändert in Versionen %%<=%% 8.1 nicht die Variable ''Here''. Ab Version 8.2 wird ''Here'' analog zu den übrigen Befehlen verändert.
</WRAP>

==== Abstände zur Beschriftung vergrößern ====
Durch das Setzen der Variablen ''textoffset'' lässt sich der Abstand zwischen den Elementen und der Beschriftung vergrößern.

Beispiel: 
<code>
textoffset = 5bp__
</code>


===== Abgeschnittener Text =====
Unter bestimmten Umständen wird Text abgeschnitten dargestellt.
Das liegt daran, dass die Bounding Box der mit dem Flow m4->dpic->latex->dvips generierten EPS-Datei falsch ist.
Eine Möglichkeit die Bounding Box zu korrigieren, ist das Werkzeug ''epstool'':
<code bash>
epstool --copy --bbox in.eps out.eps
</code>
Eine andere Möglichkeit ist die Verwendung des [[PGF_TikZ|PGF/TikZ]]-Backends (durch ''dpic -g'') anstelle des PSTricks-Backends.
===== Links =====
  * [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/|Homepage]]
  * [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/Circuit_macros.pdf|Circuit_macros Dokumentation]]
  * [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/CHANGES|Circuit_macros Changelog]]
  * [[https://gitlab.com/aplevich/dpic/-/raw/master/dpic-doc.pdf|dpic Dokumentation]] 
  * [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/html/examples.html|Beispiele (HTML mit Link zu den Sourcen)]]
  * [[https://ece.uwaterloo.ca/~aplevich/Circuit_macros/html/examples.pdf|Beispiele (PDF)]]
  * [[cirkuit|Cirkuit]] GUI für Circuit_macros