diff options
author | Karl Berry <karl@freefriends.org> | 2019-05-10 21:15:08 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2019-05-10 21:15:08 +0000 |
commit | 0adb4af0234da7598911f149b7884b86b514e07d (patch) | |
tree | 1aa91d19135a803261a775221880a00982082242 /Master/texmf-dist/doc/latex/circuitikz | |
parent | d2b8d33bc4070a7246b3cd1d3074b6d369c3ef7d (diff) |
circuitikz (10may19)
git-svn-id: svn://tug.org/texlive/trunk@51071 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/circuitikz')
-rw-r--r-- | Master/texmf-dist/doc/latex/circuitikz/changelog.tex | 59 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.pdf | bin | 289048 -> 536781 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.tex | 4019 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/circuitikz/compatibility.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/circuitikz/ctikzmanutils.sty | 123 |
5 files changed, 3141 insertions, 1062 deletions
diff --git a/Master/texmf-dist/doc/latex/circuitikz/changelog.tex b/Master/texmf-dist/doc/latex/circuitikz/changelog.tex index 2273d50bbd5..03932fa52a8 100644 --- a/Master/texmf-dist/doc/latex/circuitikz/changelog.tex +++ b/Master/texmf-dist/doc/latex/circuitikz/changelog.tex @@ -6,6 +6,65 @@ full list of changes. \begin{itemize} \tightlist \item + Version 0.9.0 (2019-05-10) + + \begin{itemize} + \tightlist + \item + Added Romano Giannetti as contributor + \item + Added a CONTRIBUTING file + \item + Added options for solving the voltage direction problems. + \item + Adjusted ground symbols to better match ISO standard, added new + symbols + \item + Added new sources (cute european versions, noise sources) + \item + Added new types of amplifiers, and option to flip inputs and outputs + \item + Added bidirectional diodes (diac) thanks to Andre Lucas Chinazzo + \item + Added L,R,C sensors (with european, american and cute variants) + \item + Added stacked labels (thanks to the original work by Claudio + Fiandrino) + \item + Make the position of voltage symbols adjustable + \item + Make the position of arrows in FETs and BJTs adjustable + \item + Added chips (DIP, QFP) with a generic number of pins + \item + Added special anchors for transformers (and fixed the wrong center + anchor) + \item + Changed the logical port implementation to multiple inputs (thanks + to John Kormylo) with border anchors. + \item + Added several symbols: bulb, new switches, new antennas, + loudspeaker, microphone, coaxial connector, viscoelastic element + \item + Make most components fillable + \item + Added the oscilloscope component and several new instruments + \item + Added viscoelastic element + \item + Added a manual section on how to define new components + \item + Fixed american voltage symbols and allow to customize them + \item + Fixed placement of straightlabels in several cases + \item + Fixed a bug about straightlabels (thanks to @fotesan) + \item + Fixed labels spacing so that they are independent on scale factor + \item + Fixed the position of text labels in amplifiers + \end{itemize} +\item Version 0.8.3 (2017-05-28) \begin{itemize} diff --git a/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.pdf b/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.pdf Binary files differindex af84864d70b..9b9b163278d 100644 --- a/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.pdf +++ b/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.pdf diff --git a/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.tex b/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.tex index 35c383523ae..bbbfec74028 100644 --- a/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.tex +++ b/Master/texmf-dist/doc/latex/circuitikz/circuitikzmanual.tex @@ -5,17 +5,20 @@ % !TeX spellcheck = en_US % !TeX encoding = utf8 -\documentclass[a4paper]{article} +\documentclass[a4paper, titlepage]{article} \usepackage{a4wide} %smaller borders - +\usepackage{titling} \def\modern{ \usepackage{fontspec} \defaultfontfeatures{Ligatures=TeX, Numbers=OldStyle,Mapping=tex-text ,SmallCapsFeatures={LetterSpace=8, Numbers=OldStyle}} - %\setmainfont{Gentium Book Basic} + %\setmainfont{Gentium Book Basic} } -\usepackage[siunitx]{circuitikz} +%do not split this line in more lines, otherwise "make git-manual" will show the wrong version +\usepackage[siunitx, RPvoltages]{circuitikz} +% Let this being the same as the chosen voltage direction for coherence +\def\chosenvoltoption{RPvoltages} \usepackage{ifxetex,ifluatex} \ifxetex @@ -35,7 +38,18 @@ \sisetup{load=derived} % loading \siemens \usepackage{showexpl} -\lstset{pos=l,width=-99pt, overhang=0pt,hsep=\columnsep,vsep=\bigskipamount,rframe=single,numbers=left,numberstyle=\tiny,numbersep=.3em, xleftmargin=1em, columns=flexible, language=[LaTeX]TEX,breaklines=true,basicstyle=\normalsize\ttfamily,tabsize=3} +% +% The following trick is used to silence showexpl a bit, so that the +% logs are readable... +% +\makeatletter +\let\SX@Info=\relax % silence showexpl a bit... +\makeatother +% +\lstset{pos=l,width=-99pt, overhang=0pt,hsep=\columnsep,vsep=\bigskipamount, + rframe=single,numbers=left,numberstyle=\tiny,numbersep=.3em, xleftmargin=1em, + columns=flexible, language=[LaTeX]TEX,breaklines=true, + basicstyle=\normalsize\ttfamily,tabsize=3} \usepackage{booktabs} \renewcommand{\arraystretch}{1.2} @@ -45,7 +59,7 @@ \hypersetup{ bookmarks=false, % show bookmarks bar? pdftitle={CircuiTikZ \pgfcircversion\ - manual}, % title - pdfauthor={Massimo Redaelli, Stefan Lindner, Stefan Erhardt}, % author + pdfauthor={Massimo Redaelli, Stefan Lindner, Stefan Erhardt, Romano Giannetti}, % author pdfsubject={CircuiTikZ manual}, % subject of the document pdfkeywords={}, % list of keywords colorlinks=true, % false: boxed links; true: colored links @@ -58,26 +72,22 @@ \usepackage{textcomp} \makeindex[title=Index of the components, intoc=true] -\def\circuititem#1#2#3{\item {#2} (node[\texttt{#1}]\{#3\}) \index{#1} \par \begin{center}\begin{circuitikz} \draw (0,0) node[#1] {#3}; \end{circuitikz} \end{center} -\par} - -\newcommand{\circuititembip}[3]{\item {#2} \index{#1} -\tikz\foreach \i in {#3} {\index{\i|see{#1}} }; (\texttt{#1}% -\ifthenelse{\equal{#3}{}}{% -}{% -, or \texttt{#3}% -}% -)\par \begin{center}\begin{circuitikz} \draw (0,0) to[#1] (2,0); \end{circuitikz} \end{center}\par} +% Local utilities packages +\usepackage{ctikzmanutils} -%\usepackage{marvosym} -%\newcommand{\email}[2][]{\def\temp{#1}\ifx\temp\empty\Letter~\fi\href{mailto:#2}{#2}} \newcommand{\email}[1]{\href{mailto:#1}{#1}} - \long\def\comment#1{} +% There are a lot of boxes in the document; let's try to give TeX +% a bit of leverage... do not use parindent (which looks strange between examples) +% and add stretch between paragraph, to avoid a lot of sections and subsections +% starting at the end of the page. +\parindent=0pt +\parskip=4pt plus 6pt minus 2pt + \begin{document} -\setcounter{secnumdepth}{3} -\setcounter{tocdepth}{3} +\setcounter{secnumdepth}{4} +\setcounter{tocdepth}{4} \def\TikZ{Ti\emph{k}Z} \def\Circuitikz{Circui\TikZ} @@ -86,9 +96,42 @@ \lstloadlanguages{TeX} \title{\Circuitikz \\{\large version \pgfcircversion{} (\pgfcircversiondate)}} -\author{Massimo A. Redaelli (\email{m.redaelli@gmail.com})\\Stefan Lindner (\email{stefan.lindner@fau.de})\\Stefan Erhardt (\email{stefan.erhardt@fau.de})} +\author{Massimo A. Redaelli (\email{m.redaelli@gmail.com})\\ + Stefan Lindner (\email{stefan.lindner@fau.de})\\ + Stefan Erhardt (\email{stefan.erhardt@fau.de})\\ + Romano Giannetti (\email{romano.giannetti@gmail.com})} \date{\today} +\pretitle{\begin{center}% + \begin{circuitikz} + \draw (0,0) node[dipchip, rotate=90, num pins=40, fill=cyan!20!white](C){% + \rotatebox{-90}{\LARGE\Circuitikz}% + }; + \draw (C.pin 20) -- ++(0,-8) node[ground](GND){}; + \draw (C.pin 7) to[D, fill=blue] ++(0,-1) -- ++(0.5,0) to[R] ++(2,0) + coordinate(a1) to[short, -*] + node[above left, blue]{Massimo A. Redaelli} + node[below left,]{\email{m.redaelli@gmail.com}} + (a1-|GND); + \draw (C.pin 5) to[D, fill=red] ++(0,-3)-- ++(0.5,0) to[R] ++(2,0) + coordinate(a2) to[short, -*] + node[above left, blue]{Stefan Lindner} + node[below left,]{\email{stefan.lindner@fau.de}} + (a2-|GND); + \draw (C.pin 3) to[D, fill=green] ++(0,-5)-- ++(0.5,0) to[R] ++(2,0) + coordinate(a3) to[short, -*] + node[above left, blue]{Stefan Erhart} + node[below left,]{\email{stefan.erhardt@fau.de}} + (a3-|GND); + \draw (C.pin 1) to[D, fill=yellow] ++(0,-7)-- ++(0.5,0) to[R] ++(2,0) + coordinate(a4) to[short, -*] + node[above left, blue]{Romano Giannetti} + node[below left,]{\email{romano.giannetti@gmail.com}} + (a4-|GND); + \end{circuitikz} + \par\bigskip\vfill} +\posttitle{\end{center}} + \maketitle \tableofcontents @@ -96,20 +139,16 @@ \section{Introduction} \subsection{About} \Circuitikz\ was initiated by Massimo Redaelli in 2007, who was working as a research assistant at the Polytechnic University of Milan, Italy, and needed a tool for creating exercises and exams. -After he left University in 2010 the development of \Circuitikz\ slowed down, since \LaTeX\ is mainly established in the academic world. In 2015 Stefan Lindner and Stefan Erhardt, both working as research assistants at the University of Erlangen-Nürnberg, Germany, joined the team and now maintain the project together with the initial author. +After he left University in 2010 the development of \Circuitikz\ slowed down, since \LaTeX\ is mainly established in the academic world. In 2015 Stefan Lindner and Stefan Erhardt, both working as research assistants at the University of Erlangen-Nürnberg, Germany, joined the team and now maintain the project together with the initial author. In 2018 Romano Giannetti, full professor of Electronics at Comillas Pontifical University of Madrid, joined the team. The use of \Circuitikz\ is, of course, not limited to academic teaching. The package gets widely used by engineers for typesetting electronic circuits for articles and publications all over the world. -\medskip - -This documentation is somewhat scant. Hopefully the authors will find the leisure to improve it some day. - \subsection{Loading the package} \begin{table}[h] \centering \begin{tabular}{ll}\toprule - \LaTeX & \ConTeXt\footnotemark \\ \midrule + \LaTeX & \ConTeXt\footnotemark \\ \midrule \verb!\usepackage{circuitikz}! & \verb!\usemodule[circuitikz]!\\ \bottomrule \end{tabular} @@ -124,11 +163,25 @@ This documentation is somewhat scant. Hopefully the authors will find the leisur \tikz \draw (0,0) to[R=$R_1$] (2,0); \end{LTXexample} +\subsection{Installing a new version of the package.} + +The stable version of the package should come with your \LaTeX\ distribution. Downloading the files from CTAN and installing them locally is, unfortunately, a distribution-dependent task and sometime not so trivial. If you search for \texttt{local texmf tree} and the name of your distribution on \url{https://tex.stackexchange.com/} you will find a lot of hints. + +Anyway, the easiest way of using whichever version of \Circuitikz\ is to point to the github page \url{https://circuitikz.github.io/circuitikz/} of the project, and download the version you want. You will download a simple (biggish) file, called \texttt{circuitikz.sty}. + +Now you can just put this file in your local \texttt{texmf} tree, if you have one, or simply adding it into the same directory where your main file resides, and then use + +\begin{verbatim} + \usepackage[...options...]{circuitikzgit} +\end{verbatim} + +instead of \texttt{circuitikz}. This is also advantageous for ``future resilience''; the authors try hard not to break backward compatibility with new versions, but sometime things happen. + \subsection{Requirements} \begin{itemize} - \item \texttt{tikz}, version $\ge 3$; - \item \texttt{xstring}, not older than 2009/03/13; - \item \texttt{siunitx}, if using \texttt{siunitx} option. + \item \texttt{tikz}, version $\ge 3$; + \item \texttt{xstring}, not older than 2009/03/13; + \item \texttt{siunitx}, if using \texttt{siunitx} option. \end{itemize} \subsection{Incompatible packages} @@ -137,116 +190,561 @@ This documentation is somewhat scant. Hopefully the authors will find the leisur So, if loaded with said option, one must write \verb!(0,0) to[*R] (2,0)! and, for transistors on a path, \verb!(0,0) to[*Tnmos] (2,0)!, and so on (but \verb!(0,0) node[nmos] {}!). See example at page~\pageref{ex:compatibility}. \subsection{License} -Copyright \copyright\ 2007--2017 Massimo Redaelli. This package is author-maintained. Permission is granted to copy, distribute and/or modify this software under the terms of the \LaTeX\ Project Public License, version 1.3.1, or the GNU Public License. This software is provided ‘as is’, without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. +Copyright \copyright\ 2007--2019 Massimo Redaelli. This package is author-maintained. Permission is granted to copy, distribute and/or modify this software under the terms of the \LaTeX\ Project Public License, version 1.3.1, or the GNU Public License. This software is provided ‘as is’, without warranty of any kind, either expressed or implied, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. \subsection{Feedback} The easiest way to contact the authors is via the official Github repository: \url{https://github.com/circuitikz/circuitikz/issues} -\section{Incompabilities between version} +\subsection{Incompabilities between version} Here, we will provide a list of incompabilitys between different version of circuitikz. We will try to hold this list short, but sometimes it is easier to break with old syntax than including a lot of switches and compatibility layers. You can check the used version at your local installation using the macro \verb!\pgfcircversion{}!. \begin{itemize} -\item Since v0.8.2: voltage and current label directions(v<= / i<=) do NOT change the orientation of the drawn source shape anymore. Use the "invert" option to rotate the shape of the source. Furthermore, from this version on, the current label(i=) at current sources can be used independent of the regular label(l=). -\item Since v0.7?: The label behaviour at mirrored bipoles has changes, this fixes the voltage drawing, but perhaps you have to adjust your label positions. -\item Since v0.5.1: The parts pfet,pigfete,pigfetebulk and pigfetd are now mirrored by default. Please adjust your yscale-option to correct this. -\item Since v0.5: New voltage counting direction, here exists an option to use the old behaviour + \item After v0.9.0: the parameters \texttt{tripoles/american or port/aaa}, \texttt{...bbb}, \texttt{...ccc} and \texttt{...ddd} are no longer used and are silently ignored; the same stands for \texttt{nor}, \texttt{xor}, and \texttt{xnor} ports. + \item After v0.9.0: voltage and current directions/sign (plus and minus signs in case of \texttt{american voltages} and arrows in case of \texttt{european voltages} have been rationalized with a couple of new options (see details in section~\ref{curr-and-volt}. The default case is still the same as v0.8.3. + \item Since v0.8.2: voltage and current label directions(v<= / i<=) do NOT change the orientation of the drawn source shape anymore. Use the "invert" option to rotate the shape of the source. Furthermore, from this version on, the current label(i=) at current sources can be used independent of the regular label(l=). + \item Since v0.7?: The label behaviour at mirrored bipoles has changes, this fixes the voltage drawing, but perhaps you have to adjust your label positions. + \item Since v0.5.1: The parts pfet, pigfete, pigfetebulk and pigfetd are now mirrored by default. Please adjust your yscale-option to correct this. + \item Since v0.5: New voltage counting direction, here exists an option to use the old behaviour \end{itemize} For older projects, you can use an older version locally using the git-version and picking the correct commit from the repository (branch gh-pages). -\section{Package options} +\subsection{Package options} +\label{sec:package-options} \noindent Circuit people are very opinionated about their symbols. In order to meet the individual gusto you can set a bunch of package options. The standard options are what the authors like, for example you get this: \begin{LTXexample}[varwidth=true] -\begin{circuitikz} - \draw (0,0) to[R=2<\ohm>, i=?, v=84<\volt>] (2,0) -- - (2,2) to[V<=84<\volt>] (0,2) - -- (0,0); -\end{circuitikz} + \begin{circuitikz} + \draw (0,0) to[R=2<\ohm>, i=?, v=84<\volt>] (2,0) -- + (2,2) to[V<=84<\volt>] (0,2) + -- (0,0); + \end{circuitikz} \end{LTXexample} Feel free to load the package with your own cultural options: \begin{center} -\begin{tabular}{ll}\toprule - \LaTeX & \ConTeXt \\ \midrule - \verb!\usepackage[american]{circuitikz}! & \verb!\usemodule[circuitikz][american]!\\ - \bottomrule -\end{tabular} + \begin{tabular}{ll}\toprule + \LaTeX & \ConTeXt \\ \midrule + \verb!\usepackage[american]{circuitikz}! & \verb!\usemodule[circuitikz][american]!\\ + \bottomrule + \end{tabular} \end{center} \begin{LTXexample}[varwidth=true,linerange={1-1,3-6}] -\begin{circuitikz} - [circuitikz/voltage=american, circuitikz/resistor=american] % line not printed - \draw (0,0) to[R=2<\ohm>, i=?, v=84<\volt>] (2,0) -- - (2,2) to[V<=84<\volt>] (0,2) - -- (0,0); -\end{circuitikz} + \begin{circuitikz} + [circuitikz/voltage=american, circuitikz/resistor=american] % line not printed + \draw (0,0) to[R=2<\ohm>, i=?, v=84<\volt>] (2,0) -- + (2,2) to[V<=84<\volt>] (0,2) + -- (0,0); + \end{circuitikz} \end{LTXexample} \medskip{} \noindent Here is the list of all the options: -\begin{itemize} - \item \texttt{europeanvoltages}: uses arrows to define voltages, and uses european-style voltage sources; - \item \texttt{straightvoltages}: uses arrows to define voltages, and and uses straight voltage arrows; - \item \texttt{americanvoltages}: uses $-$ and $+$ to define voltages, and uses american-style voltage sources; - \item \texttt{europeancurrents}: uses european-style current sources; - \item \texttt{americancurrents}: uses american-style current sources; - \item \texttt{europeanresistors}: uses rectangular empty shape for resistors, as per european standards; - \item \texttt{americanresistors}: uses zig-zag shape for resistors, as per american standards; - \item \texttt{europeaninductors}: uses rectangular filled shape for inductors, as per european standards; - \item \texttt{americaninductors}: uses "4-bumps" shape for inductors, as per american standards; - \item \texttt{cuteinductors}: uses my personal favorite, "pig-tailed" shape for inductors; - \item \texttt{americanports}: uses triangular logic ports, as per american standards; - \item \texttt{europeanports}: uses rectangular logic ports, as per european standards; - \item \texttt{americangfsurgearrester}: uses round gas filled surge arresters, as per american standards; - \item \texttt{europeangfsurgearrester}: uses rectangular gas filled surge arresters, as per european standards; - \item \texttt{european}: equivalent to \texttt{europeancurrents}, \texttt{europeanvoltages}, \texttt{europeanresistors}, \texttt{europeaninductors}, \texttt{europeanports}, \texttt{europeangfsurgearrester}; - \item \texttt{american}: equivalent to \texttt{americancurrents}, \texttt{americanvoltages}, \texttt{americanresistors}, \texttt{americaninductors}, \texttt{americanports}, \texttt{americangfsurgearrester}; - \item \texttt{siunitx}: integrates with \texttt{SIunitx} package. If labels, currents or voltages are of the form \verb!#1<#2>! then what is shown is actually \verb!\SI{#1}{#2}!; - \item \texttt{nosiunitx}: labels are not interpreted as above; - \item \texttt{fulldiode}: the various diodes are drawn \emph{and} filled by default, i.e. when using styles such as \texttt{diode}, \texttt{D}, \texttt{sD}, \ldots Other diode styles can always be forced with e.g. \texttt{Do}, \texttt{D-}, \ldots - \item \texttt{strokediode}: the various diodes are drawn \emph{and} stroke by default, i.e. when using styles such as \texttt{diode}, \texttt{D}, \texttt{sD}, \ldots Other diode styles can always be forced with e.g. \texttt{Do}, \texttt{D*}, \ldots - \item \texttt{emptydiode}: the various diodes are drawn \emph{but not} filled by default, i.e. when using styles such as \texttt{D}, \texttt{sD}, \ldots Other diode styles can always be forced with e.g. \texttt{Do}, \texttt{D-}, \ldots - \item \texttt{arrowmos}: pmos and nmos have arrows analogous to those of pnp and npn transistors; - \item \texttt{noarrowmos}: pmos and nmos do not have arrows analogous to those of pnp and npn transistors; - \item \texttt{fetbodydiode}: draw the body diode of a FET; - \item \texttt{nofetbodydiode}: do not draw the body diode of a FET; - \item \texttt{fetsolderdot}: draw solderdot at bulk-source junction of some transistors; - \item \texttt{nofetsolderdot}: do not draw solderdot at bulk-source junction of some transistors; - \item \texttt{emptypmoscircle}: the circle at the gate of a pmos transistor gets not filled; - \item \texttt{lazymos}: draws lazy nmos and pmos transistors. Chip designers with huge circuits prefer this notation; - \item \texttt{straightlabels}: labels on bipoles are always printed straight up, i.e.~with horizontal baseline; - \item \texttt{rotatelabels}: labels on bipoles are always printed aligned along the bipole; - \item \texttt{smartlabels}: labels on bipoles are rotated along the bipoles, unless the rotation is very close to multiples of 90°; - \item \texttt{compatibility}: makes it possibile to load \Circuitikz\ and \TikZ\ circuit library together. - \item \texttt{oldvoltagedirection}: Use old(erronous) way of voltage direction having a difference between european and american direction - \item \texttt{betterproportions}\footnote{May change in the future!}: nicer proportions of transistors in comparision to resistors; -\end{itemize} - -The old options in the singular (like \texttt{american voltage}) are still available for compatibility, but are discouraged. - -\medskip - -Loading the package with no options is equivalent to my own personal liking, that is to the following options:\\ - \texttt{[nofetsolderdot,nooldvoltagedirection,europeancurrents,europeanvoltages,americanports,americanresistors,cuteinductors,europeangfsurgearrester,nosiunitx,noarrowmos,smartlabels,nocompatibility]}. - -\medskip - -In \ConTeXt\ the options are similarly specified: \texttt{current=european|american}, \texttt{voltage=european|american}, \texttt{resistor=american|european}, \texttt{inductor=cute|american|european}, \texttt{logic=american|european}, \texttt{siunitx=true|false}, \texttt{arrowmos=false|true}. - +{\sloppy % for the big lists of \texttt here + \begin{itemize} + \item \texttt{europeanvoltages}: uses arrows to define voltages, and uses european-style voltage sources; + \item \texttt{straightvoltages}: uses arrows to define voltages, and and uses straight voltage arrows; + \item \texttt{americanvoltages}: uses $-$ and $+$ to define voltages, and uses american-style voltage sources; + \item \texttt{europeancurrents}: uses european-style current sources; + \item \texttt{americancurrents}: uses american-style current sources; + \item \texttt{europeanresistors}: uses rectangular empty shape for resistors, as per european standards; + \item \texttt{americanresistors}: uses zig-zag shape for resistors, as per american standards; + \item \texttt{europeaninductors}: uses rectangular filled shape for inductors, as per european standards; + \item \texttt{americaninductors}: uses "4-bumps" shape for inductors, as per american standards; + \item \texttt{cuteinductors}: uses my personal favorite, "pig-tailed" shape for inductors; + \item \texttt{americanports}: uses triangular logic ports, as per american standards; + \item \texttt{europeanports}: uses rectangular logic ports, as per european standards; + \item \texttt{americangfsurgearrester}: uses round gas filled surge arresters, as per american standards; + \item \texttt{europeangfsurgearrester}: uses rectangular gas filled surge arresters, as per european standards; + \item \texttt{european}: equivalent to \texttt{europeancurrents}, \texttt{europeanvoltages}, \texttt{europeanresistors}, \texttt{europeaninductors}, \texttt{europeanports}, \texttt{europeangfsurgearrester}; + \item \texttt{american}: equivalent to \texttt{americancurrents}, \texttt{americanvoltages}, \texttt{americanresistors}, \texttt{americaninductors}, \texttt{americanports}, \texttt{americangfsurgearrester}; + \item \texttt{siunitx}: integrates with \texttt{SIunitx} package. If labels, currents or voltages are of the form \verb!#1<#2>! then what is shown is actually \verb!\SI{#1}{#2}!; + \item \texttt{nosiunitx}: labels are not interpreted as above; + \item \texttt{fulldiode}: the various diodes are drawn \emph{and} filled by default, i.e. when using styles such as \texttt{diode}, \texttt{D}, \texttt{sD}, \ldots Other diode styles can always be forced with e.g. \texttt{Do}, \texttt{D-}, \ldots + \item \texttt{strokediode}: the various diodes are drawn \emph{and} stroke by default, i.e. when using styles such as \texttt{diode}, \texttt{D}, \texttt{sD}, \ldots Other diode styles can always be forced with e.g. \texttt{Do}, \texttt{D*}, \ldots + \item \texttt{emptydiode}: the various diodes are drawn \emph{but not} filled by default, i.e. when using styles such as \texttt{D}, \texttt{sD}, \ldots Other diode styles can always be forced with e.g. \texttt{Do}, \texttt{D-}, \ldots + \item \texttt{arrowmos}: pmos and nmos have arrows analogous to those of pnp and npn transistors; + \item \texttt{noarrowmos}: pmos and nmos do not have arrows analogous to those of pnp and npn transistors; + \item \texttt{fetbodydiode}: draw the body diode of a FET; + \item \texttt{nofetbodydiode}: do not draw the body diode of a FET; + \item \texttt{fetsolderdot}: draw solderdot at bulk-source junction of some transistors; + \item \texttt{nofetsolderdot}: do not draw solderdot at bulk-source junction of some transistors; + \item \texttt{emptypmoscircle}: the circle at the gate of a pmos transistor gets not filled; + \item \texttt{lazymos}: draws lazy nmos and pmos transistors. Chip designers with huge circuits prefer this notation; + \item \texttt{straightlabels}: labels on bipoles are always printed straight up, i.e.~with horizontal baseline; + \item \texttt{rotatelabels}: labels on bipoles are always printed aligned along the bipole; + \item \texttt{smartlabels}: labels on bipoles are rotated along the bipoles, unless the rotation is very close to multiples of 90°; + \item \texttt{compatibility}: makes it possibile to load \Circuitikz\ and \TikZ\ circuit library together. + \item Voltage directions: until v0.8.3, there was an error in the coherence between american and european voltages styles (see section~\ref{curr-and-volt} for the batteries. This has been fixed, but to guarantee backward compatibility and nasty surprises, the fix is available with new options: + \begin{itemize} + \item \texttt{oldvoltagedirection}: Use old way of voltage direction having a difference between european and american direction, with wrong default labelling for batteries; + \item \texttt{nooldvoltagedirection}: The standard from 0.5 onward, utilize the (German?) standard of voltage arrows in the direction of electric fields (without fixing batteries); + \item \texttt{RPvoltages} (meaning Rising Potential voltages): the arrow is in direction of rising potential, like in \texttt{oldvoltagedirections}, but batteries and current sources are fixed to follow the passive/active standard; + \item \texttt{EFvoltages} (meaning Electric Field voltages): the arrow is in direction of the electric field, like in \texttt{nooldvoltagedirections}, but batteries are fixed; + \end{itemize} + If none of these option are given, the package will default to \texttt{nooldvoltagedirections}, but will give a warning. The behavior is also selectable circuit by circuit with the \texttt{voltage dir} style. + \item \texttt{betterproportions}\footnote{May change in the future!}: nicer proportions of transistors in comparision to resistors; + \end{itemize} + + + The old options in the singular (like \texttt{american voltage}) are still available for compatibility, but are discouraged. + + \medskip + + Loading the package with no options is equivalent to the following options: + \texttt{[nofetsolderdot, europeancurrents, europeanvoltages, americanports, + americanresistors, cuteinductors, europeangfsurgearrester, nosiunitx, noarrowmos, + smartlabels, nocompatibility]}. + + \medskip + + In \ConTeXt\ the options are similarly specified: \texttt{current= european|american}, \texttt{voltage= european|american}, \texttt{resistor= american|european}, \texttt{inductor= cute|american|european}, \texttt{logic= american|european}, \texttt{siunitx= true|false}, \texttt{arrowmos= false|true}. + +} %\stop the \sloppy processing + +\section{Tutorials} + +To draw a circuit, you have to load the \texttt{circuitikz} package; this can be done with +\begin{lstlisting} + \usepackage[siunitx, RPvoltages]{circuitikz} +\end{lstlisting} +somewhere in your document preamble. It will load automatically the needed packages if not already done before. + +\subsection{Getting started with \Circuitikz: a current shunt} + +Let's say we want to prepare a circuit to teach how a current shunt works; the idea is just draw a current generator, a couple of resistors in parallel, and the indication of currents and voltages for the discussion. + +A circuit in \Circuitikz is drawn into a \texttt{circuitikz} environment (which is really an alias for a \texttt{tikzpicture} one). In this first example we will use absolute coordinates. +The electrical components can be divided in two big categories: the one that are bipoles and are placed along a path (also known as \texttt{to}-style component, for their usage) and components that are nodes and can have any number of poles, or connections. + +Let's start with the first type of components and build a basic mesh: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[] + \draw (0,0) to[isource] (0,3) -- (2,3) + to[R] (2,0) -- (0,0); +\end{circuitikz} +\end{LTXexample} + +The symbol for the current source can surprise somebody; this is actually the european-style symbol, and the symbols chosen reflects the default options of loaded in the package (see section~\ref{sec:package-options}). Let's change the style for now (the author of the tutorial, Romano, is European but he has used since ever American style circuit, so\dots); and while at it, let add the other branch and some label. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) to[isource, l=$I_0$] (0,3) -- (2,3) + to[R=$R_1$] (2,0) -- (0,0); + \draw (2,3) -- (4,3) to[R=$R_2$] + (4,0) -- (2,0); +\end{circuitikz} +\end{LTXexample} + +You can use a single path or multiple path when drawing your circuit, it's just a question of style (but be aware that closing path could be non-trivial, see section~\ref{sec:line-joins}), and you can use standard \TikZ\ lines (\verb|--|, \verb+|-+ or similar) for the wires. Nonetheless, sometime using the \Circuitikz\ specific \texttt{short} component for the wires can be useful, because then we can add labels and nodes at it, like for example in the following circuit. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) to[isource, l=$I_0$] (0,3) + to[short, -*, i=$I_0$] (2,3) + to[R=$R_1$, i=$i_1$] (2,0) -- (0,0); + \draw (2,3) -- (4,3) + to[R=$R_2$, i=$i_2$] + (4,0) to[short, -*] (2,0); +\end{circuitikz} +\end{LTXexample} + +One of the problems with this circuit is that we would like to have the current in a different position, such as for example on the upper side of the resistors, so that Kirchoff's Current Law at the node is better shown to students. No problem; as you can see in section~\ref{curr-and-volt} you can use the position specifier \verb|<>^_}| after the key \texttt{i}: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) to[isource, l=$I_0$] (0,3) + to[short, -*, i=$I_0$] (2,3) + to[R=$R_1$, i>_=$i_1$] (2,0) -- (0,0); + \draw (2,3) -- (4,3) + to[R=$R_2$, i>_=$i_2$] + (4,0) to[short, -*] (2,0); +\end{circuitikz} +\end{LTXexample} + +Finally, we would like to add voltages indication for carrying out the current formulas; as the default position of the voltage signs seems a bit cramped to me, I am adding the \texttt{voltage shift} parameter to make a bit more space for it\dots + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american, voltage shift=0.5] + \draw (0,0) to[isource, l=$I_0$, v=$V_0$] (0,3) + to[short, -*, i=$I_0$] (2,3) + to[R=$R_1$, i>_=$i_1$] (2,0) -- (0,0); + \draw (2,3) -- (4,3) + to[R=$R_2$, i>_=$i_2$] + (4,0) to[short, -*] (2,0); +\end{circuitikz} +\end{LTXexample} + +\emph{Et voilá!}. Remember that this is still \LaTeX, which means that you have done a description of your circuit, which is, in a lot of way, independent of the visualization of it. If you ever have to adapt the circuit to, say, a journal that force European style and flows instead of currents, you just change a couple of things and you have what seems a completely different diagram: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[european, voltage shift=0.5] + \draw (0,0) to[isourceC, l=$I_0$, v=$V_0$] (0,3) + to[short, -*, f=$I_0$] (2,3) + to[R=$R_1$, f>_=$i_1$] (2,0) -- (0,0); + \draw (2,3) -- (4,3) + to[R=$R_2$, f>_=$i_2$] + (4,0) to[short, -*] (2,0); +\end{circuitikz} +\end{LTXexample} + +And finally, this is still \TikZ, so that you can freely mix other graphics element to the circuit. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american, voltage shift=0.5] + \draw (0,0) to[isource, l=$I_0$, v=$V_0$] (0,3) + to[short, -*, f=$I_0$] (2,3) + to[R=$R_1$, f>_=$i_1$] (2,0) -- (0,0); + \draw (2,3) -- (4,3) + to[R=$R_2$, f>_=$i_2$] + (4,0) to[short, -*] (2,0); + \draw[red, thick] (1.5,2.5) rectangle (4.5,3.5) + node[pos=0.5, above]{KCL}; +\end{circuitikz} +\end{LTXexample} + +\subsection{A more complex tutorial: circuits Romano's style.} +\begingroup % do not propagate to the rest of the manual + +The idea is to draw a two-stage amplifier for a lesson, or exercise, on the different qualities of BJT an MOSFET transistors. +Notice that this is a more ``personal'' tutorial, showing a way to draw circuits that is, in the author's opinion, highly reusable and easy to do. +The idea is using relative coordinates and named nodes as much as possible, so that changes in the circuit are easily done by changing keys numbers of position, and crucially, each block is reusable in other diagrams. + +First of all, let's define a handy function to show the position of nodes: + +\def\coord(#1){node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\tiny, pin distance=0.1cm, pin edge={red, overlay,}]45:#1}](#1){}} +\begin{lstlisting} +\def\coord(#1){coordinate(#1)} +\def\coord(#1){node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\tiny, pin distance=0.1cm, pin edge={red, overlay,}]45:#1}](#1){}} +\end{lstlisting} + + + +The idea is that you can use \verb|\coord()| instead of \verb|coordinate()| in paths, and that will draw sort of \emph{markers} showing them. For example: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american,] + \draw (0,0) node[npn](Q){}; + \path (Q.center) \coord(center) + (Q.B) \coord(B) (Q.C) \coord(C) + (Q.E) \coord(E); +\end{circuitikz} +\end{LTXexample} + +After the circuit is drawn, simply commenting out the second definition of \verb|\coord| will hide all the markers. + +So let's start with the first stage transistor; given that my preferred way of drawing a MOSFET is with arrows, I'll start issuing the command \verb|\ctikzset{tripoles/mos style/arrows}|: + +\ctikzset{tripoles/mos style/arrows} +\def\killdepth#1{{\raisebox{0pt}[\height][0pt]{#1}}} +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american,] +\ctikzset{tripoles/mos style/arrows} +\def\killdepth#1{{\raisebox{0pt}[\height][0pt]{#1}}} + \draw (0,0) node[nmos](Q1){}; + \draw (Q1.center) node[right]{\killdepth{Q1}}; +\end{circuitikz} +\end{LTXexample} + +Another thing I like to modify with respect to the standard is the position of the arrows in transistors, which are normally midway the symbol. Issuing the following settings will move the arrows to the end or start of the corresponding pin. + +\ctikzset{tripoles/mos style/arrows, +tripoles/npn/arrow pos=0.8, +tripoles/pnp/arrow pos=0.8, +tripoles/nmos/arrow pos=0.8, +tripoles/pmos/arrow pos=0.6, } +\begin{lstlisting} +\ctikzset{tripoles/mos style/arrows, +tripoles/npn/arrow pos=0.8, +tripoles/pnp/arrow pos=0.8, +tripoles/nmos/arrow pos=0.8, +tripoles/pmos/arrow pos=0.6, } +\end{lstlisting} + +The tricky thing about \verb|\killdepth{}| macro is a finicky details; I do not like the standard position of labels on transistors (which is near the collector/drain) so I plot the label at the right of the \texttt{center} anchor. Without the \verb|\killdepth| macro, the labels of different transistor will be adjusted so that the center of the box is at the \texttt{center} anchor, and as an effect, labels with descenders (like Q) will have a different baseline than labels without. You can see this here (it's really subtle): + + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american,] +\draw (0,0) node[nmos](Q1){} ++(2,0) node[nmos](M1){}; +\draw (Q1.center) node[right]{q1}; +\draw (M1.center) node[right]{m1}; +\draw [red] (Q1.center) ++(0,-0.7ex) -- ++(3,0); +\draw (0,-2)node[nmos](Q1){} ++(2,0) node[nmos](M1){}; +\draw (Q1.center) node[right]{\killdepth{q1}}; +\draw (M1.center) node[right]{\killdepth{m1}}; +\draw [red] (Q1.center) ++(0,-0.7ex) -- ++(3,0); +\end{circuitikz} +\end{LTXexample} + +We will start connecting the first transistor with the power supply with a couple of resistors. Notice that I am naming the nodes \texttt{GND}, \texttt{VCC} and \texttt{VEE}, so that I can use the coordinates to have all the supply rails at the same vertical position (more on this later). + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american,] + \draw (0,0) node[nmos,](Q1){}; + \draw (Q1.center) node[right]{\killdepth{Q1}}; + \draw (Q1.S) to[R, l2^=$R_S$ and \SI{5}{k\ohm}] ++(0,-3) + node[vee](VEE){$V_{EE}=\SI{-10}{V}$}; + \draw (Q1.D) to[R, l2_=$R_D$ and \SI{10}{k\ohm}] ++(0,3) + node[vcc](VCC){$V_{CC}=\SI{10}{V}$}; + \draw (Q1.S) to[short] ++(2,0) to[C=$C_1$] ++(0,-1.5) node[ground](GND){}; + \path (GND) \coord(GND) (VCC) \coord(VCC) + (VEE) \coord(VEE); +\end{circuitikz} +\end{LTXexample} + +After that, let's add the input part. I will use a named node here, to refer to it to add the input source. Notice how the ground node is positioned: the coordinate \texttt{(in |- GND)} is the point with the horizontal coordinate of \texttt{(in)} and the horizontal one of \texttt{(GND)}, lining it up with the ground of the capacitor $C_1$. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american, scale=0.7] + \draw (0,0) node[nmos,](Q1){}; + \draw (Q1.center) node[right] + {\killdepth{Q1}}; + \draw (Q1.S) to[R, l2^=$R_S$ and \SI{5}{k\ohm}] ++(0,-3) + node[vee](VEE){$V_{EE}=\SI{-10}{V}$}; + \draw (Q1.D) to[R, l2_=$R_D$ and \SI{10}{k\ohm}] ++(0,3) + node[vcc](VCC){$V_{CC}=\SI{10}{V}$}; + \draw (Q1.S) to[short] ++(2,0) to[C=$C_1$] ++(0,-1.5) node[ground](GND){}; + \draw (Q1.G) to[short] ++(-1,0) + \coord (in) to[R, l2^=$R_G$ and \SI{1}{M\ohm}] + (in |- GND) node[ground]{}; + \draw (in) to[C, l_=$C_2$,*-o] ++(-1.5,0) node[left](vi1){$v_i=v_{i1}$}; +\end{circuitikz} +\end{LTXexample} + +Notice that the only absolute coordinate here is the first one, \texttt{(0,0)}; so the elements are connected with relative movements and can be moved by just changing one number (for example, changing the \verb| to[C=$C_1$] ++(0,-1.5) | will move \emph{all} the grounds down). + +This is the final circuit, with the nodes still marked: +\begin{lstlisting} +\tikzset{blockdef/.style={% + {Straight Barb[harpoon, reversed, right, length=0.2cm]}-{Straight Barb[harpoon, reversed, left, length=0.2cm]}, + blue, %densely dotted, +}} +\def\killdepth#1{{\raisebox{0pt}[\height][0pt]{#1}}} +\def\coord(#1){coordinate(#1)} +\def\coord(#1){node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\tiny, pin distance=0.1cm, pin edge={red, overlay,}]45:#1}](#1){}} +\begin{circuitikz}[american, ] + \draw (0,0) node[nmos,](Q1){}; + \draw (Q1.center) node[right]{\killdepth{Q1}}; + \draw (Q1.S) to[R, l2^=$R_S$ and \SI{5}{k\ohm}] ++(0,-3) node[vee](VEE){$V_{EE}=\SI{-10}{V}$}; %define VEE level + \draw (Q1.S) to[short] ++(2,0) to[C=$C_1$] ++(0,-1.5) node[ground](GND){}; + \draw (Q1.G) to[short] ++(-1,0) \coord (in) to[R, l2^=$R_G$ and \SI{1}{M\ohm}] (in |- GND) node[ground]{}; + \draw (in) to[C, l_=$C_2$,*-o] ++(-1.5,0) node[left](vi1){$v_i=v_{i1}$}; + \draw (Q1.D) to[R, l2_=$R_D$ and \SI{10}{k\ohm}] ++(0,3) node[vcc](VCC){$V_{CC}=\SI{10}{V}$}; + \draw (Q1.D) to[short, -o] ++(1,0) node[right](vo1){$v_{o1}$}; + % + \path (vo1) -- ++(3,0) \coord(bjt); + % + \draw (bjt) node[npn, ](Q2){}; + \draw (Q2.center) node[right]{\killdepth{Q2}}; + \draw (Q2.B) to[short, -o] ++(-0.5,0) node[left](vi2){$v_{12}$}; + \draw (Q2.E) to[R,l2^=$R_E$ and \SI{9.3}{k\ohm}] (Q2.E |- VEE) node[vee]{}; + \draw (Q2.E) to[short, -o] ++(1,0) node[right](vo2){$v_{o2}$}; + \draw (Q2.C) to[short] (Q2.C |- VCC) node[vcc]{}; + % + \path (vo2) ++(1.5,0) \coord(load); + \draw (load) to[C=$C_3$] ++(1,0) \coord(tmp) to[R=$R_L$] (tmp |- GND) node[ground]{}; + \draw [densely dashed] (vo2) -- (load); + % + \draw [densely dashed] (vo1) -- (vi2); + % + \draw [blockdef](vi1|-VEE) ++(0,-2) \coord(tmp) + -- node[midway, fill=white]{bloque 1} (vo1|- tmp); + \draw [blockdef] (vi2|-VEE) ++(0,-2) \coord(tmp) + -- node[midway, fill=white]{bloque 2} (vo2|- tmp); + +\end{circuitikz} +\end{lstlisting} + +\tikzset{blockdef/.style={% + {Straight Barb[harpoon, reversed, right, length=0.2cm]}-{Straight Barb[harpoon, reversed, left, length=0.2cm]}, + blue, %densely dotted, +}} +\def\killdepth#1{{\raisebox{0pt}[\height][0pt]{#1}}} +\def\coord(#1){coordinate(#1)} +\def\coord(#1){node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\tiny, pin distance=0.1cm, pin edge={red, overlay,}]45:#1}](#1){}} +\begin{circuitikz}[american, ] + \draw (0,0) node[nmos,](Q1){}; + \draw (Q1.center) node[right]{\killdepth{Q1}}; + \draw (Q1.S) to[R, l2^=$R_S$ and \SI{5}{k\ohm}] ++(0,-3) node[vee](VEE){$V_{EE}=\SI{-10}{V}$}; %define VEE level + \draw (Q1.S) to[short] ++(2,0) to[C=$C_1$] ++(0,-1.5) node[ground](GND){}; + \draw (Q1.G) to[short] ++(-1,0) \coord (in) to[R, l2^=$R_G$ and \SI{1}{M\ohm}] (in |- GND) node[ground]{}; + \draw (in) to[C, l_=$C_2$,*-o] ++(-1.5,0) node[left](vi1){$v_i=v_{i1}$}; + \draw (Q1.D) to[R, l2_=$R_D$ and \SI{10}{k\ohm}] ++(0,3) node[vcc](VCC){$V_{CC}=\SI{10}{V}$}; + \draw (Q1.D) to[short, -o] ++(1,0) node[right](vo1){$v_{o1}$}; + % + \path (vo1) -- ++(3,0) \coord(bjt); + % + \draw (bjt) node[npn, ](Q2){}; + \draw (Q2.center) node[right]{\killdepth{Q2}}; + \draw (Q2.B) to[short, -o] ++(-0.5,0) node[left](vi2){$v_{12}$}; + \draw (Q2.E) to[R,l2^=$R_E$ and \SI{9.3}{k\ohm}] (Q2.E |- VEE) node[vee]{}; + \draw (Q2.E) to[short, -o] ++(1,0) node[right](vo2){$v_{o2}$}; + \draw (Q2.C) to[short] (Q2.C |- VCC) node[vcc]{}; + % + \path (vo2) ++(1.5,0) \coord(load); + \draw (load) to[C=$C_3$] ++(1,0) \coord(tmp) to[R=$R_L$] (tmp |- GND) node[ground]{}; + \draw [densely dashed] (vo2) -- (load); + % + \draw [densely dashed] (vo1) -- (vi2); + % + \draw [blockdef](vi1|-VEE) ++(0,-2) \coord(tmp) + -- node[midway, fill=white]{bloque 1} (vo1|- tmp); + \draw [blockdef] (vi2|-VEE) ++(0,-2) \coord(tmp) + -- node[midway, fill=white]{bloque 2} (vo2|- tmp); + +\end{circuitikz} + + +\endgroup + + + \section{The components} -Here follows the list of all the shapes defined by Circui\TikZ. These are all \texttt{pgf} nodes, so they are usable in both \texttt{pgf} and \TikZ. -\subsubsection*{Drawing normal components} -Normal components (monopoles, multipoles) can be drawn at a specified point with this syntax, where \verb!#1! is the name of the component: -\begin{verbatim} -\begin{center}\begin{circuitikz} \draw - (0,0) node[#1,#2] (#3) {#4} -; \end{circuitikz} \end{center} -\end{verbatim} +Components in \Circuitikz{} come in two forms: a path-style form, to be used in \texttt{to} path specifications, and node-style, which will be instantiated by a \texttt{node} specification. + +\subsection{Path-style components} + +The path-style components are used as in the following way: +\begin{lstlisting} + \begin{circuitikz} + \draw (0,0) to[#1=#2, #options] (2,0); + \end{circuitikz} +\end{lstlisting} +where \verb|#1| is the name of the component, \verb|#2| is an (optional) label, and \verb|options| are optional labels, annotations, style specifier that will be explained in the rest of the manual. + +Transistors and some other node-style components can also be placed using the syntax for bipoles. See section~\ref{sec:transasbip}. + +Most path-style components can be used as a node-style components; to access them, you add a \texttt{shape} to the main name of component (for example, \texttt{diodeshape}). Such a ``node name'' is specified in the description of each component. + +\subsubsection{Anchors} + +Normally, path-style component do not need anchors, although they have them just in case you need them. You have the basic ``geographical'' anchors (bipoles are defined horizontally and then rotate as needed): +\begin{center} + \begin{circuitikz}[ + ] + \draw (0,0) to[resistor, name=R] ++(2,0); + \path (R.center) \showcoord(center)<-90:0.3>; + \path (R.left) \showcoord(left)<135:0.3>; + \path (R.right) \showcoord(right)<45:0.3>; + \draw (5,0) to[resistor, name=R] ++(2,0); + \foreach \n/\a/\d in {north/90/0.3, north east/45/0.3, east/0/0.5, + south east/-45/0.3, south/-90/0.3, south west/-135/0.3, + west/180/0.5, north west/135/0.3} + \path (R.\n) \showcoord(\n)<\a:\d>; + \draw (10,-1) to[resistor, name=R] ++(0,2); + \foreach \n/\a/\d in {n/135/0.3, e/45/0.3, + s/-45/0.3, w/-135/0.3} + \path (R.\n) \showcoord(\n)<\a:\d>; + \end{circuitikz} +\end{center} +In the case of bipoles, also shortened geographical anchors exists. In the description, it will be shown when a bipole has additional anchors. To use the anchors, just give a name to the bipole element. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) to[potentiometer, name=P, mirror] ++(0,2); + \draw (P.wiper) to[L] ++(2,0); +\end{circuitikz} +\end{LTXexample} + +Alternatively, that you can use the shape form, and then use the \texttt{left} and \texttt{right} anchors to do your connections. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) node[potentiometershape, rotate=-90](P){}; + \draw (P.wiper) to[L] ++(2,0); +\end{circuitikz} +\end{LTXexample} + +\subsubsection{Customization} +\label{sec:components-size} + + +Pretty much all Circui\TikZ\ relies heavily on \texttt{pgfkeys} for value handling and configuration. Indeed, at the beginning of \texttt{circuitikz.sty} and in the file \texttt{pfgcirc.define.tex} a series of key definitions can be found that modify all the graphical characteristics of the package. + +All can be varied using the \verb!\ctikzset! command, anywhere in the code. + +\paragraph{Components size} +Perhaps the most important parameter is \texttt{bipoles/length} (default \SI{1.4}{cm}), which +can be interpreted as the length of a resistor (including reasonable connections): all other lengths are relative to this value. For instance: + +\begin{LTXexample}[pos=t,varwidth=true] +\ctikzset{bipoles/length=1.4cm} +\begin{circuitikz}[scale=1.2]\draw + (0,0) node[anchor=east] {B} + to[short, o-*] (1,0) + to[R=20<\ohm>, *-*] (1,2) + to[R=10<\ohm>, v=$v_x$] (3,2) -- (4,2) + to[cI=$\frac{\si{\siemens}}{5} v_x$, *-*] (4,0) -- (3,0) + to[R=5<\ohm>, *-*] (3,2) + (3,0) -- (1,0) + (1,2) to[short, -o] (0,2) node[anchor=east]{A} +;\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[pos=t,varwidth=true] +\ctikzset{bipoles/length=.8cm} +\begin{circuitikz}[scale=1.2]\draw + (0,0) node[anchor=east] {B} + to[short, o-*] (1,0) + to[R=20<\ohm>, *-*] (1,2) + to[R=10<\ohm>, v=$v_x$] (3,2) -- (4,2) + to[cI=$\frac{\siemens}{5} v_x$, *-*] (4,0) -- (3,0) + to[R=5<\ohm>, *-*] (3,2) + (3,0) -- (1,0) + (1,2) to[short, -o] (0,2) node[anchor=east]{A} +;\end{circuitikz} +\end{LTXexample} + +\paragraph{Thickness of the lines} (globally) + +You can change the thickness of the components lines with the parameter \texttt{bipoles/thickness} (default 2). The number is relative to the thickness of the normal lines leading to the component. + +\begin{LTXexample}[varwidth=true] + \ctikzset{bipoles/thickness=1} + \tikz \draw (0,0) to[C=1<\farad>] (2,0); \par + \ctikzset{bipoles/thickness=4} + \tikz \draw (0,0) to[C=1<\farad>] (2,0); +\end{LTXexample} + +\paragraph{Shape of the components} (on a per-component-class basis) + +The shape of the components are adjustable with a lot of parameters; in this manual we will comment the main ones, but you can look into the source files specified above to find more. +\begin{LTXexample}[varwidth=true] + \tikz \draw (0,0) to[R=1<\ohm>] (2,0); \par + \ctikzset{bipoles/resistor/height=.6} + \tikz \draw (0,0) to[R=1<\ohm>] (2,0); +\end{LTXexample} + + +\subsubsection{Descriptions} + +The typical entry in the component list will be like this: + +\begin{groupdesc} + \circuitdescbip{resistor}{resistor, american style}{R, american resistor} + \circuitdescbip[potentiometer]{pR}{potentiometer, american style}{pR, american potentiometer}( wiper/0/0.3 ) +\end{groupdesc} + +where you have all the needed information about the bipole, with also no-standard anchors. If the component can be filled it will be specified in the description. In addition, as an example, the component shown will be filled with the option \texttt{fill=cyan!30!white}: + +\begin{groupdesc} + \circuitdescbip*{ammeter}{Ammeter}{} +\end{groupdesc} + +\subsection{Node-style components} +Node-style components (monopoles, multipoles) can be drawn at a specified point with this syntax, where \verb!#1! is the name of the component: +\begin{lstlisting} +\begin{circuitikz} + \draw (0,0) node[#1,#2] (#3) {#4}; +\end{circuitikz} +\end{lstlisting} \noindent Explanation of the parameters:\\ \texttt{\#1}: component name\footnote{For using bipoles as nodes, the name of the node is \texttt{\#1shape}.} (mandatory)\\ @@ -254,211 +752,430 @@ Explanation of the parameters:\\ \texttt{\#3}: name of an anchor (optional)\\ \texttt{\#4}: text written to the text anchor of the component (optional)\\ +Most path-style components can be used as a node-style components; to access them, you add a \texttt{shape} to the main name of component (for example, \texttt{diodeshape}). Such a ``node name'' is specified in the description of each component. + \begin{framed} - \noindent \textbf{Note for \TikZ\ newbies:} Nodes must have curly brackets at the end, even when empty. An optional anchor (\texttt{\#3}) can be defined within round brackets to be addressed again later on. And please don't forget the semicolon to terminate the \texttt{\textbackslash draw} command. + \noindent \textbf{Notice:} Nodes must have curly brackets at the end, even when empty. An optional anchor (\texttt{\#3}) can be defined within round brackets to be addressed again later on. And please don't forget the semicolon to terminate the \texttt{\textbackslash draw} command. \end{framed} -\subsubsection*{Drawing bipoles/two-ports} -Bipoles/Two-ports (plus some special components) can be drawn between two points using the following command: - -\begin{verbatim} -\begin{center}\begin{circuitikz} \draw - (0,0) to[#1,#2] (2,0) -; \end{circuitikz} \end{center} -\end{verbatim} -\noindent -Explanation of the parameters:\\ -\texttt{\#1}: component name (mandatory)\\ -\texttt{\#2}: list of comma separated options (optional)\\ -\noindent -Transistors and some other components can also be placed using the syntax for bipoles. See section~\ref{sec:transasbip}. - \begin{framed} - If using the \verb!\tikzexternalize! feature, as of Ti\emph{k}z 2.1 all pictures must end with \verb!\end{tikzpicture}!. Thus you \emph{cannot} use the \verb!circuitikz! environment. - - Which is ok: just use the environment \verb!tikzpicture!: everything will work there just fine. + \noindent\textbf{Also notice:} If using the \verb!\tikzexternalize! feature, as of Ti\emph{k}z 2.1 all pictures must end with \verb!\end{tikzpicture}!. Thus you \emph{cannot} use the \verb!circuitikz! environment. + + \noindent Which is ok: just use the environment \verb!tikzpicture!: everything will work there just fine. \end{framed} -\subsection{Monopoles} -\begin{itemize} - \circuititem{ground}{Ground}{} - \circuititem{rground}{Reference ground}{} - \circuititem{sground}{Signal ground}{} - \circuititem{tground}{Thicker ground}{} - \circuititem{nground}{Noiseless ground}{} - \circuititem{pground}{Protective ground}{} - \circuititem{cground}{Chassis ground\footnote{These last three were contributed by Luigi «Liverpool»)}}{} - \circuititem{antenna}{Antenna}{} - \circuititem{rxantenna}{Receiving antenna}{} - \circuititem{txantenna}{Transmitting antenna}{} - \circuititem{tlinestub}{Transmission line stub}{} - \circuititem{vcc}{VCC/VDD}{} - \circuititem{vee}{VEE/VSS}{} - \circuititem{match}{match}{} - %\circuititem{oscillator}{LO\footnote{These last three come from Stefan Erhardt's contribution of block diagram components}}{} -\end{itemize} +\subsubsection{Mirroring and flipping} + +Mirroring and flipping of node components is obtained by using the \TikZ\ keys \texttt{xscale} and \texttt{yscale}. Notice that this parameters affect also text labels, so they need to be un-scaled by hand. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,2) + node[rground, yscale=-1] {% + \scalebox{1}[-1]{ GND}} + to[R=$R_1$] (0,0) + node[sground] {}; +\end{circuitikz} +\end{LTXexample} +\subsubsection{Anchors} -\subsection{Bipoles} +Node components anchors are variable across the various kind of components, so they will described better after each category is presented in the manual. -\subsubsection{Instruments} -\begin{itemize} - \circuititembip{ammeter}{Ammeter}{} - \circuititembip{voltmeter}{Voltmeter}{} - \circuititembip{ohmmeter}{Ohmmeter}{} -\end{itemize} +\subsubsection{Descriptions} -\subsubsection{Basic resistive bipoles} -\begin{itemize} - \circuititembip{short}{Short circuit}{} - \circuititembip{open}{Open circuit}{} - - \circuititembip{lamp}{Lamp}{} - \circuititembip{generic}{Generic (symmetric) bipole}{} - \circuititembip{tgeneric}{Tunable generic bipole}{} - \circuititembip{ageneric}{Generic asymmetric bipole}{} - \circuititembip{fullgeneric}{Generic asymmetric bipole (full)}{} - \circuititembip{tfullgeneric}{Tunable generic bipole (full)}{} - \circuititembip{memristor}{Memristor}{Mr} -\end{itemize} - -\subsubsection{Resistors and the like} - -If (default behaviour) \texttt{americanresistors} option is active (or the style \texttt{[american resistors]} is used), the resistor is displayed as follows: -\begin{itemize} - \ctikzset{resistor=american} - \circuititembip{R}{Resistor}{american resistor} - \circuititembip{vR}{Variable resistor}{variable american resistor} - \circuititembip{pR}{Potentiometer}{american potentiometer} -\end{itemize} +The typical entry in the component list will be like this: +\begin{groupdesc} + \circuitdesc{cute spdt down arrow}{Cute spdt down with arrow}{} + \circuitdesc{npn}{\scshape npn}{}( B/180/0.2,C/0/0.2,E/0/0.2 ) +\end{groupdesc} + +All the shapes defined by Circui\TikZ. These are all \texttt{pgf} nodes, so they are usable in both \texttt{pgf} and \TikZ. +If the component can be filled it will be specified in the description. In addition, as an example, the component shown will be filled with the option \texttt{fill=cyan!30!white}: + +\begin{groupdesc} + \circuitdesc*{plain amp}{Plain amplifier}{}( out/45/0.3 ) +\end{groupdesc} + +\subsection{Grounds and supply voltages} + +For the grounds, the \texttt{center} anchor is put on the connecting point of the symbol, so that you can use them directly in a \texttt{path} specification. + +\begin{groupdesc} + \circuitdesc{ground}{Ground}{}( center/0/0.3 ) + \circuitdesc{rground}{Reference ground}{} + \circuitdesc*{sground}{Signal ground}{} + \circuitdesc{tground}{Thicker ground}{} + \circuitdesc{nground}{Noiseless ground}{} + \circuitdesc{pground}{Protective ground}{} + \circuitdesc{cground}{Chassis ground\footnotemark}{} + \footnotetext{These last three were contributed by Luigi «Liverpool»)} + \circuitdesc{eground}{European style ground}{} + \circuitdesc{eground2}{European style ground, version 2\footnotemark}{} + \footnotetext{These last two were contributed by \texttt{@fotesan})} + \circuitdesc{vcc}{VCC/VDD}{} + \circuitdesc{vee}{VEE/VSS}{} +\end{groupdesc} + +\subsubsection{Grounds anchors} + +Anchors for grounds are a bit strange, given that they have the \texttt{center} spot at the same location than \texttt{north} and all the ground will develop ``going down'': + +\showanchors[baseline]{ground, scale=2}{}(north/90/0.4, north east/45/0.4, east/0/0.4, south east/-45/0.4, + south/-90/0.4, south west/-135/0.4, west/180/0.4, north west/135/0.4) +\showanchors[baseline]{ground, scale=2}{}(left/135/0.2, right/45/0.2, center/-180/0.2) + + + +\subsection{Instruments} +\begin{groupdesc} + \circuitdescbip*{ammeter}{Ammeter}{} + \circuitdescbip*{voltmeter}{Voltmeter}{} + \circuitdescbip*{ohmmeter}{Ohmmeter}{} + \circuitdescbip*{rmeter}{Round meter (use \texttt{t=...} for the symbol)}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + \circuitdescbip*{rmeterwa}{Round meter with arrow (use \texttt{t=...} for the symbol)}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + \circuitdescbip*{smeter}{Square meter (use \texttt{t=...} for the symbol)}{}(left/135/0.2, right/45/0.2, center/-90/0.3, in 1/-135/.5, in 2/-45/.5) + \circuitdescbip*{qiprobe}{QUCS-style current probe}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + \circuitdescbip*{qvprobe}{QUCS-style voltage probe}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + \circuitdescbip*{qpprobe}{QUCS-style power probe}{}(left/135/0.2, right/45/0.2, center/-90/0.3, v+/-135/.5, v-/-45/.5) + \circuitdescbip*[oscope]{oscope}{Oscilloscope\footnotemark}{}(left/135/0.2, right/45/0.2, + in 1/-135/0.4, in 2/-45/0.4) + \footnotetext{Suggested by \texttt{@nobrl} on GitHub} + \circuitdescbip{iloop}{Current loop (symbolic)}{}(left/135/0.2, right/45/0.2, center/-90/0.3, i/30/0.4) + \circuitdescbip{iloop2}{Current loop (real)}{}(left/135/0.2, right/-45/0.2, center/-90/0.3, i+/135/0.4, i-/45/0.4) +\end{groupdesc} + +\subsubsection{Rotation-invariant elements} + +The \texttt{oscope} element will not rotate the ``graph'' shown with the component: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \foreach \a in {0,45,...,350} { + \draw (0,0) to[oscope] (\a:3); + } +\end{circuitikz} +\end{LTXexample} + +The \texttt{rmeter}, \texttt{rmaterwa}, and \texttt{smeter} have the same behavior. + +\subsubsection{Instruments as node elements} + +The node-style usage of the \texttt{oscope} is also interesting, using the additional \texttt{in 1} and \texttt{in 2} anchors; notice that in this case you can use the text content of the node to put labels above it. +Moreover, you can change the size of the oscilloscope by changing \texttt{bipoles/oscope/width} and \texttt{bipoles/oscope/height} keys (which both default at 0.6). + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,1) + to[oscope=$C_1$, fill=green!20!gray, name=O1] ++(2,0); + \path (O1.right) + node[ground, scale=0.5, below right=4pt]{}; + \ctikzset{bipoles/oscope/width=1.0} + \draw (1,-1) + node[oscopeshape, fill=yellow!20!orange](O2){$C_2$}; + \draw (O2.in 2) to[short, *-] ++(0,-0.5) node[ground]{}; + \draw (O2.in 1) to[short, *-] ++(0,-0.5) + -- ++(-1,0) node[currarrow, xscale=-1]{}; +\end{circuitikz} +\end{LTXexample} + +\subsubsection{Measuring voltage and currents, multiple ways} + +This is the classical (legacy) option, with the \texttt{voltmeter} and \texttt{ammeter}. The problem is that elements are intrinsically horizontal and so they looks funny if put in vertical way. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [ammeter] ++(0,-2) node[ground]{}; + \draw (1,0) to[voltmeter] ++(0,-2) + node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +So the solution is often changing the structure to keep the meters in horizontal position. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [ammeter] ++(2,0) -- + ++(0,-1) node[ground]{}; + \draw (1,0) -- (1,1) to[voltmeter] + ++(2,0) node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +Since version 0.9.0 you have more options for the measuring instruments. You can use the generic \texttt{rmeterwa} (round meter with arrow), to which you can specify the internal symbol with the option \texttt{t=...} (and is fillable). + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [rmeterwa, t=A, i=$i$] ++(0,-2) node[ground]{}; + \draw (1,0) to[rmeterwa, t=V, v=$v$] ++(0,-2) + node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +This kind of component will maintain the symbol horizontal whatever the orientation: + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [rmeterwa, t=A, i=$i$] ++(2,0) -- + ++(0,-1) node[ground]{}; + \draw (1,0) -- (1,1) to[rmeterwa, t=V, v^=$v$] + ++(2,0) node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +The plain \texttt{rmeter} is the same, without the measuring arrow: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [rmeter, t=A, i=$i$] ++(0,-2) node[ground]{}; + \draw (1,0) to[rmeter, t=V, v=$v$] ++(0,-2) + node[ground]{}; +\end{circuitikz} +\end{LTXexample} + + +If you prefer, you have the option to use square meters, to have more visual difference from generators: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [smeter, t=A, i=$i$] ++(0,-2) node[ground]{}; + \draw (1,0) to[smeter, t=V, v=$v$] ++(0,-2) + node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +Another possibility is to use the QUCS\footnote{QUCS is an open source circuit simulator: \url{http://qucs.sourceforge.net/}}-styled probes, which have the nice property of explictly showing the type of connection (in series or parallel) of the meter: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(2,0) + to [qiprobe, l=$i$] ++(0,-2) node[ground]{}; + \draw (1,0) to[qvprobe, l=$v$] ++(0,-2) + node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +If you want to explicitly show a power measurement, you can use the power probe \texttt{qpprobe} and using the additional anchors \texttt{v+} and \texttt{v-} : + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) to[short,-*] ++(1,0) coordinate(b) + to[R] ++(2,0) to [qpprobe, l=$i$, a=$v$, name=P] + ++(0,-2.5) node[ground](GND){}; + \draw (P.v-) -| ++(-0.5,-1) coordinate(a) + to [short, -*] (a-|GND); + \draw (P.v+) -| (b); +\end{circuitikz} +\end{LTXexample} + +The final possibility is to use oscilloscopes, like for example: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(3,0) + to [iloop, mirror, name=I] ++(0,-2) + node[ground] (GND){}; + \draw (1,0) to[oscope, v=$v$] ++(0,-2) + node[ground]{}; + \draw (I.i) -- ++(-0.5,0) node[oscopeshape, anchor=right, name=O]{}; + \draw (O.south) -- (O.south |- GND) node[ground]{}; +\end{circuitikz} +\end{LTXexample} + +Or, if you want a more physical structure for the measurement setup: + + +\begin{LTXexample}[varwidth=true, pos=b] +\begin{circuitikz}[american] + \draw (0,0) -- ++(1,0) to[R] ++(3,0) to [iloop2, name=I] ++(0,-2) + node[ground] (GND){}; + \ctikzset{bipoles/oscope/width=1.6}\ctikzset{bipoles/oscope/height=1.2} + \node [oscopeshape, fill=green!10](O) at (6,2){}; + \node [bnc, xscale=-1, anchor=zero](bnc1) at (O.in 1){}; + \node [bnc, , anchor=zero, rotate=-90](bnc2) at (O.in 2){}; + \draw [-latexslim] (bnc1.hot) -| (1,0); + \draw (bnc2.hot) |- (I.i+); + \draw (I.i-) node[ground, scale=0.5]{}; +\end{circuitikz} +\end{LTXexample} + +\subsection{Resistive bipoles} + +\begin{groupdesc} + \circuitdescbip{short}{Short circuit}{} + \circuitdescbip{open}{Open circuit}{} + \circuitdescbip*{generic}{Generic (symmetric) bipole}{} + \circuitdescbip*{tgeneric}{Tunable generic bipole}{} + \circuitdescbip*{ageneric}{Generic asymmetric bipole}{} + \circuitdescbip{fullgeneric}{Generic asymmetric bipole (full)}{} + \circuitdescbip{tfullgeneric}{Tunable generic bipole (full)}{} + \circuitdescbip*{memristor}{Memristor}{Mr} +\end{groupdesc} + +If \texttt{americanresistors} option is active (or the style \texttt{[american resistors]} is used; this is the default for the package), the resistors are displayed as follows: +\begin{groupdesc} + \ctikzset{resistor=american} + \circuitdescbip[resistor]{R}{Resistor}{american resistor} + \circuitdescbip[vresistor]{vR}{Variable resistor}{variable american resistor} + \circuitdescbip[potentiometer]{pR}{Potentiometer}{american potentiometer}( wiper/0/0.3 ) + \circuitdescbip[resistivesens]{sR}{Resisitive sensor}{american resisitive sensor}( label/0/0.3 ) +\end{groupdesc} If instead \texttt{europeanresistors} option is active (or the style \texttt{[european resistors]} is used), the resistors, variable resistors and potentiometers are displayed as follows: -\begin{itemize} - \ctikzset{resistor=european} - \circuititembip{R}{Resistor}{european resistor} - \circuititembip{vR}{Variable resistor}{european variable resistor} - \circuititembip{pR}{Potentiometer}{european potentiometer} - \ctikzset{resistor=american} % reset default -\end{itemize} +\begin{groupdesc} + \ctikzset{resistor=european} + \circuitdescbip*[generic]{R}{Resistor}{european resistor} + \circuitdescbip*[tgeneric]{vR}{Variable resistor}{variable european resistor} + \circuitdescbip*[genericpotentiometer]{pR}{Potentiometer}{european potentiometer}( wiper/0/0.3 ) + \circuitdescbip*[thermistor]{sR}{Resistive sensor}{european resistive sensor}( label/0/0.3 ) + \ctikzset{resistor=american} % reset default +\end{groupdesc} Other miscellaneous resistor-like devices: -\begin{itemize} - \circuititembip{varistor}{Varistor}{} - \circuititembip{phR}{Photoresistor}{photoresistor} - \circuititembip{thermocouple}{Thermocouple}{} - \circuititembip{thR}{Thermistor}{thermistor} - \circuititembip{thRp}{PTC thermistor}{thermistor ptc} - \circuititembip{thRn}{NTC thermistor}{thermistor ntc} - \circuititembip{fuse}{Fuse}{} - \circuititembip{afuse}{Asymmetric fuse}{asymmetric fuse} -\end{itemize} - -\subsubsection{Diodes and such} -\begin{itemize} - \circuititembip{empty diode}{Empty diode}{Do} - \circuititembip{empty Schottky diode}{Empty Schottky diode}{sDo} - \circuititembip{empty Zener diode}{Empty Zener diode}{zDo} - \circuititembip{empty ZZener diode}{Empty ZZener diode}{zzDo} - \circuititembip{empty tunnel diode}{Empty tunnel diode}{tDo} - \circuititembip{empty photodiode}{Empty photodiode}{pDo} - \circuititembip{empty led}{Empty led}{leDo} - \circuititembip{empty varcap}{Empty varcap}{VCo} - \circuititembip{full diode}{Full diode}{D*} - \circuititembip{full Schottky diode}{Full Schottky diode}{sD*} - \circuititembip{full Zener diode}{Full Zener diode}{zD*} - \circuititembip{full ZZener diode}{Full ZZener diode}{zzD*} - \circuititembip{full tunnel diode}{Full tunnel diode}{tD*} - \circuititembip{full photodiode}{Full photodiode}{pD*} - \circuititembip{full led}{Full led}{leD*} - \circuititembip{full varcap}{Full varcap}{VC*} - \circuititembip{stroke diode}{Stroke diode}{D-} - \circuititembip{stroke Schottky diode}{Stroke Schottky diode}{sD-} - \circuititembip{stroke Zener diode}{Stroke Zener diode}{zD-} - \circuititembip{stroke ZZener diode}{Stroke ZZener diode}{zzD-} - \circuititembip{stroke tunnel diode}{Stroke tunnel diode}{tD-} - \circuititembip{stroke photodiode}{Stroke photodiode}{pD-} - \circuititembip{stroke led}{Stroke led}{leD-} - \circuititembip{stroke varcap}{Stroke varcap}{VC-} - \end{itemize} - -\subsubsection{Other tripole-like diodes}\label{sec:othertrip} The following tripoles are entered with the usual command of the form -\begin{itemize} - \circuititembip{triac}{Standard triac (shape depends on package option)}{Tr} - \circuititembip{empty triac}{Empty triac}{Tro} - \circuititembip{full triac}{Full triac}{Tr*} - \circuititembip{thyristor}{Standard thyristor (shape depends on package option)}{Ty} - \circuititembip{empty thyristor}{Empty thyristor}{Tyo} - \circuititembip{full thyristor}{Full thyristor}{Ty*} - \circuititembip{stroke thyristor}{Stroke thyristor}{Ty-} -\end{itemize} -See chapter \ref{bipole-naming} for information how access the third connector +\begin{groupdesc} + \circuitdescbip*{varistor}{Varistor}{} + \circuitdescbip*[photoresistor]{phR}{Photoresistor}{photoresistor} + \circuitdescbip{thermocouple}{Thermocouple}{} + \circuitdescbip*[thermistor]{thR}{Thermistor}{thermistor} + \circuitdescbip*[thermistorptc]{thRp}{PTC thermistor}{thermistor ptc} + \circuitdescbip*[thermistorntc]{thRn}{NTC thermistor}{thermistor ntc} + \circuitdescbip*{fuse}{Fuse}{} + \circuitdescbip*{afuse}{Asymmetric fuse}{asymmetric fuse} +\end{groupdesc} -\begin{framed} -The package options \texttt{fulldiode}, \texttt{strokediode}, and \texttt{emptydiode} (and the styles \texttt{[full diodes]}, \texttt{[stroke diodes]}, and \texttt{[empty diodes]}) define which shape will be used by abbreviated commands such that \texttt{D}, \texttt{sD}, \texttt{zD}, \texttt{zzD}, \texttt{tD}, \texttt{pD}, \texttt{leD}, \texttt{VC}, \texttt{Ty},\texttt{Tr}(no stroke symbol available!). -\end{framed} +\subsubsection{Generic sensors anchors} +Generic sensors have an extra label to help positioning the type of dependence, if needed: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,2) to[sR, l=$R$, name=mySR] ++(3,0); + \node [font=\tiny, right] at(mySR.label) {-t\si{\degree}}; + \draw (0,0) to[sL, l=$L$, name=mySL] ++(3,0); + \node [draw, circle, inner sep=2pt] at(mySL.label) {}; +\end{circuitikz} +\end{LTXexample} -\begin{itemize} - \circuititembip{squid}{Squid}{} - \circuititembip{barrier}{Barrier}{} -\end{itemize} +The anchor is positioned just on the corner of the segmented line crossing the component. + +\subsection{Diodes and such} +\begin{groupdesc} + \circuitdescbip*[emptydiode] {empty diode}{Empty diode}{Do} + \circuitdescbip*[emptysdiode]{empty Schottky diode}{Empty Schottky diode}{sDo} + \circuitdescbip*[emptyzdiode]{empty Zener diode}{Empty Zener diode}{zDo} + \circuitdescbip*[emptyzzdiode]{empty ZZener diode}{Empty ZZener diode}{zzDo} + \circuitdescbip*[emptytdiode]{empty tunnel diode}{Empty tunnel diode}{tDo} + \circuitdescbip*[emptypdiode]{empty photodiode}{Empty photodiode}{pDo} + \circuitdescbip*[emptylediode]{empty led}{Empty led}{leDo} + \circuitdescbip*[emptyvarcap]{empty varcap}{Empty varcap}{VCo} + \circuitdescbip*[emptybidirectionaldiode]{empty bidirectionaldiode}{Empty bidirectionaldiode}{biDo} + \circuitdescbip[fulldiode] {full diode}{Full diode}{D*} + \circuitdescbip[fullsdiode]{full Schottky diode}{Full Schottky diode}{sD*} + \circuitdescbip[fullzdiode]{full Zener diode}{Full Zener diode}{zD*} + \circuitdescbip[fullzzdiode]{full ZZener diode}{Full ZZener diode}{zzD*} + \circuitdescbip[fulltdiode]{full tunnel diode}{Full tunnel diode}{tD*} + \circuitdescbip[fullpdiode]{full photodiode}{Full photodiode}{pD*} + \circuitdescbip[fulllediode]{full led}{Full led}{leD*} + \circuitdescbip[fullvarcap]{full varcap}{Full varcap}{VC*} + \circuitdescbip[fullbidirectionaldiode]{full bidirectionaldiode}{Full bidirectionaldiode}{biD*} +\end{groupdesc} + +These shapes have no exact node-style counterpart, because the stroke line is built upon the empty variants: + +\begin{groupdesc} + \circuitdescbip*[emptydiode] {stroke diode}{Stroke diode}{D-} + \circuitdescbip*[emptysdiode]{stroke Schottky diode}{Stroke Schottky diode}{sD-} + \circuitdescbip*[emptyzdiode]{stroke Zener diode}{Stroke Zener diode}{zD-} + \circuitdescbip*[emptyzzdiode]{stroke ZZener diode}{Stroke ZZener diode}{zzD-} + \circuitdescbip*[emptytdiode]{stroke tunnel diode}{Stroke tunnel diode}{tD-} + \circuitdescbip*[emptypdiode]{stroke photodiode}{Stroke photodiode}{pD-} + \circuitdescbip*[emptylediode]{stroke led}{Stroke led}{leD-} + \circuitdescbip*[emptyvarcap]{stroke varcap}{Stroke varcap}{VC-} +\end{groupdesc} + +\subsection{Tripole-like diodes}\label{sec:othertrip} The following tripoles are entered with the usual command, of the form +\begin{groupdesc} + \circuitdescbip*[emptytriac]{triac}{Standard triac (shape depends on package option)}{Tr}( G/0/0.3 ) + \circuitdescbip*[emptytriac]{empty triac}{Empty triac}{Tro}( gate/0/0.3 ) + \circuitdescbip[fulltriac]{full triac}{Full triac}{Tr*} + \circuitdescbip*[emptythyristor]{thyristor}{Standard thyristor (shape depends on package option)}{Ty} + \circuitdescbip*[emptythyristor]{empty thyristor}{Empty thyristor}{Tyo} + \circuitdescbip[fullthyristor]{full thyristor}{Full thyristor}{Ty*} + \circuitdescbip*[emptythyristor]{stroke thyristor}{Stroke thyristor}{Ty-} +\end{groupdesc} + +\subsubsection{Triacs anchors} + +When inserting a thrystor, a triac or a potentiometer, one needs to refer to the third node-gate (\texttt{gate} or \texttt{G}) for the former two; wiper (\texttt{wiper} or \texttt{W}) for the latter one. This is done by giving a name to the bipole: +\label{bipole-naming} +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) to[Tr, n=TRI] (2,0) + to[pR, n=POT] (4,0); + \draw[dashed] (TRI.G) -| (POT.wiper) +;\end{circuitikz} +\end{LTXexample} -\begin{itemize} - \circuititembip{european gas filled surge arrester}{European gas filled surge arrester}{} - \circuititembip{american gas filled surge arrester}{American gas filled surge arrester}{} -\end{itemize} \begin{framed} -If (default behaviour) \texttt{europeangfsurgearrester} option is active (or the style \texttt{[european gas filled surge arrester]} is used), the shorthands \texttt{gas filled surge arrester} and \texttt{gf surge arrester} are equivalent to the european version of the component. - -If otherwise \texttt{americangfsurgearrester} option is active (or the style \texttt{[american gas filled surge arrester]} is used), the shorthands the shorthands \texttt{gas filled surge arrester} and \texttt{gf surge arrester} are equivalent to the american version of the component. +The package options \texttt{fulldiode}, \texttt{strokediode}, and \texttt{emptydiode} (and the styles \texttt{[full diodes]}, \texttt{[stroke diodes]}, and \texttt{[empty diodes]}) define which shape will be used by abbreviated commands such that \texttt{D}, \texttt{sD}, \texttt{zD}, \texttt{zzD}, \texttt{tD}, \texttt{pD}, \texttt{leD}, \texttt{VC}, \texttt{Ty},\texttt{Tr} (no stroke symbol available!). \end{framed} -\subsubsection{Basic dynamical bipoles} -\begin{itemize} - \circuititembip{capacitor}{Capacitor}{C} - \circuititembip{polar capacitor}{Polar capacitor}{pC} - \circuititembip{ecapacitor}{Electrolytic capacitor}{eC,elko} - \circuititembip{variable capacitor}{Variable capacitor}{vC} - \circuititembip{piezoelectric}{Piezoelectric Element}{PZ} -\end{itemize} + +\subsection{Basic dynamical bipoles} +\begin{groupdesc} + \circuitdescbip{capacitor}{Capacitor}{C} + \circuitdescbip[polarcapacitor]{polar capacitor}{Polar capacitor}{pC} + \circuitdescbip*{ecapacitor}{Electrolytic capacitor}{eC,elko} + \circuitdescbip[vcapacitor]{variable capacitor}{Variable capacitor}{vC} + \circuitdescbip[capacitivesens]{capacitive sensor}{Capacitive sensor}{sC}( label/0/0.3 ) + \circuitdescbip*{piezoelectric}{Piezoelectric Element}{PZ} +\end{groupdesc} If (default behaviour) \texttt{cuteinductors} option is active (or the style \texttt{[cute inductors]} is used), the inductors are displayed as follows: -\begin{itemize} - \ctikzset{inductor=cute} - \circuititembip{L}{Inductor}{cute inductor} - \circuititembip{vL}{Variable inductor}{variable cute inductor} -\end{itemize} +\begin{groupdesc} + \ctikzset{inductor=cute} + \circuitdescbip[cuteinductor]{L}{Inductor}{cute inductor} + \circuitdescbip[cutechoke]{cute choke}{Choke}{} + \circuitdescbip[vcuteinductor]{vL}{Variable inductor}{variable cute inductor} + \circuitdescbip[scuteinductor]{sL}{Inductive sensor}{cute inductive sensor}( label/0/0.3 ) +\end{groupdesc} If \texttt{americaninductors} option is active (or the style \texttt{[american inductors]} is used), the inductors are displayed as follows: -\begin{itemize} - \ctikzset{inductor=american} - \circuititembip{L}{Inductor}{american inductor} - \circuititembip{vL}{Variable inductor}{variable american inductor} -\end{itemize} +\begin{groupdesc} + \ctikzset{inductor=american} + \circuitdescbip[americaninductor]{L}{Inductor}{american inductor} + \circuitdescbip[vamericaninductor]{vL}{Variable inductor}{variable american inductor} + \circuitdescbip[samericaninductor]{sL}{Inductive sensor}{american inductive sensor}( label/0/0.3 ) +\end{groupdesc} Finally, if \texttt{europeaninductors} option is active (or the style \texttt{[european inductors]} is used), the inductors are displayed as follows: -\begin{itemize} - \ctikzset{inductor=european} - \circuititembip{L}{Inductor}{european inductor} - \circuititembip{vL}{Variable inductor}{variable european inductor} -\end{itemize} - -There is also a transmission line: -\begin{itemize} -\circuititembip{TL}{Transmission line}{transmission line, tline} -\end{itemize} - -\subsubsection{Stationary sources} -\begin{itemize} - \circuititembip{battery}{Battery}{} - \circuititembip{battery1}{Single battery cell}{} - \circuititembip{battery2}{Single battery cell}{} - \circuititembip{european voltage source}{Voltage source (european style)}{} - \circuititembip{american voltage source}{Voltage source (american style)}{} - \circuititembip{european current source}{Current source (european style)}{} - \circuititembip{american current source}{Current source (american style)}{} -\end{itemize} +\begin{groupdesc} + \ctikzset{inductor=european} + \circuitdescbip[fullgeneric]{L}{Inductor}{european inductor} + \circuitdescbip[tfullgeneric]{vL}{Variable inductor}{variable european inductor} + \circuitdescbip[sfullgeneric]{sL}{Inductive sensor}{european inductive sensor}( label/0/0.3 ) + \ctikzset{inductor=cute} % back to default +\end{groupdesc} + + +\subsection{Stationary sources} +\begin{groupdesc} + \circuitdescbip{battery}{Battery}{} + \circuitdescbip{battery1}{Single battery cell}{} + \circuitdescbip{battery2}{Single battery cell}{} + \circuitdescbip*[vsource]{european voltage source}{Voltage source (european style)}{} + \circuitdescbip*[vsourceC]{cute european voltage source}{Voltage source (cute european style)}{vsourceC, ceV} + \circuitdescbip*[vsourceAM]{american voltage source}{Voltage source (american style)}{} + \circuitdescbip*[isource]{european current source}{Current source (european style)}{} + \circuitdescbip*[isourceC]{cute european current source}{Current source (cute european style)}{isourceC, ceI} + \circuitdescbip*[isourceAM]{american current source}{Current source (american style)}{} +\end{groupdesc} \begin{framed} If (default behaviour) \texttt{europeancurrents} option is active (or the style \texttt{[european currents]} is used), the shorthands \texttt{current source}, \texttt{isource}, and \texttt{I} are equivalent to \texttt{european current source}. Otherwise, if \texttt{americancurrents} option is active (or the style \texttt{[american currents]} is used) they are equivalent to \texttt{american current source}. @@ -467,120 +1184,346 @@ Similarly, if (default behaviour) \texttt{europeanvoltages} option is active (or \end{framed} -\subsubsection{Sinusoidal sources} Here because I was asked for them. But how do you distinguish one from the other?! -\begin{itemize} - \circuititembip{sinusoidal voltage source}{Sinusoidal voltage source}{vsourcesin, sV} - \circuititembip{sinusoidal current source}{Sinusoidal current source}{isourcesin, sI} -\end{itemize} +\subsection{Sinusoidal sources} Here because I was asked for them. But how do you distinguish one from the other?! +\begin{groupdesc} + \circuitdescbip*[vsourcesin]{sinusoidal voltage source}{Sinusoidal voltage source}{vsourcesin, sV} + \circuitdescbip*[isourcesin]{sinusoidal current source}{Sinusoidal current source}{isourcesin, sI} +\end{groupdesc} -\subsubsection{Special sources} -\begin{itemize} - \circuititembip{square voltage source}{Square voltage source}{vsourcesquare, sqV} - \circuititembip{vsourcetri}{Triangle voltage source}{tV} - \circuititembip{esource}{Empty voltage source}{} - \circuititembip{pvsource}{Photovoltaic-voltage source}{} - \circuititembip{ioosource}{Double Zero style current source}{} - \circuititembip{voosource}{Double Zero style voltage source}{} -\end{itemize} +\subsection{Controlled sources} +\begin{groupdesc} + \circuitdescbip*[cvsource]{european controlled voltage source}{Controlled voltage source (european style)}{} + \circuitdescbip*[cvsourceC]{cute european controlled voltage source}{Voltage source (cute european style)}{cvsourceC, cceV} + \circuitdescbip*[cvsourceAM]{american controlled voltage source}{Controlled voltage source (american style)}{} + \circuitdescbip*[cisource]{european controlled current source}{Controlled current source (european style)}{} + \circuitdescbip*[cisourceC]{cute european controlled current source}{Current source (cute european style)}{cisourceC, cceI} + \circuitdescbip*[cisourceAM]{american controlled current source}{Controlled current source (american style)}{} +\end{groupdesc} -\subsubsection{DC sources} -\begin{itemize} - \circuititembip{dcvsource}{DC voltage source}{} - \circuititembip{dcisource}{DC current source}{} -\end{itemize} +\begin{framed} +If (default behaviour) \texttt{europeancurrents} option is active (or the style \texttt{[european currents]} is used), the shorthands \texttt{controlled current source}, \texttt{cisource}, and \texttt{cI} are equivalent to \texttt{european controlled current source}. Otherwise, if \texttt{americancurrents} option is active (or the style \texttt{[american currents]} is used) they are equivalent to \texttt{american controlled current source}. -\subsubsection{Mechanical Analogy} -\begin{itemize} - \circuititembip{damper}{Mechanical Damping}{} - \circuititembip{spring}{Mechanical Stiffness}{} - \circuititembip{mass}{Mechanical Mass}{} -\end{itemize} +Similarly, if (default behaviour) \texttt{europeanvoltages} option is active (or the style \texttt{[european voltages]} is used), the shorthands \texttt{controlled voltage source}, \texttt{cvsource}, and \texttt{cV} are equivalent to \texttt{european controlled voltage source}. Otherwise, if \texttt{americanvoltages} option is active (or the style \texttt{[american voltages]} is used) they are equivalent to \texttt{american controlled voltage source}. +\end{framed} -\subsubsection{Switch} -\begin{itemize} - \circuititembip{switch}{Switch}{spst} - \circuititembip{closing switch}{Closing switch}{cspst} - \circuititembip{opening switch}{Opening switch}{ospst} - \circuititembip{normal open switch}{Normally open switch}{nos} - \circuititembip{normal closed switch}{Normally closed switch}{ncs} - \circuititembip{push button}{Push button}{} -\end{itemize} - -\subsubsection{Block diagram components} -\noindent Contributed by Stefan Erhardt. -\begin{itemize} - \circuititembip{twoport}{generic two port\footnote{To specify text to be put in the component: \texttt{twoport[t=text]}): \tikz \draw[scale=.5, transform shape] (0,0) to[twoport,>,t=text] (2,0); }}{} - \circuititembip{vco}{vco}{} - \circuititembip{bandpass}{bandpass}{} - \circuititembip{bandstop}{bandstop}{} - \circuititembip{highpass}{highpass}{} - \circuititembip{lowpass}{lowpass}{} - \circuititembip{adc}{A/D converter}{} - \circuititembip{dac}{D/A converter}{} - \circuititembip{dsp}{DSP}{} - \circuititembip{fft}{FFT}{} - \circuititembip{amp}{amplifier}{} - \circuititembip{vamp}{VGA}{} - \circuititembip{piattenuator}{$\pi$ attenuator}{} - \circuititembip{vpiattenuator}{var. $\pi$ attenuator}{} - \circuititembip{tattenuator}{T attenuator}{} - \circuititembip{vtattenuator}{var.\ T attenuator}{} - \circuititembip{phaseshifter}{phase shifter}{} - \circuititembip{vphaseshifter}{var.\ phase shifter}{} - \circuititembip{detector}{detector}{} -\end{itemize} - - - - -\subsection{Tripoles} -\subsubsection{Controlled sources} Admittedly, graphically they are bipoles. But I couldn't\ldots -\begin{itemize} - \circuititembip{european controlled voltage source}{Controlled voltage source (european style)}{} - \circuititembip{american controlled voltage source}{Controlled voltage source (american style)}{} - \circuititembip{european controlled current source}{Controlled current source (european style)}{} - \circuititembip{american controlled current source}{Controlled current source (american style)}{} -\end{itemize} +\begin{groupdesc} + \circuitdescbip*[cvsourcesin]{controlled sinusoidal voltage source}{Controlled sinusoidal voltage source}{controlled vsourcesin, cvsourcesin, csV} + \circuitdescbip*[cisourcesin]{controlled sinusoidal current source}{Controlled sinusoidal current source}{controlled isourcesin, cisourcesin, csI} +\end{groupdesc} + + + +\subsection{Noise sources} + +In this case, the ``direction'' of the source has no sense. Noise sources are filled in gray by default, but if you choose the dashed style, they become fillable. + +\begin{groupdesc} + \circuitdescbip[vsourceN]{noise voltage source}{Sinusoidal voltage source}{vsourceN, nV} + \circuitdescbip[isourceN]{noise current source}{Sinusoidal current source}{isourceN, nI} +\end{groupdesc} + +You can change the fill color with the key \texttt{circuitikz/bipoles/noise sources/fillcolor}: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw(0,0) to [nV, l=$e_n$] ++(2,0); + \draw(0,-2) to [nI, l=$i_n$] ++(2,0); + \begin{scope}[circuitikz/bipoles/noise sources/fillcolor=red!50] + \draw(3,0) to [nV, l=$e_n$] ++(2,0); + \draw(3,-2) to [nI, l=$i_n$] ++(2,0); + \end{scope} +\end{circuitikz} +\end{LTXexample} + +If you prefer a patterned noise generator (similar to the one you draw by hand) you can use the fake color \texttt{dashed}: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw(0,0) to [nV, l=$e_n$] ++(2,0); + \draw(0,-2) to [nI, l=$i_n$] ++(2,0); + \begin{scope}[circuitikz/bipoles/noise sources/fillcolor=dashed] + \draw(3,0) to [nV, l=$e_n$] ++(2,0); + \draw(3,-2) to [nI, l=$i_n$] ++(2,0); + \end{scope} +\end{circuitikz} +\end{LTXexample} + +Notice that if you choose the dashed style, the noise sources are fillable: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{bipoles/noise sources/fillcolor=dashed} + \draw(0,0) to [nV, l=$e_n$] ++(2,0); + \draw(0,-2) to [nI, l=$i_n$] ++(2,0); + \begin{scope} + \draw(3,0) to [nV, l=$e_n$, fill=yellow!50!red] ++(2,0); + \draw(3,-2) to [nI, l=$i_n$, fill=blue!50!white] ++(2,0); + \end{scope} +\end{circuitikz} +\end{LTXexample} + +\subsection{Special sources} +\begin{groupdesc} + \circuitdescbip*[vsourcesquare]{square voltage source}{Square voltage source}{vsourcesquare, sqV} + \circuitdescbip*{vsourcetri}{Triangle voltage source}{tV} + \circuitdescbip*{esource}{Empty voltage source}{} + \circuitdescbip*{pvsource}{Photovoltaic-voltage source}{} + \circuitdescbip*[oosource]{ioosource}{Double Zero style current source}{} + \circuitdescbip*[oosource]{voosource}{Double Zero style voltage source}{} +\end{groupdesc} + +\subsection{DC sources} +\begin{groupdesc} + \circuitdescbip*{dcvsource}{DC voltage source}{} + \circuitdescbip*{dcisource}{DC current source}{} +\end{groupdesc} + +\subsection{Mechanical Analogy} +\begin{groupdesc} + \circuitdescbip*{damper}{Mechanical Damping}{} + \circuitdescbip{spring}{Mechanical Stiffness}{} + \circuitdescbip*{viscoe}{Mechanical viscoelastic element\footnotemark}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + \footnotetext{Suggested by @Alex in \url{https://tex.stackexchange.com/q/484268/38080}} + \circuitdescbip*{mass}{Mechanical Mass}{} +\end{groupdesc} + +\subsection{Other bipoles} + +Here you'll find bipoles that are not easily grouped in the categories above. + +\begin{groupdesc} + \circuitdescbip{squid}{Squid}{} + \circuitdescbip{barrier}{Barrier}{} +\end{groupdesc} + +\begin{groupdesc} + \circuitdescbip*{european gas filled surge arrester}{European gas filled surge arrester}{} + \circuitdescbip*{american gas filled surge arrester}{American gas filled surge arrester}{} +\end{groupdesc} \begin{framed} -If (default behaviour) \texttt{europeancurrents} option is active (or the style \texttt{[european currents]} is used), the shorthands \texttt{controlled current source}, \texttt{cisource}, and \texttt{cI} are equivalent to \texttt{european controlled current source}. Otherwise, if \texttt{americancurrents} option is active (or the style \texttt{[american currents]} is used) they are equivalent to \texttt{american controlled current source}. +If (default behaviour) \texttt{europeangfsurgearrester} option is active (or the style \texttt{[european gas filled surge arrester]} is used), the shorthands \texttt{gas filled surge arrester} and \texttt{gf surge arrester} are equivalent to the european version of the component. -Similarly, if (default behaviour) \texttt{europeanvoltages} option is active (or the style \texttt{[european voltages]} is used), the shorthands \texttt{controlled voltage source}, \texttt{cvsource}, and \texttt{cV} are equivalent to \texttt{european controlled voltage source}. Otherwise, if \texttt{americanvoltages} option is active (or the style \texttt{[american voltages]} is used) they are equivalent to \texttt{american controlled voltage source}. +If otherwise \texttt{americangfsurgearrester} option is active (or the style \texttt{[american gas filled surge arrester]} is used), the shorthands the shorthands \texttt{gas filled surge arrester} and \texttt{gf surge arrester} are equivalent to the american version of the component. \end{framed} -\begin{itemize} - \circuititembip{controlled sinusoidal voltage source}{Controlled sinusoidal voltage source}{controlled vsourcesin, cvsourcesin, csV} - \circuititembip{controlled sinusoidal current source}{Controlled sinusoidal current source}{controlled isourcesin, cisourcesin, csI} - \end{itemize} -\subsubsection{Transistors} +\begin{groupdesc} + \circuitdescbip*{lamp}{Lamp}{} + \circuitdescbip*{bulb}{Bulb}{} + \circuitdescbip*{loudspeaker}{loudspeaker}{}( north/90/0.4, north east/45/0.4, east/0/0.4, south east/-45/0.4, + south/-90/0.4, south west/-135/0.4, west/180/0.4, north west/135/0.4, + left/135/0.2, right/45/0.2, center/-135/0.2 + ) + \circuitdescbip*{mic}{mic}{}( north/90/0.4, north east/45/0.4, east/0/0.4, south east/-45/0.4, + south/-90/0.4, south west/-135/0.4, west/180/0.4, north west/135/0.4, + left/135/0.2, right/45/0.2, center/-135/0.2 + ) +\end{groupdesc} + +You can use microphones and loudspeakers with \texttt{waves} (see section~\ref{sec:support}) too: + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz} + \draw (0,0) to[mic, name=M] ++(0,2) + to[amp, t=$A$] ++(2,0) + to[loudspeaker, name=L] ++(0,-2) + to[short, -*] (0,0) node[ground]{}; + \node [waves, scale=0.7, left=5pt] + at(M.north) {}; + \node [waves, scale=0.7, right] + at(L.north) {}; + \end{circuitikz} +\end{LTXexample} -\begin{itemize} - \circuititem{nmos}{\scshape nmos}{} - \circuititem{pmos}{\scshape pmos}{} - \circuititem{npn}{\scshape npn}{} - \circuititem{pnp}{\scshape pnp}{} - \circuititem{npn,photo}{\scshape npn}{} - \circuititem{pnp,photo}{\scshape pnp}{} - \circuititem{nigbt}{\scshape nigbt}{} - \circuititem{pigbt}{\scshape pigbt}{} - \circuititem{Lnigbt}{\scshape Lnigbt}{} - \circuititem{Lpigbt}{\scshape Lpigbt}{} -\end{itemize} -For all transistors a bodydiode(or freewheeling diode) can automatically be drawn. Just use the global option bodydiode, or for single transistors, the tikz-option bodydiode: +\subsection{Block diagram components} +\noindent Contributed by Stefan Erhardt. + +\begin{groupdesc} + \circuitdesc*{mixer}{\scshape mixer}{}( 1/180/0.1,2/-90/0.1,3/0/0.1,4/90/0.1 ) + \circuitdesc*{adder}{\scshape adder}{}( west/180/0.1,south/-90/0.1,east/0/0.1,north/90/0.1 ) + \circuitdesc*{oscillator}{\scshape oscillator}{} + \circuitdesc*{circulator}{\scshape circulator}{} + \circuitdesc*{wilkinson}{\scshape wilkinson divider}{}( in/180/0.1, out2/45/0.1, out1/-45/0.1 ) +\end{groupdesc} + +\begin{groupdesc} + \circuitdescbip*{twoport}{generic two port\footnotemark}{} + \footnotetext{To specify text to be put in the component: \texttt{twoport[t=text]}): \tikz \draw[scale=.5, transform shape] (0,0) to[twoport,>,t=text] (2,0); } + \circuitdescbip*{vco}{vco}{} + \circuitdescbip*{bandpass}{bandpass}{} + \circuitdescbip*{bandstop}{bandstop}{} + \circuitdescbip*{highpass}{highpass}{} + \circuitdescbip*{lowpass}{lowpass}{} + \circuitdescbip*{adc}{A/D converter}{} + \circuitdescbip*{dac}{D/A converter}{} + \circuitdescbip*{dsp}{DSP}{} + \circuitdescbip*{fft}{FFT}{} + \circuitdescbip*{amp}{amplifier}{} + \circuitdescbip*{vamp}{VGA}{} + \circuitdescbip*{piattenuator}{$\pi$ attenuator}{} + \circuitdescbip*{vpiattenuator}{var. $\pi$ attenuator}{} + \circuitdescbip*{tattenuator}{T attenuator}{} + \circuitdescbip*{vtattenuator}{var.\ T attenuator}{} + \circuitdescbip*{phaseshifter}{phase shifter}{} + \circuitdescbip*{vphaseshifter}{var.\ phase shifter}{} + \circuitdescbip*{detector}{detector}{} +\end{groupdesc} + +\begin{groupdesc} + \circuitdesc{coupler}{Coupler}{} + \circuitdesc{coupler2}{Coupler, 2}{} +\end{groupdesc} + +\subsubsection{Blocks anchors} + +The ports of the mixer and adder can be addressed with numbers or \texttt{west}/\texttt{south}/\texttt{east}/\texttt{north}: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[mixer] (mix) {} + (mix.1) node[left] {1} + (mix.2) node[below] {2} + (mix.3) node[right] {3} + (mix.4) node[above] {4} +;\end{circuitikz} +\end{LTXexample} + + +The Wilkinson divider has: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[wilkinson] (w) {\SI{3}{dB}} + (w.in) to[short,-o] ++(-0.5,0) + (w.out1) to[short,-o] ++(0.5,0) + (w.out2) to[short,-o] ++(0.5,0) + (w.in) node[below left] {\texttt{in}} + (w.out1) node[below right] {\texttt{out1}} + (w.out2) node[above right] {\texttt{out2}} + ; +\end{circuitikz} +\end{LTXexample} + +The couplers have: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[coupler] (c) {\SI{10}{dB}} + (c.1) to[short,-o] ++(-0.5,0) + (c.2) to[short,-o] ++(0.5,0) + (c.3) to[short,-o] ++(0.5,0) + (c.4) to[short,-o] ++(-0.5,0) + (c.1) node[below left] {\texttt{1}} + (c.2) node[below right] {\texttt{2}} + (c.3) node[above right] {\texttt{3}} + (c.4) node[above left] {\texttt{4}} + ; +\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[coupler2] (c) {\SI{3}{dB}} + (c.1) to[short,-o] ++(-0.5,0) + (c.2) to[short,-o] ++(0.5,0) + (c.3) to[short,-o] ++(0.5,0) + (c.4) to[short,-o] ++(-0.5,0) + (c.1) node[below left] {\texttt{1}} + (c.2) node[below right] {\texttt{2}} + (c.3) node[above right] {\texttt{3}} + (c.4) node[above left] {\texttt{4}} + ; +\end{circuitikz} +\end{LTXexample} + + +\subsubsection{Blocks customization} + +With the option \texttt{>} you can draw an arrow to the input of the block diagram symbols. +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) to[short,o-] ++(0.3,0) + to[lowpass,>] ++(2,0) + to[adc,>] ++(2,0) + to[short,-o] ++(0.3,0); +\end{circuitikz} +\end{LTXexample} + + +\paragraph{Multi ports} +Since inputs and outputs can vary, input arrows can be placed as nodes. Note that you have to rotate the arrow on your own: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[mixer] (m) {} + (m.1) to[short,-o] ++(-1,0) + (m.2) to[short,-o] ++(0,-1) + (m.3) to[short,-o] ++(1,0) + (m.1) node[inputarrow] {} + (m.2) node[inputarrow,rotate=90] {}; +\end{circuitikz} +\end{LTXexample} + + +\paragraph{Labels and custom two-port boxes} +Some two-ports have the option to place a normal label (\texttt{l=}) and a inner label (\texttt{t=}). \begin{LTXexample}[varwidth=true] \begin{circuitikz} - \draw (0,0) node[npn,bodydiode](npn){}++(2,0)node[pnp,bodydiode](npn){}; - \draw (0,-2) node[nigbt,bodydiode](npn){}++(2,0)node[pigbt,bodydiode](npn){}; - \draw (0,-4) node[nfet,bodydiode](npn){}++(2,0)node[pfet,bodydiode](npn){}; + \ctikzset{bipoles/amp/width=0.9} + \draw (0,0) to[amp,t=LNA,l_=$F{=}0.9\,$dB,o-o] ++(3,0); +\end{circuitikz} +\end{LTXexample} + + +\paragraph{Box option} +Some devices have the possibility to add a box around them. The inner symbol scales down to fit inside the box. +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[mixer,box,anchor=east] (m) {} + to[amp,box,>,-o] ++(2.5,0) + (m.west) node[inputarrow] {} to[short,-o] ++(-0.8,0) + (m.south) node[inputarrow,rotate=90] {} -- + ++(0,-0.7) node[oscillator,box,anchor=north] {}; +\end{circuitikz} +\end{LTXexample} + + +\paragraph{Dash optional parts} +To show that a device is optional, you can dash it. The inner symbol will be kept with solid lines. +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) to[amp,l=\SI{10}{dB}] ++(2.5,0); + \draw[dashed] (2.5,0) to[lowpass,l=opt.] ++(2.5,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} +\subsection{Transistors} +\begin{groupdesc} + \circuitdesc{nmos}{\scshape nmos}{}( G/180/0.2,D/0/0.2,S/0/0.2 ) + \circuitdesc{pmos}{\scshape pmos}{} + \circuitdesc{hemt}{\scshape hemt}{} + \circuitdesc{npn}{\scshape npn}{}( B/180/0.2,C/0/0.2,E/0/0.2 ) + \circuitdesc{pnp}{\scshape pnp}{} + \circuitdesc{npn,photo}{\scshape npn}{}( nobase/0/0.4 ) + \circuitdesc{pnp,photo}{\scshape pnp}{} + \circuitdesc{nigbt}{\scshape nigbt}{} + \circuitdesc{pigbt}{\scshape pigbt}{} + \circuitdesc{Lnigbt}{\scshape Lnigbt}{} + \circuitdesc{Lpigbt}{\scshape Lpigbt}{} +\end{groupdesc} + +For all transistors a body diode (or freewheeling diode) can automatically be drawn. Just use the global option bodydiode, or for single transistors, the tikz-option bodydiode: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) node[npn,bodydiode](npn){}++(2,0)node[pnp,bodydiode](npn){}; + \draw (0,-2) node[nigbt,bodydiode](npn){}++(2,0)node[pigbt,bodydiode](npn){}; + \draw (0,-4) node[nfet,bodydiode](npn){}++(2,0)node[pfet,bodydiode](npn){}; +\end{circuitikz} +\end{LTXexample} The Base/Gate connection of all transistors can be disable by using the options \textit{nogate} or \textit{nobase}, respectively. The Base/Gate anchors are floating, but there an additional anchor "nogate"/"nobase", which can be used to point to the unconnected base: \begin{LTXexample}[varwidth=true] @@ -591,54 +1534,178 @@ The Base/Gate connection of all transistors can be disable by using the options \draw (npn.B) node[circ]{} node[left]{B}; \draw[dashed,red,-latex] (1,0.5)--(npn.nobase); \end{circuitikz} -\end{LTXexample} - - +\end{LTXexample} If the option \texttt{arrowmos} is used (or after the command \verb!\ctikzset{tripoles/mos style/arrows}! is given), this is the output: \ctikzset{tripoles/mos style/arrows} -\begin{itemize} - \circuititem{nmos}{\scshape nmos}{} - \circuititem{pmos}{\scshape pmos}{} -\end{itemize} +\begin{groupdesc} + \circuitdesc{nmos}{\scshape nmos}{} + \circuitdesc{pmos}{\scshape pmos}{} +\end{groupdesc} \ctikzset{tripoles/mos style/no arrows} +To draw the PMOS circle non-solid, use the option \texttt{emptycircle} or the command +\\\verb!\ctikzset{tripoles/pmos style/emptycircle}!. -To draw the PMOS circle non-solid, use the option \texttt{emptycircle} or the command \verb!\ctikzset{tripoles/pmos style/emptycircle}!. -\begin{itemize} - \circuititem{pmos,emptycircle}{\scshape pmos}{} -\end{itemize} +\begin{groupdesc} + \circuitdesc{pmos,emptycircle}{\scshape pmos}{} +\end{groupdesc} -\textsc{nfet}s and \textsc{pfet}s have been incorporated based on code provided by Clemens Helfmeier and Theodor -Borsche. Use the package options \texttt{fetsolderdot}/\texttt{nofetsolderdot} to enable/disable solderdot at some fet-transistors. Additionally, the solderdot option can be enabled/disabled for single transistors with the option "solderdot" and "nosolderdot", respectively. +If you prefer different position of the arrows in transistors and FETs, you can adjust them like this (it works for the other BJT-based transistors, too): +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{tripoles/mos style/arrows, + tripoles/npn/arrow pos=0.8, + tripoles/pnp/arrow pos=0.8, + tripoles/nmos/arrow pos=0.8, + tripoles/pmos/arrow pos=0.6, } + \draw (0,0) node[npn, ](npn){}; + \draw (2,0) node[pnp, ](npn){}; + \draw (0,-2) node[nmos, ](npn){}; + \draw (2,-2) node[pmos, ](npn){}; +\end{circuitikz} +\end{LTXexample} +\textsc{nfet}s and \textsc{pfet}s have been incorporated based on code provided by Clemens Helfmeier and Theodor +Borsche. Use the package options \texttt{fetsolderdot}/\texttt{nofetsolderdot} to enable/disable solderdot at some fet-transistors. Additionally, the solderdot option can be enabled/disabled for single transistors with the option "solderdot" and "nosolderdot", respectively. -\begin{itemize} - \circuititem{nfet}{\scshape nfet}{} - \circuititem{nigfete}{\scshape nigfete}{} - \circuititem{nigfete,solderdot}{\scshape nigfete}{} - \circuititem{nigfetebulk}{\scshape nigfetebulk}{} - \circuititem{nigfetd}{\scshape nigfetd}{} - \circuititem{pfet}{\scshape pfet}{} - \circuititem{pigfete}{\scshape pigfete}{} - \circuititem{pigfetebulk}{\scshape pigfetebulk}{} - \circuititem{pigfetd}{\scshape pigfetd}{} -\end{itemize} -\textsc{njfet} and \textsc{pjfet} have been incorporated based on code provided by Danilo Piazzalunga: -\begin{itemize} - \circuititem{njfet}{\scshape njfet}{} - \circuititem{pjfet}{\scshape pjfet}{} -\end{itemize} +\begin{groupdesc} + \circuitdesc{nfet}{\scshape nfet}{} + \circuitdesc{nigfete}{\scshape nigfete}{} + \circuitdesc{nigfete,solderdot}{\scshape nigfete}{} + \circuitdesc{nigfetebulk}{\scshape nigfetebulk}{} + \circuitdesc{nigfetd}{\scshape nigfetd}{} + \circuitdesc{pfet}{\scshape pfet}{} + \circuitdesc{pigfete}{\scshape pigfete}{} + \circuitdesc{pigfetebulk}{\scshape pigfetebulk}{} + \circuitdesc{pigfetd}{\scshape pigfetd}{} +\end{groupdesc} + +\textsc{njfet} and \textsc{pjfet} have been incorporated based on code provided by Danilo Piazzalunga: +\begin{groupdesc} + \circuitdesc{njfet}{\scshape njfet}{} + \circuitdesc{pjfet}{\scshape pjfet}{} +\end{groupdesc} \textsc{isfet} -\begin{itemize} - \circuititem{isfet}{\scshape isfet}{} -\end{itemize} +\begin{groupdesc} + \circuitdesc{isfet}{\scshape isfet}{} +\end{groupdesc} -\subsubsection{Electronic Tubes} -\begin{itemize} - \circuititem{magnetron}{Magnetron}{} -\end{itemize} +\subsubsection{Transistors anchors} + +For \textsc{nmos}, \textsc{pmos}, \textsc{nfet}, \textsc{nigfete}, \textsc{nigfetd}, \textsc{pfet}, \textsc{pigfete}, and \textsc{pigfetd} transistors one has \texttt{base}, \texttt{gate}, \texttt{source} and \texttt{drain} anchors (which can be abbreviated with \texttt{B}, \texttt{G}, \texttt{S} and \texttt{D}): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[nmos] (mos) {} + (mos.gate) node[anchor=east] {G} + (mos.drain) node[anchor=south] {D} + (mos.source) node[anchor=north] {S} +;\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[pigfete] (pigfete) {} + (pigfete.G) node[anchor=east] {G} + (pigfete.D) node[anchor=north] {D} + (pigfete.S) node[anchor=south] {S} + (pigfete.bulk) node[anchor=west] {Bulk} +;\end{circuitikz} +\end{LTXexample} + +Similarly \textsc{njfet} and \textsc{pjfet} have \texttt{gate}, \texttt{source} and \texttt{drain} anchors (which can be abbreviated with \texttt{G}, \texttt{S} and \texttt{D}): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[pjfet] (pjfet) {} + (pjfet.G) node[anchor=east] {G} + (pjfet.D) node[anchor=north] {D} + (pjfet.S) node[anchor=south] {S} +;\end{circuitikz} +\end{LTXexample} + +For \textsc{npn}, \textsc{pnp}, \textsc{nigbt}, and \textsc{pigbt} transistors the anchors are \texttt{base}, \texttt{emitter} and \texttt{collector} anchors (which can be abbreviated with \texttt{B}, \texttt{E} and \texttt{C}): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[npn] (npn) {} + (npn.base) node[anchor=east] {B} + (npn.collector) node[anchor=south] {C} + (npn.emitter) node[anchor=north] {E} +;\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[pigbt] (pigbt) {} + (pigbt.B) node[anchor=east] {B} + (pigbt.C) node[anchor=north] {C} + (pigbt.E) node[anchor=south] {E} +;\end{circuitikz} +\end{LTXexample} + +Here is one composite example (please notice that the \texttt{xscale=-1} style would also reflect the label of the transistors, so here a new node is added and its text is used, instead of that of \texttt{pnp1}): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[pnp] (pnp2) {2} + (pnp2.B) node[pnp, xscale=-1, anchor=B] (pnp1) {} + (pnp1) node {1} + (pnp1.C) node[npn, anchor=C] (npn1) {} + (pnp2.C) node[npn, xscale=-1, anchor=C] (npn2) {} + (pnp1.E) -- (pnp2.E) (npn1.E) -- (npn2.E) + (pnp1.B) node[circ] {} |- (pnp2.C) node[circ] {} +;\end{circuitikz} +\end{LTXexample} + +Notice that the text labels of transistors are somewhat buggy. It is better to se explicit anchors to set transistor's names. + +Similarly, transistors like other components can be reflected vertically: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[pigfete, yscale=-1] (pigfete) {} + (pigfete.bulk) node[anchor=west] {Bulk} + (pigfete.G) node[anchor=east] {G} + (pigfete.D) node[anchor=south] {D} + (pigfete.S) node[anchor=north] {S} +;\end{circuitikz} +\end{LTXexample} + +\subsubsection{Transistor paths}\label{sec:transasbip} + +For syntactical convenience transistors can be placed using the normal path notation used for bipoles. The transitor type can be specified by simply adding a ``T'' (for transistor) in front of the node name of the transistor. It will be placed with the base/gate orthogonal to the direction of the path: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[njfet] {1} + (-1,2) to[Tnjfet=2] (1,2) + to[Tnjfet=3, mirror] (3,2); +;\end{circuitikz} +\end{LTXexample} + +Access to the gate and/or base nodes can be gained by naming the transistors with the \texttt{n} or \texttt{name} path style: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw[yscale=1.1, xscale=.8] + (2,4.5) -- (0,4.5) to[Tpmos, n=p1] (0,3) + to[Tnmos, n=n1] (0,1.5) + to[Tnmos, n=n2] (0,0) node[ground] {} + (2,4.5) to[Tpmos,n=p2] (2,3) to[short, -*] (0,3) + (p1.G) -- (n1.G) to[short, *-o] ($(n1.G)+(3,0)$) + (n2.G) ++(2,0) node[circ] {} -| (p2.G) + (n2.G) to[short, -o] ($(n2.G)+(3,0)$) + (0,3) to[short, -o] (-1,3) +;\end{circuitikz} +\end{LTXexample} + +The \texttt{name} property is available also for bipoles, although this is useful mostly for triac, potentiometer and thyristor (see~\ref{sec:othertrip}). + + +\subsection{Electronic Tubes} +\begin{groupdesc} + \circuitdesc*{magnetron}{Magnetron}{}( anode/-90/0.2, cathode1/135/0.2, + cathode2/45/0.2, left/180/0.2, right/0/0.2, top/90/0.4 ) +\end{groupdesc} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,-2)node[rground](gnd){} to[voltage source,v<={HV}]++(0,3)--++(1,0)to[V,n=DC]++(2,0); @@ -646,37 +1713,64 @@ Borsche. Use the package options \texttt{fetsolderdot}/\texttt{nofetsolderdot} t \draw (DC.left)++(-0.2,0)to [short,*-] ++(0,-1) to [short] (magn.cathode1); \draw (DC.right)++(0.2,0)to [short,*-] ++(0,-1) to [short] (magn.cathode2); \draw (magn.anode) to [short] (magn.anode|-gnd) node[rground]{}; - \draw (magn.cathode1)node[above]{$1$}; + \draw (magn.cathode1)node[above]{$1$}; \draw (magn.cathode2)node[above]{$2$}; \draw[->](magn.east) --++(1,0)node[right]{$RF_{out}$}; \end{circuitikz} -\end{LTXexample} +\end{LTXexample} -\subsubsection{Block diagram} -These come from Stefan Erhardt's contribution of block diagram components. Add a box around them with the option \texttt{box}. -\begin{itemize} - \circuititem{mixer}{\scshape mixer}{} - \circuititem{adder}{\scshape adder}{} - \circuititem{oscillator}{\scshape oscillator}{} - \circuititem{circulator}{\scshape circulator}{} - \circuititem{wilkinson}{\scshape wilkinson divider}{} - %\circuititem{coupler}{\scshape coupler}{} - %\circuititem{coupler2}{\scshape coupler2}{} -\end{itemize} +\subsection{RF components} +For the RF components, similarly to the grounds and supply rails, the \texttt{center} anchor is put on the connecting point of the symbol, so that you can use them directly in a \texttt{path} specification. - -\subsubsection{Switch} -\begin{itemize} - \circuititem{spdt}{\scshape spdt}{} - \circuititembip{toggle switch}{Toggle switch}{} -\end{itemize} +Notes that in the transmission and receiving antennas, the ``waves'' are outside the geographical anchors. -\subsubsection{Electro-Mechanical Devices} -\begin{itemize} - \circuititem{elmech}{\scshape Motor}{M} - \circuititem{elmech}{\scshape Generator}{G} -\end{itemize} +\begin{groupdesc} + \circuitdesc*{bareantenna}{Bare Antenna}{A}( top/90/0.1, bottom/180/0.3, left/180/0.3, right/45/0.3, center/0/0.3 ) + \circuitdesc*{bareTXantenna}{Bare TX Antenna}{Tx}( top/90/0.1, center/180/0.3, waves/90/0.3 ) + \circuitdesc*{bareRXantenna}{Bare RX Antenna}{Rx}( top/90/0.1, center/0/0.3, waves/90/0.3 ) + \circuitdescbip*{mstline}{Microstrip transmission line\footnotemark}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + \circuitdesc*{mslstub}{Microstrip stub}{text}(left/135/0.2, right/45/0.2, center/-45/0.3) + \circuitdesc*{msport}{Microstrip port}{T}(left/135/0.2, right/45/0.2, center/-45/0.3) + \circuitdesc*{msrstub}{Microstrip radial stub}{}(left/135/0.2, right/45/0.2, center/-45/0.3) + \footnotetext{This four components were suggested by \texttt{@tcpluess} on GitHub} + \circuitdesc{antenna}{Antenna}{}( center/0/0.3 ) + \circuitdesc{rxantenna}{Receiving antenna}{} + \circuitdesc{txantenna}{Transmitting antenna}{} + \circuitdesc*{tlinestub}{Transmission line stub}{} + \circuitdescbip*[tline]{TL}{Transmission line}{transmission line, tline} + \circuitdesc{match}{match}{} +\end{groupdesc} + + +\subsubsection{Microstrip customization} + +The microstrip linear components' (\texttt{mstline}, \texttt{mslstub}, \texttt{msport}) heights depend on the parameters \texttt{bipoles/mstline/height} (for the three of them, default 0.3). The widths are specified in \texttt{bipoles/mstline/width} for the first two and by \texttt{monopoles/msport/width} for the port (defaults: 1.2, 0.5). + +For the length parameter of the transmission line there is a shortcut in the form of the direct parameter \texttt{mstlinelen}. + +\begin{LTXexample}[varwidth=true, pos=t] +\begin{circuitikz} + \draw (0,0) node[msport, right, xscale=-1]{} + to[mstline, -o] ++(3,0) coordinate(there) + to[mstline, mstlinelen=2, l=longer, o-*] ++(4,0) + coordinate(here) -- ++(0.5,0) node[mslstub, fill=yellow]{stub} + (here) -- ++(0,0.5) node[mslstub, rotate=90, mstlinelen=0.5]{short}; + \draw (there) to[short, o-] ++(0, 0.5) node[msrstub]{}; + \draw (here) -- ++(0, -0.5) node[msrstub, yscale=-1]{}; +\end{circuitikz} +\end{LTXexample} + + +\subsection{Electro-Mechanical Devices} + +The internal part of the motor and generator are, by default, filled white (to avoid compatibility problems with older versions of the package). + +\begin{groupdesc} + \circuitdesc*{elmech}{Motor}{M}( bottom/-90/0.2, + left/180/0.2, right/0/0.2, top/90/0.4 ) + \circuitdesc*{elmech}{Generator}{G} +\end{groupdesc} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (2,0) node[elmech](motor){M}; @@ -691,7 +1785,7 @@ These come from Stefan Erhardt's contribution of block diagram components. Add a \draw[thick,->>](motor.center)--++(1.5,0)node[midway,above]{$\omega$}; \end{circuitikz} \end{LTXexample} -The symbols can also be used along a path, using the transistor-path-syntax(T in front of the shape name, see section \ref{sec:transasbip}). Don´t forget to use parameter $n$ to name the node and get acces to the anchors: +The symbols can also be used along a path, using the transistor-path-syntax(T in front of the shape name, see section \ref{sec:transasbip}). Don´t forget to use parameter $n$ to name the node and get access to the anchors: \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to [Telmech=M,n=motor] ++(0,-3) to [Telmech=M] ++(3,0) to [Telmech=G,n=generator] ++(0,3) to [R] (0,0); @@ -704,55 +1798,563 @@ The symbols can also be used along a path, using the transistor-path-syntax(T in \subsection{Double bipoles} Transformers automatically use the inductor shape currently selected. These are the three possibilities: -\begin{itemize} - \ctikzset{inductor=cute} - \circuititem{transformer}{Transformer (cute inductor)}{} - \ctikzset{inductor=american} - \circuititem{transformer}{Transformer (american inductor)}{} - \ctikzset{inductor=european} - \circuititem{transformer}{Transformer (european inductor)}{} -\end{itemize} +\begin{groupdesc} + \ctikzset{inductor=cute} + \circuitdesc{transformer}{Transformer (cute inductor)}{}( A1/180/0.1, + A2/180/0.1, B1/0/0.1, B2/0/0.1, + inner dot A1/-135/0.2, inner dot A2/135/0.2, inner dot B1/-45/0.1, + inner dot B2/45/0.1 ) + \ctikzset{inductor=american} + \circuitdesc{transformer}{Transformer (american inductor)}{}( % + outer dot A1/180/0.2, outer dot A2/180/0.2, + outer dot B1/0/0.2, outer dot B2/0/0.2 ) + \ctikzset{inductor=european} + \circuitdesc{transformer}{Transformer (european inductor)}{} + \circuitdesc{gyrator}{Gyrator}{} +\end{groupdesc} Transformers with core are also available: -\begin{itemize} - \ctikzset{inductor=cute} - \circuititem{transformer core}{Transformer core (cute inductor)}{} - \ctikzset{inductor=american} - \circuititem{transformer core}{Transformer core (american inductor)}{} - \ctikzset{inductor=european} - \circuititem{transformer core}{Transformer core (european inductor)}{} - \ctikzset{inductor=cute} % reset default -\end{itemize} +\begin{groupdesc} + \ctikzset{inductor=cute} + \circuitdesc{transformer core}{Transformer core (cute inductor)}{} + \ctikzset{inductor=american} + \circuitdesc{transformer core}{Transformer core (american inductor)}{} + \ctikzset{inductor=european} + \circuitdesc{transformer core}{Transformer core (european inductor)}{} + \ctikzset{inductor=cute} % reset default +\end{groupdesc} + + + +\subsubsection{Double dipoles anchors} + +All the double bipoles/quadrupoles have the four anchors, two for each port. +The first port, to the left, is port \texttt{A}, having the anchors \texttt{A1} (up) and \texttt{A2} (down); same for port \texttt{B}. + +They also expose the \texttt{base} anchor, for labelling, and anchors for setting dots or signs to specify polarity. +The set of anchors, to which the standard ``geographical'' \texttt{north}, \texttt{north east}, etc. is here: + +\begin{quote} +\begin{circuitikz}[cute inductors, + ] + \def\coordx(#1)[#2:#3]#4{node[circle, #4, draw, inner sep=1pt,pin={[#4, overlay, inner sep=0.5pt, font=\scriptsize, pin distance=#2cm, pin edge={#4, overlay,}]#3:#1}](#1){}} + \foreach \comp/\pos/\case in {% + transformer/0/0% + ,transformer core/4/1% + ,gyrator/8/2% + }{ + \draw (\pos, 0) node[\comp](T){}; + \ifcase\case + \foreach \a/\d/\t in {inner dot A1/0.2/75, inner dot A2/0.2/-75, inner dot B1/0.1/-45, inner dot B2/0.1/45} + \path (T.\a) \coordx(\a)[\d:\t]{red}; + \or + \foreach \a/\d/\t in {outer dot A1/0.2/75, outer dot A2/0.2/-75, outer dot B1/0.2/-45, outer dot B2/0.2/45} + \path (T.\a) \coordx(\a)[\d:\t]{blue}; + \or + \foreach \a/\t in {A1/120, A2/-120, B1/120, B2/-120, base/-90} + \path (T.\a) \coordx(\a)[0.2:\t]{green!50!black}; + \fi + } +\end{circuitikz} +\end{quote} -\begin{itemize} - \circuititem{gyrator}{Gyrator}{} - \circuititem{coupler}{Coupler}{} - \circuititem{coupler2}{Coupler, 2}{} -\end{itemize} +Also, the standard ``geographical'' \texttt{north}, \texttt{north east}, etc. are defined. +A couple of examples follow: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[transformer] (T) {} + (T.A1) node[anchor=east] {A1} + (T.A2) node[anchor=east] {A2} + (T.B1) node[anchor=west] {B1} + (T.B2) node[anchor=west] {B2} + (T.base) node{K} + (T.inner dot A1) node[circ]{} + (T.inner dot B2) node[circ]{} +;\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[gyrator] (G) {} + (G.A1) node[anchor=east] {A1} + (G.A2) node[anchor=east] {A2} + (G.B1) node[anchor=west] {B1} + (G.B2) node[anchor=west] {B2} + (G.base) node{K} +;\end{circuitikz} +\end{LTXexample} + + + + +\subsection{Amplifiers} + +\begin{groupdesc} + \circuitdesc*{op amp}{Operational amplifier}{}( +/180/0.2, -/180/0.2, out/0/0.2, up/90/0.2, down/-90/0.2 ) + \circuitdesc*{en amp}{Operational amplifier compliant to DIN/EN 60617 standard}{} + \circuitdesc*{fd op amp}{Fully differential operational amplifier\footnotemark}{}( out +/0/0.2, out -/0/0.2 ) + \footnotetext{Contributed by Kristofer M. Monisit.} + \circuitdesc*{gm amp}{transconductance amplifier}{} + \circuitdesc*{inst amp}{plain instrumentation amplifier}{}( up/90/0.2, down/-90/0.2, refv up/45/0.2, refv down/-45/0.2 ) + \circuitdesc*{fd inst amp}{Fully differential instrumentation amplifier}{} + \circuitdesc*{inst amp ra}{instrumentation amplifier with amplification resistance terminals}{}( ra+/180/0.1, ra-/180/0.1 ) + \circuitdesc*{plain amp}{Plain amplifier}{} + \circuitdesc*{buffer}{Buffer}{} +\end{groupdesc} + +\subsubsection{Amplifiers anchors} + +The op amp defines the inverting input (\texttt{-}), the non-inverting input (\texttt{+}) and the output (\texttt{out}) anchors: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[op amp] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out) node[right] {$v_o$} + (opamp.up) --++(0,0.5) node[vcc]{5\,\textnormal{V}} + (opamp.down) --++(0,-0.5) node[vee]{-5\,\textnormal{V}} +;\end{circuitikz} +\end{LTXexample} + +There are also two more anchors defined, \texttt{up} and \texttt{down}, for the power supplies: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[op amp] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out) node[right] {$v_o$} + (opamp.down) node[ground] {} + (opamp.up) ++ (0,.5) node[above] {\SI{12}{\volt}} + -- (opamp.up) +;\end{circuitikz} +\end{LTXexample} + +The fully differential op amp defines two outputs: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[fd op amp] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out +) node[right] {out +} + (opamp.out -) node[right] {out -} + (opamp.down) node[ground] {} +;\end{circuitikz} +\end{LTXexample} + +The instrumentation amplifier inst amp defines also references (normally you use the "down", unless you are flipping the component): +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[inst amp] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out) node[right] {out} + (opamp.up) node[vcc]{} + (opamp.down) node[vee] {} + (opamp.refv down) node[ground]{} + (opamp.refv up) to[short, -o] ++(0,0.3) +;\end{circuitikz} +\end{LTXexample} + +The fully diffential instrumentation amplifier inst amp defines two outputs: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[fd inst amp] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out +) node[right] {out +} + (opamp.out -) node[right] {out -} + (opamp.up) node[vcc]{} + (opamp.down) node[vee] {} + (opamp.refv down) node[ground]{} + (opamp.refv up) to[short, -o] ++(0,0.3) +;\end{circuitikz} +\end{LTXexample} + +The instrumentation amplifier with resistance terminals (\texttt{inst amp ra}) defines also terminals to add an amplification resistor: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[inst amp ra] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out) node[right] {out} + (opamp.up) node[vcc]{} + (opamp.down) node[vee] {} + (opamp.refv down) node[ground]{} + (opamp.refv up) to[short, -o] ++(0,0.3) + (opamp.ra-) to[R] (opamp.ra+) +;\end{circuitikz} +\end{LTXexample} + +\subsubsection{Amplifiers customization} + +All these amplifier have the possibility to flip input and output (if needed) polarity. You can change polarity of the input with the +\texttt{noinv input down} (default) or \texttt{noinv input up} key; and the output with \texttt{noinv output up} (default) or \texttt{noinv output down} key: +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[fd inst amp, + noinv input up, + noinv output down] (opamp) {} + (opamp.+) node[left] {$v_+$} + (opamp.-) node[left] {$v_-$} + (opamp.out +) node[right] {out +} + (opamp.out -) node[right] {out -} + (opamp.up) node[vcc]{} + (opamp.down) node[vee] {} + (opamp.refv down) node[ground]{} + (opamp.refv up) to[short, -o] ++(0,0.3) +;\end{circuitikz} +\end{LTXexample} + +When you use the \texttt{noinv input/output ...} keys the anchors (\texttt{+}, \texttt{-}, \texttt{out +}, \texttt{out -}) will change with the effective position of the terminals. You have also the anchors \texttt{in up}, \texttt{in down}, \texttt{out up}, \texttt{out down} that will not change with the positive or negative sign. + +\paragraph{European-style amplifier customization} + +Thanks to the suggestions from David Rouvel (\email{david.rouvel@iphc.cnrs.fr}) there are several possible customization for the European-style amplifiers. + +Since 0.9.0, the default appearance of the symbol has changed to be more in line with the standard; notice that to have a bigger triangle by default we should require more packages, and I fear {Con\TeX t} compatibility; but see later on how to change it. Notice that the font used for the symbol is defined in \texttt{tripoles/en amp/font2} and that the font used for the \texttt{+} and \texttt{-} symbols is \texttt{tripoles/en amp/font}. + +You can change the distances of the inputs, using \texttt{tripoles/en amp/input height} (default 0.3): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{tripoles/en amp/input height=0.45} + \draw (0,0)node[en amp](E){} + (E.out) node[right] {$v_{\mathrm{out}}$} + (E.-) node[left] {$v_{\mathrm{in}-}$} + (E.+) node[left] {$v_{\mathrm{in}+}$}; +\end{circuitikz} +\end{LTXexample} + +and of course the key \texttt{noinv input up} is fully functional: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{tripoles/en amp/input height=0.45} + \draw (0,0)node[en amp, noinv input up](E){} + (E.out) node[right] {$v_{\mathrm{out}}$} + (E.-) node[left] {$v_{\mathrm{in}-}$} + (E.+) node[left] {$v_{\mathrm{in}+}$}; +\end{circuitikz} +\end{LTXexample} + +To flip the amplifier in the horizontal direction, you can use \texttt{xscale=-1} as usual: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{tripoles/en amp/input height=0.45} + \draw (0,0)node[en amp, xscale=-1, noinv input up](E){} + (E.out) node[left] {$v_{\mathrm{out}}$} + (E.-) node[right] {$v_{\mathrm{in}-}$} + (E.+) node[right] {$v_{\mathrm{in}+}$}; +\end{circuitikz} +\end{LTXexample} + +Notice that the label is fully mirrored, so check below for the generic way of changing this. + +You can use the new key \texttt{en amp text A} to change the infinity symbol with an A: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0)node[en amp, en amp text A](E){} + (E.out) node[right] {$v_{\mathrm{out}}$} + (E.-) node[left] {$v_{\mathrm{in}-}$} + (E.+) node[left] {$v_{\mathrm{in}+}$} ; +\end{circuitikz} +\end{LTXexample} + +And if you want, you can completely change the text using the key \texttt{en amp text={}}, which by default is \verb|$\mathstrut{\triangleright}\,{\infty}$|: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0)node[en amp, en amp text={% + ${\triangleright}$ \small 200}](E){} + (E.out) node[right] {$v_{\mathrm{out}}$} + (E.-) node[left] {$v_{\mathrm{in}-}$} + (E.+) node[left] {$v_{\mathrm{in}+}$} ; +\end{circuitikz} +\end{LTXexample} + +Notice two things here: the first, that \verb|\triangleright| is enclosed in braces to remove the default spacing it has as a binary operator, and that \texttt{en amp text A} is simply a shortcut for + +\begin{lstlisting} + en amp text={$\mathstrut{\triangleright}\,\mathrm{A}$} +\end{lstlisting} + + +To combine flipping with a generic label you just do: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0)node[en amp, xscale=-1, en amp text A](E){} + (E.out) node[left] {$v_{\mathrm{out}}$} + (E.-) node[right] {$v_{\mathrm{in}-}$} + (E.+) node[right] {$v_{\mathrm{in}+}$} ; +\end{circuitikz} +\end{LTXexample} + +But notice that the ``A'' is also flipped by the \texttt{xscale} parameter. So the solution in this case is to use \texttt{scalebox}, like this: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0)node[en amp, xscale=-1, en amp text={% + ${\triangleright}$ \scalebox{-1}[1]{\small 200}}](E){} + (E.out) node[left] {$v_{\mathrm{out}}$} + (E.-) node[right] {$v_{\mathrm{in}-}$} + (E.+) node[right] {$v_{\mathrm{in}+}$} ; +\end{circuitikz} +\end{LTXexample} + + +\subsection{Support shapes and bipoles}\label{sec:support} + +Path style: +\begin{groupdesc} +\circuitdescbip{crossing}{Jumper style non-contact crossing}{xing} +\end{groupdesc} + +\noindent Node style: + +\begin{groupdesc} + \circuitdesc{currarrow}{Arrows (current and voltage)}{} + \circuitdesc{inputarrow}{Arrow to draw at its tip, useful for block diagrams.}{} + \circuitdesc{circ}{Connected terminal}{} + \circuitdesc{ocirc}{Unconnected terminal}{} + \circuitdesc{diamondpole}{Diamond-style terminal}{} + \circuitdesc{jump crossing}{Jumper-style crossing node}{} + \circuitdesc{plain crossing}{Plain style crossing node}{} + \circuitdesc{waves}{Waves}{}( north/90/0.4, north east/45/0.4, east/-45/0.4, south east/-45/0.4, + south/-90/0.4, south west/-135/0.4, west/180/0.4, north west/135/0.4, + left/135/0.2, top/45/0.2, right/45/0.2, bottom/-45/0.2 ) + \circuitdesc*{bnc}{BNC connector}{}(left/135/0.6, right/45/0.6, center/-90/0.6, hot/0/0.6, zero/-135/0.6) +\end{groupdesc} + +Moreover, you have the arrow tip \texttt{latexslim} which is an arrow similar to the old (in deprecated \texttt{arrows} library) \texttt{latex'} element: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american,] + \draw [latexslim-latexslim] (0,0) -- (1,0); +\end{circuitikz} +\end{LTXexample} + + + +\subsubsection{Terminal shapes} +Since version 0.9.0, \texttt{circ}, \texttt{ocirc} , and \texttt{diamondpole} have all the standard geographical anchors, so you can do things like these: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american,] + \draw (0,-1) node[draw](R){R}; + \draw (R.east) node[ocirc, right]{}; +\end{circuitikz} +\end{LTXexample} +The BNC connector is defined so that you can easily connect it as input or output (but remember that you need to flip the text if you flip the component): + +\begin{LTXexample}[varwidth, ] +\begin{circuitikz} + \draw (0,0) + node[bnc](B1){$v_i$} to[R=\SI{50}{\ohm}] ++(3,0) + node[bnc, xscale=-1](B2){\scalebox{-1}[1]{$v_o$}}; + \node [ground] at (B1.shield) {}; + \node [eground] at (B2.shield){}; +\end{circuitikz} +\end{LTXexample} + +It also has a \texttt{zero} anchor if you need to rotate it about its real center. + +\begin{LTXexample}[varwidth, ] +\begin{circuitikz} + \draw[thin, red] (0,0) -- ++(1,0) (0,-1) -- ++(1,0); + \path (0,0) node[bnc]{} ++(1,0) node[bnc, rotate=-90]{}; + \path (0,-1) node[bnc, anchor=zero]{} ++(1,0) node[bnc, anchor=zero, rotate=-90]{}; +\end{circuitikz} +\end{LTXexample} + +\subsubsection{Crossings} + +All circuit-drawing standards agree that to show a crossing without electric contact, a simple crossing of the wires suffices; the electrical contact must be explicitly marked with a filled dot. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[] +\draw(1,-1) to[short] (1,1) + (0,0) to[short] (2,0); +\draw(4,-1) to[short] (4,1) + (3,0) to[short] (5,0) + (4,0) node[circ]{}; +\end{circuitikz} +\end{LTXexample} + +However, sometime it is advisable to mark the non-contact situation more explicitly. To this end, you can use a path-style component called \texttt{crossing}: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[] +\draw(1,-1) to[short] (1,1) (0,0) to[crossing] (2,0); +\draw(4,-1) to[short] (4,1) (3,0) to[short] (5,0) + (4,0) node[circ]{}; +\end{circuitikz} +\end{LTXexample} + +That should suffice most of the time; the only problem is that the crossing jumper will be put in the center of the subpath where the \texttt{to[crossing]} is issued, so sometime a bit of trial and error is needed to position it. + +For a more powerful (and elegant) way you can use the crossing nodes: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[] + \node at (1,1)[jump crossing](X){}; + \draw (X.west) -- ++(-1,0); + \draw (X.east) to[R] ++(2,0); + \draw (X.north) node[vcc]{}; + \draw (X.south) to[C] ++(0,-1.5); +\end{circuitikz} +\end{LTXexample} + +Notice that the \texttt{plain crossing} and the \texttt{jump crossing} have a small gap in the straight wire, to enhance the effect of crossing (as a kind of shadow). + +The size of the crossing elements can be changed with the key \texttt{bipoles/crossing/size} (default 0.2). + + +\subsubsection{Arrows size} + +You can use the parameter \texttt{current arrow scale} to change the size of the arrows in various components and indicators; the normal value is 16, higher numbers give smaller arrows and so on. You need to use \texttt{circuitikz/current arrow scale} if you use it into a node. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) to[R, i=f] ++(2,0) node[npn, anchor=B]{}; + \draw (0,-2) to[R, f=f, current arrow scale=8] ++(2,0) + node[pnp, anchor=B, circuitikz/current arrow scale=8]{}; + \draw (0,-4) to[R, f=f, current arrow scale=24] ++(2,0) + node[nigbt, anchor=B]{}; +\end{circuitikz} +\end{LTXexample} + +\subsection{Switches and buttons} + +Switches and button come in to-style (the simple ones and the pushbuttons), and as nodes. + +\subsubsection{Traditional switches} +These are all of the to-style type: + +\begin{groupdesc} + \circuitdescbip[cspst]{switch}{Switch}{spst} + \circuitdescbip[cspst]{closing switch}{Closing switch}{cspst} + \circuitdescbip[ospst]{opening switch}{Opening switch}{ospst} + \circuitdescbip[nos]{normal open switch}{Normally open switch}{nos} + \circuitdescbip[ncs]{normal closed switch}{Normally closed switch}{ncs} + \circuitdescbip[pushbutton]{push button}{Normally open push button}{normally open push button, nopb} + \circuitdescbip[ncpushbutton]{normally closed push button}{Normally closed push button}{ncpb} + \circuitdescbip[toggleswitch]{toggle switch}{Toggle switch}{} +\end{groupdesc} + +while this is a node-style component: + +\begin{groupdesc} + \circuitdesc{spdt}{spdt}{}( in/180/0.2, out 1/0/0.2, out 2/0/0.2 ) +\end{groupdesc} + +\subsubsection{Cute switches} +These switches have been introduced after version 0.9.0, and they come in also in to-style and in node-style, but they are size-matched so that they can be used together in a seamless way. + +The path element (to-style) are: +\begin{groupdesc} + \circuitdescbip[cuteclosedswitch]{cute closed switch}{Cute closed switch}{ccsw}(mid/90/0.2, in/-135/0.2, out/-45/0.2) + \circuitdescbip[cuteopenswitch]{cute open switch}{Cute open switch}{cosw} + \circuitdescbip[cuteclosingswitch]{cute closing switch}{Cute closing switch}{ccgsw} + \circuitdescbip[cuteopeningswitch]{cute opening switch}{Cute opening switch}{cogsw} +\end{groupdesc} +while the node-style components are the single-pole, double-throw (\texttt{spdt}) ones: +\begin{groupdesc} + \circuitdesc{cute spdt up}{Cute spdt up}{}( in/180/0.2, out 1/0/0.2, out 2/0/0.2 , mid/0/0.4) + \circuitdesc{cute spdt mid}{Cute spdt mid}{} + \circuitdesc{cute spdt down}{Cute spdt down}{}(mid/0/0.4) + \circuitdesc{cute spdt up arrow}{Cute spdt up with arrow}{} + \circuitdesc{cute spdt mid arrow}{Cute spdt mid with arrow}{} + \circuitdesc{cute spdt down arrow}{Cute spdt down with arrow}{} +\end{groupdesc} + +\subsubsection{Switches anchors} + +The nodes-style switches have the following anchors: + +\bigskip +\begin{circuitikz} + \def\coorda(#1)<#2>{node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\small, pin distance=0.1cm, pin edge={red, overlay,}]#2:#1}](#1){}} + \path (0,-1) -- (3,1); %bbox + \draw (0, 0) node[cute spdt up arrow](CS){}; + \draw (2, 0) node[cute spdt up arrow](CS){}; + \foreach \a/\b in {center/0, in/-135, out 1/45, out 2/-45, mid/135} + \path (CS.\a) \coorda(\a)<\b>; +\end{circuitikz} + + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) node[spdt] (Sw) {} + (Sw.in) node[left] {in} + (Sw.out 1) node[right] {out 1} + (Sw.out 2) node[right] {out 2} +;\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,0) to[C] (1,0) to[toggle switch , n=Sw] (2.5,0) + -- (2.5,-1) to[battery1] (1.5,-1) to[R] (0,-1) -| (0,0) + (Sw.out 2) -| (2.5, 1) to[R] (0,1) -- (0,0) +;\end{circuitikz} +\end{LTXexample} + +The \texttt{mid} anchor in the cute switches (both path- and node-style) can be used to combine switches to get more complex configurations: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,1.4) node[cute spdt up](S1){}; + \draw (0,0) node[cute spdt up](S2){}; + \draw (0,-1) node[cuteclosedswitchshape, yscale=-1](S3){}; + \draw [densely dashed] (S1.mid)--(S2.mid)--(S3.mid); +\end{circuitikz} +\end{LTXexample} + +\subsubsection{Cute switches customization} + +You can use the key \texttt{bipoles/cuteswitch/thickness} to decide the thickness of the switch lever. The units are the diameter of the \texttt{ocirc} connector, and the default is \texttt{1}. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{bipoles/cuteswitch/thickness=0.5} + \draw (0,1.4) node[cute spdt up](S1){}; + \draw (0,0) node[cute spdt up](S2){}; + \draw (0,-1) node[cuteclosedswitchshape, yscale=-1](S3){}; + \draw [densely dashed] (S1.mid)--(S2.mid)--(S3.mid); +\end{circuitikz} +\end{LTXexample} \subsection{Logic gates} + +Logic gates, with two or more input, are supported. Albeit in principle these components are multipoles, the are considered tripoles here, for historical reasons (when they just had two inputs). + \subsubsection{American Logic gates} -\begin{itemize} - \circuititem{american and port}{American \textsc{and} port}{} - \circuititem{american or port}{American \textsc{or} port}{} - \circuititem{american not port}{American \textsc{not} port}{} - \circuititem{american nand port}{American \textsc{nand} port}{} - \circuititem{american nor port}{American \textsc{nor} port}{} - \circuititem{american xor port}{American \textsc{xor} port}{} - \circuititem{american xnor port}{American \textsc{xnor} port}{} -\end{itemize} +\begin{groupdesc} + \circuitdesc*{american and port}{American \textsc{and} port}{}( in 1/180/0.2, in 2/180/0.2, out/0/0.2 ) + \circuitdesc*{american or port}{American \textsc{or} port}{}( bin 1/135/0.2, bin 2/-135/0.2, bout/-45/0.2 ) + \circuitdesc*{american not port}{American \textsc{not} port}{} + \circuitdesc*{american nand port}{American \textsc{nand} port}{} + \circuitdesc*{american nor port}{American \textsc{nor} port}{} + \circuitdesc*{american xor port}{American \textsc{xor} port}{} + \circuitdesc*{american xnor port}{American \textsc{xnor} port}{} +\end{groupdesc} \subsubsection{European Logic gates} -\begin{itemize} - \circuititem{european and port}{European \textsc{and} port}{} - \circuititem{european or port}{European \textsc{or} port}{} - \circuititem{european not port}{European \textsc{not} port}{} - \circuititem{european nand port}{European \textsc{nand} port}{} - \circuititem{european nor port}{European \textsc{nor} port}{} - \circuititem{european xor port}{European \textsc{xor} port}{} - \circuititem{european xnor port}{European \textsc{xnor} port}{} -\end{itemize} +\begin{groupdesc} + \circuitdesc*{european and port}{European \textsc{and} port}{}( in 1/180/0.2, in 2/180/0.2, out/0/0.2 ) + \circuitdesc*{european or port}{European \textsc{or} port}{} + \circuitdesc*{european not port}{European \textsc{not} port}{} + \circuitdesc*{european nand port}{European \textsc{nand} port}{} + \circuitdesc*{european nor port}{European \textsc{nor} port}{} + \circuitdesc*{european xor port}{European \textsc{xor} port}{} + \circuitdesc*{european xnor port}{European \textsc{xnor} port}{} +\end{groupdesc} \begin{framed} If (default behaviour) \texttt{americanports} option is active (or the style \texttt{[american ports]} is used), the shorthands \texttt{and port}, \texttt{or port}, \texttt{not port}, \texttt{nand port}, \texttt{not port}, \texttt{xor port}, and \texttt{xnor port} are equivalent to the american version of the respective logic port. @@ -760,65 +2362,330 @@ If (default behaviour) \texttt{americanports} option is active (or the style \te If otherwise \texttt{europeanports} option is active (or the style \texttt{[european ports]} is used), the shorthands \texttt{and port}, \texttt{or port}, \texttt{not port}, \texttt{nand port}, \texttt{not port}, \texttt{xor port}, and \texttt{xnor port} are equivalent to the european version of the respective logic port. \end{framed} -\begin{itemize} - \circuititem{schmitt}{Non-Inverting \textsc{Schmitttrigger}}{} - \circuititem{invschmitt}{Inverting \textsc{Schmitttrigger}}{} -\end{itemize} -\subsection{Amplifiers} +\subsubsection{Special components} -\begin{itemize} - \circuititem{op amp}{Operational amplifier}{} - \circuititem{en amp}{Operational amplifier compliant to DIN/EN 60617 standard}{} - \circuititem{fd op amp}{Fully differential operational amplifier\footnote{Contributed by Kristofer M. Monisit.}}{} - \circuititem{gm amp}{transconductance amplifier}{} - \circuititem{plain amp}{Plain amplifier}{} - \circuititem{buffer}{Buffer}{} -\end{itemize} +There is no ``european'' version of these symbols. -\subsection{Support shapes} +\begin{groupdesc} + \circuitdesc*{schmitt}{Non-Inverting \textsc{Schmitttrigger}}{} + \circuitdesc*{invschmitt}{Inverting \textsc{Schmitttrigger}}{} +\end{groupdesc} -\begin{itemize} - \circuititem{currarrow}{Arrows (current and voltage)}{} - \circuititem{inputarrow}{Arrow to draw at its tip, useful for block diagrams.}{} - \circuititem{circ}{Connected terminal}{} - \circuititem{ocirc}{Unconnected terminal}{} - \circuititem{diamondpole}{Diamond-style terminal}{} -\end{itemize} +\subsubsection{Logic port customization} + +As for most components, you can change the width and height of the ports; the thickness is given by the parameter \texttt{tripoles/thickness} (default 2): + +\begin{LTXexample}[varwidth=true] +\tikz \draw (0,0) node[nand port] {}; \par +\ctikzset{tripoles/american nand port/input height=.2} +\ctikzset{tripoles/american nand port/port width=.4} +\ctikzset{tripoles/thickness=4} +\tikz \draw (0,0) node[nand port] {}; +\end{LTXexample} + +This is especially useful if you have ports with more than two inputs, which are instantiated +with the parameter \texttt{number inputs} : + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} +\draw (0,3) node[american and port] (A) {P1}; +\begin{scope} + \ctikzset{tripoles/american or port/height=1.6} + \draw (A.out) -- ++(0.5,0) + node[american or port, + number inputs=5, + anchor=in 1] (B) {P2}; +\end{scope} +\draw (0,1.5) node[american or port] (C) {P3}; +\draw (C.out) |- (B.in 2); +\end{circuitikz} +\end{LTXexample} + +You can tweak the appearance of american ``or'' family (\texttt{or}, \texttt{nor}, \texttt{xor} and \texttt{xnor}) ports, too, with the parameters \texttt{inner} (how much the base circle go ``into'' the shape, default 0.3) and \texttt{angle} (the angle at which the base starts, default 70). + +\begin{LTXexample}[varwidth=true] +\tikz \draw (0,0) node[xnor port] {}; +\ctikzset{tripoles/american xnor port/inner=.7} +\ctikzset{tripoles/american xnor port/angle=40} +\tikz \draw (0,0) node[xnor port] {}; +\end{LTXexample} + +\subsubsection{Logic port anchors} + +These are the anchors for logic ports: + +\bigskip +\begin{circuitikz} [american] +\def\coorda(#1)<#2>{node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\small, pin distance=0.1cm, pin edge={red, overlay,}]#2:#1}](#1){}} +\path(-2,1) -- (11,-1); + +\draw (0,0) node[and port, number inputs=3](A){IC1} ; + \foreach \a/\d in {left/45, right/45, out/-45, in 1/135, in 2/135, in 3/135} + \path (A.\a) \coorda(\a)<\d>; + +\draw (4.5,0) node[and port, number inputs=3](A){IC1}; + \foreach \a/\d in {north/90, north west/135, west/180, south west/-135, + south/-90, south east/45, east/45, north east/45} + \path (A.\a) \coorda(\a)<\d>; + +\draw (9,0) node[european and port, ](A){} ; + \foreach \a/\d in {left/45, right/45, center/-90} + \path (A.\a) \coorda(\a)<\d>; +\end{circuitikz} +\bigskip + +You have also ``border pin anchors'': + +\bigskip +\begin{circuitikz} [american] +\def\coorda(#1)<#2>{node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\small, pin distance=0.1cm, pin edge={red, overlay,}]#2:#1}](#1){}} +\path(-2,1) -- (11,-1); + +\draw (0,0) node[american and port, number inputs=3](A){IC1} ; + \foreach \a/\d in {bin 1/-135, bin 2/-135, bin 3/-135, bout/-45} + \path (A.\a) \coorda(\a)<\d>; + +\draw (4.5,0) node[american or port, number inputs=3](A){IC1}; + \foreach \a/\d in {bin 1/-135, bin 2/-135, bin 3/-135, bout/-45} + \path (A.\a) \coorda(\a)<\d>; + +\draw (9,0) node[european and port, ](A){} ; + \foreach \a/\d in {bin 1/-135, bin 2/-135, bout/-45} + \path (A.\a) \coorda(\a)<\d>; +\end{circuitikz} +\bigskip + +These anchors are especially useful if you want to negate inputs: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} +\draw (0,3) node[american and port] (A) {P1}; +\node at (A.bin 1) [ocirc, left]{} ; +\begin{scope} + \ctikzset{tripoles/american or port/height=1.6} + \draw (A.out) -- ++(0.5,0) node[american or port, + number inputs=5, anchor=in 1] (B) {P2}; + \node at (B.bin 3) [ocirc, left]{} ; +\end{scope} +\draw (0,1.5) node[american or port] (C) {P3}; +\node at (C.bin 2) [ocirc, left]{} ; +\draw (C.out) |- (B.in 2); +\end{circuitikz} +\end{LTXexample} +As you can see, the \texttt{center} anchor is (for historic reasons) not in the center at all. You can fix this with the command \verb|\ctikzset{logic ports origin=center}|: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} +\ctikzset{logic ports origin=center} +\draw (0,0) node[and port] (myand) {} + (myand.in 1) node[anchor=east] {1} + (myand.in 2) node[anchor=east] {2} + (myand.out) node[anchor=west] {3}; +\draw[<-] (myand.center) -- ++(1,-1) + node{center}; +\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (0,2) node[and port] (myand1) {} + (0,0) node[and port] (myand2) {} + (2,1) node[xnor port] (myxnor) {} + (myand1.out) -| (myxnor.in 1) + (myand2.out) -| (myxnor.in 2) +;\end{circuitikz} +\end{LTXexample} + +In the case of \textsc{not}, there are only \texttt{in} and \texttt{out} (although for compatibility reasons \texttt{in 1} is still defined and equal to \texttt{in}): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} \draw + (1,0) node[not port] (not1) {} + (3,0) node[not port] (not2) {} + (0,0) -- (not1.in) + (not2.in) -- (not1.out) + ++(0,-1) node[ground] {} to[C] (not1.out) + (not2.out) -| (4,1) -| (0,0) +;\end{circuitikz} +\end{LTXexample} + + + +\subsection{Chips} +%%% This chapter is in the new format --- description and components. +%%% The idea is to try to reorganize the manual before the next release. +%%% See issue #24 + +\texttt{CircuiTikZ} supports two types of variable-pin chips: DIP (Dual-in-Line Package) and QFP (Quad-Flat Package). +\begin{groupdesc} + \circuitdesc*{dipchip}{Dual-in-Line Package chip}{} + \circuitdesc*{qfpchip}{Quad-Flat Package chip}{} +\end{groupdesc} + +\subsubsection{DIP and QFP chips customization} + +You can customize the DIP chip with the keys \texttt{multipoles/dipchip/width} (default 1.2) and \texttt{multipoles/dipchip/pin spacing} (default 0.4) that are expressed in fraction of basic lengths (see section~\ref{sec:components-size}). +The height of the chip will be equal to half the numbers of pins multiplied by the spacing, plus one spacing for the borders. +For the QFP chips, you can only chose the pin spacing with \texttt{multipoles/qfpchip/pin spacing} key. + +The pins of the chip can be ``hidden'' (that is, just a spot in the border, optionally marked with a number) or ``stick out'' with a thin lead by setting \texttt{multipoles/external pins width} greater than 0 (default value is 0.2, so you'll have leads as shown above). +Moreover, you can transform the thin lead into a pad by setting the key \texttt{multipoles/external pad fraction} to something different form 0 (default is 0); the value expresses the fraction of the pin spacing space that the pad will use on both sides of the pin. + +The number of pins is settable with the key \texttt{num pins}. +\textbf{Please notice} that the number of pins \textbf{must} be \emph{even} for \texttt{dipchip}s and \emph{multiple of 4} for \texttt{qfpchip}s, otherwise havoc will ensue. + +You can, if you want, avoid printing the numbers of the pin with \texttt{hide numbers} (default \texttt{show numbers}) if you prefer positioning them yourself (see the next section for the anchors you can use). +The font used for the pins is adjustable with the key \texttt{multipoles/font} (default \verb|\tiny|) +For special use you can suppress the orientation mark with the key \texttt{no topmark} (default \texttt{topmark}). + +The line thickness of the main shape is controlled by \texttt{multipoles/thickness} (default 2) and the one of the external pins/pads with \texttt{multipoles/external pins thickness} (default 1). + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz} + \ctikzset{multipoles/thickness=4} + \ctikzset{multipoles/external pins thickness=2} + \draw (0,0) node[dipchip, + num pins=12, + hide numbers, + external pins width=0.3, + external pad fraction=4 ](C){IC1}; + \draw (C.pin 1) -- ++(-0.5,0) to[R] + ++(0,-3) node[ground]{}; + \node [right, font=\tiny] + at (C.bpin 1) {RST}; + \end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz} + \draw (0,0) node[dipchip, + num pins=8, + external pins width=0.0](C){IC1}; + \draw (C.pin 1) -- ++(-0.5,0) to[R] + ++(0,-1.5) node[ground]{}; + \end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz} + \ctikzset{multipoles/font={\color{red}\tiny}} + \draw (0,0) node[qfpchip, + num pins=16, + external pad fraction=6](C){IC1}; + \draw (C.pin 1) -- ++(-0.5,0) to[R] + ++(0,-2) node[ground]{}; + \end{circuitikz} +\end{LTXexample} + +\subsubsection{Chips anchors} + +Chips have anchors on pins and global anchors for the main shape. +The pin anchors to be used to connect wires to the chip are called \texttt{pin 1}, \texttt{pin 2} , \dots, with just one space between \texttt{pin} and the number. +Border pin anchors (\texttt{bpin 1}\dots) are always on the box border, and can be used to add numbers or whatever markings are needed. +Obviously, in case of \texttt{multipoles/external pins width} equal to zero, border and normal pin anchors will coincide. + +Additionally, you have geometrical anchors on the chip ``box'', see the following figure. The nodes are available with the full name (like \texttt{north}) and with the short abbreviations \texttt{n}, \texttt{nw}, \texttt{w}\dots. The \texttt{dot} anchor is useful to add a personalized marker if you use the \texttt{no topmark} key. + +\begin{quote} + \bigskip + \def\coord(#1){node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\scriptsize, pin distance=0.2cm, fill=white, fill opacity=0.5, text opacity=1, pin edge={red, overlay,}]75:#1}](#1){}} + \def\coordd(#1){node[circle, red, draw, inner sep=1pt,pin={[red, overlay, inner sep=0.5pt, font=\scriptsize, pin distance=0.2cm, fill=white, fill opacity=0.5, text opacity=1,pin edge={red, overlay,}]-45:#1}](#1){}} + \begin{circuitikz}[american, ] + \ctikzset{multipoles/dipchip/pin spacing=0.7} + \draw (0,0) node[dipchip, + external pins width=0.4, + external pad fraction=4](C){IC1}; + \foreach \p in {1,...,8} + \path (C.pin \p) \coord(pin \p) + (C.bpin \p) \coordd(bpin \p); + % second chip + \draw (C.pin 7) to[R] ++(3,0) + node[dipchip,anchor=pin 2](D){IC2}; + \foreach \p in {center, nw, ne, se, sw, north, south, west, east} + \path (D.\p) \coord(\p); + \path (D.text) \coordd(text); + % third chip + \draw (D.pin 7) ++(2,0) + node[dipchip,anchor=pin 2, no topmark](E){}; + \foreach \p in {center, n, w, e, s, dot} + \path (E.\p) \coord(\p); + \end{circuitikz} +\end{quote} + +\subsubsection{Chips rotation} + +You can rotate chips, and normally the pin numbers are kept straight (option \texttt{straight numbers}, which is the default), but you can rotate them if you like with \texttt{rotated numbers}. +Notice that the main label has to be (counter-) rotated manually in this case. + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) node[dipchip, + rotate=90]{% + \rotatebox{-90}{IC2}}; + \draw (3,0) node[qfpchip, + rotated numbers, + rotate=45]{IC3}; +\end{circuitikz} +\end{LTXexample} +\subsubsection{Chip special usage} +You can use chips to have special, personalized blocks. +Look at the following example, which is easily put into a macro. -\section{Usage} +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \ctikzset{multipoles/thickness=3} + \ctikzset{multipoles/dipchip/width=2} + \draw (0,0) node[dipchip, + num pins=10, hide numbers, no topmark, + external pins width=0](C){Block}; + \node [right, font=\tiny] at (C.bpin 1) {RST}; + \node [right, font=\tiny] at (C.bpin 2) {IN1}; + \node [right, font=\tiny] at (C.bpin 4) {/IN2}; + \node [left, font=\tiny] at (C.bpin 8) {OUT}; + \draw (C.bpin 2) -- ++(-0.5,0) coordinate(extpin); + \node [ocirc, anchor=0](notin2) at (C.bpin 4) {}; + \draw (notin2.180) -- (C.bpin 4 -| extpin); + \draw (C.bpin 8) to[short,-o] ++(0.5,0); + \draw (C.bpin 5) ++(0,0.1) -- ++(0.1,-0.1) + node[right, font=\tiny]{CLK} -- ++(-0.1,-0.1); + \draw (C.n) -- ++(0,1) node[vcc]{}; + \draw (C.s) -- ++(0,-1) node[ground]{}; +\end{circuitikz}\end{LTXexample} + +\section{Labels and similar annotations} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, l=$R_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R=$R_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, v=$v_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R=$R_1$, i=$i_1$, v=$v_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} @@ -830,11 +2697,12 @@ If otherwise \texttt{europeanports} option is active (or the style \texttt{[euro Long names/styles for the bipoles can be used: \begin{LTXexample}[varwidth=true] \begin{circuitikz}\draw - (0,0) to[resistor=1<\kilo\ohm>] (2,0) + (0,0) to[resistor=1<\kilo\ohm>] (2,0) ;\end{circuitikz} \end{LTXexample} \subsection{Labels and Annotations} +\label{sec:labels-and-annotations} Since Version 0.7, beside the original label (l) option, there is a new option to place a second label, called annotation (a) at each bipole. Up to now this is a beta-test and there can be problems. For example, up to now this option is not compatible with the concurrent use of voltage labels. The position of (a) and (l) labels can be adjusted with \_ and \^, respectively. @@ -843,13 +2711,29 @@ The position of (a) and (l) labels can be adjusted with \_ and \^, respectively. \begin{circuitikz} \draw (0,0) to[R, l=$R_1$,a=1<\kilo\ohm>] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, l_=$R_1$,a^=1<\kilo\ohm>] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} + +\textbf{Caveat:} notice that the way in which \texttt{circuitikz} processes the options, there will be problems if the label (or annotation, or voltage, or current) contains one of the characters $=$ (equal) or $,$ (comma), giving unexpected errors and wrong output. +These two characters must be protected to the option parser using an \verb|\mbox| command, or redefining the characters with a \TeX\ \verb|\def|: + +\begin{LTXexample}[varwidth=true] + \def\eq{=} + \begin{circuitikz} + % the following will fail: + % \draw (0,0) to[R, l={$R=3}] (3,0); + \draw (0,0) to[R, l=\mbox{$R=3$}] (3,0); + \draw (0,0) to[R, l=$R\eq3$] (0,3); + \draw (3,3) to[R, l=\mbox{$R,3$}] (3,0); + % this works, but it has wrong spacing + \draw (0,3) to[R, l=$R{=}3$] (3,3); + \end{circuitikz} +\end{LTXexample} \noindent The default orientation of labels is controlled by the options \texttt{smartlabels}, \texttt{rotatelabels} and \texttt{straightlabels} (or the corresponding \texttt{label/align} keys). Here are examples to see the differences: \begin{LTXexample}[varwidth=true] @@ -860,7 +2744,7 @@ The position of (a) and (l) labels can be adjusted with \_ and \^, respectively. \draw (0,0) to[R=\i, *-o] (\i:2.5); } \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \ctikzset{label/align = rotate} @@ -869,7 +2753,7 @@ The position of (a) and (l) labels can be adjusted with \_ and \^, respectively. \draw (0,0) to[R=\i, *-o] (\i:2.5); } \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \ctikzset{label/align = smart} @@ -878,84 +2762,184 @@ The position of (a) and (l) labels can be adjusted with \_ and \^, respectively. \draw (0,0) to[R=\i, *-o] (\i:2.5); } \end{circuitikz} -\end{LTXexample} +\end{LTXexample} + +You also can use stacked (two lines) labels. The example should be self-explanatory: the two lines are specified as \texttt{l2=}\emph{line1}\texttt{ and }\emph{line2}. You can use the keys \texttt{l2 halign} to control horizontal position (\texttt{l}eft, \texttt{c}enter, \texttt{r}ight) and \texttt{l2 valign} to control the vertical one (\texttt{b}ottom, \texttt{c}center, \texttt{t}op). + + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz}[ american, ] + % + % default is l2 halign=l, l2 valign=c + % + \draw (0,0) to[R, l2_=$R_{CC}$ and \SI{4.7}{k\ohm}, , l2 valign=t] (2,0); + \draw (0,0) to[R, l2_=$R_{CC}$ and \SI{4.7}{k\ohm}, , ] (0,2); + \draw (0,0) to[R, l2_=$R_{CC}$ and \SI{4.7}{k\ohm}, l2 halign=c, l2 valign=b] (-2,0); + \draw (0,0) to[R, l2_=$R_{CC}$ and \SI{4.7}{k\ohm}, l2 halign=r, l2 valign=c] (0, -2); + \end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz}[ american, ] + \draw (0,0) to[R, l2^=$R_{CC}$ and \SI{4.7}{k\ohm}, l2 halign=c, l2 valign=b] (2,0); + \draw (0,0) to[R, l2^=$R_{CC}$ and \SI{4.7}{k\ohm}, l2 halign=c, ] (0,2); + \draw (0,0) to[R, l2^=$R_{CC}$ and \SI{4.7}{k\ohm}, , l2 valign=t] (-2,0); + \draw (0,0) to[R, l2^=$R_{CC}$ and \SI{4.7}{k\ohm}, l2 halign=c, l2 valign=t](0, -3); + \end{circuitikz} +\end{LTXexample} -\subsection{Currents}\label{currents} -The counting direction of currents and voltages have changed with version 0.5, for compability reasons there is a option to use the olddirections(see options). For the new scheme, the following rules apply: +\subsection{Currents and voltages}\label{curr-and-volt} + +The default direction/sign for currents and voltages in the components is, unfortunately, not standard, and can change across country and sometime across different authors. +This unfortunate situation created a bit of confusion in \texttt{circuitikz} across the versions, with several incompatible changes starting from version 0.5. +From version 0.9.0 onward, the maintainers agreed a new policy for the directions of bipoles' voltages and currents, depending on 4 different possible options: \begin{itemize} -\item \textbf{Normal bipoles:} currents and voltages are counted positiv in drawing direction. -\item \textbf{Current Sources:} current is counted positiv in drawing direction, voltage in opposite direction -\item \textbf{Voltage Sources:} voltage is counted positiv in drawing direction, current in opposite direction + \item \texttt{oldvoltagedirection}, or the key style \texttt{voltage dir=old}: Use old way of voltage direction having a difference between european and american direction, with wrong default labelling for batteries (it was the default before version 0.5); + \item \texttt{nooldvoltagedirection}, or the key style \texttt{voltage dir=noold}: The standard from version 0.5 onward, utilize the (German?) standard of voltage arrows in the direction of electric fields (without fixing batteries); + \item \texttt{RPvoltages} (meaning Rising Potential voltages), or the key style \texttt{voltage dir=RP}: the arrow is in direction of rising potential, like in \texttt{oldvoltagedirections}, but batteries and current sources are fixed so that they follow the passive/active standard: the default direction of \texttt{v} and \texttt{i} are chosen so that, when both values are positive: + \begin{itemize} + \item in passive component, the element is \emph{dissipating power}; + \item in active components (generators), the element is \emph{generating power}. + \end{itemize} + \item \texttt{EFvoltages} (meaning Electric Field voltages), or the key style \texttt{voltage dir=EF}: the arrow is in direction of the electric field, like in \texttt{nooldvoltagedirections}, but batteries are fixed; \end{itemize} -With this convention, the power at loads is positive and negative at sources. + +The standard direction of currents, flows and voltages are changed by these options; notice that the default drops in case of passive and active elements is normally different. Take care that in the case of \texttt{noold} and \texttt{EFvoltages} also the currents can switch directions. It is much easier to understand the several behaviors by looking at the following examples, that have been generated by the code: + +\begin{lstlisting} +\foreach\element in {R, C, D, battery2, V, I, sV, cV, cI}{% + \noindent\ttfamily + \begin{tabular}{p{2cm}} + \element \\ american \\[15pt] + \element \\ european \\ + \end{tabular} + \foreach\mode in {old, noold, RP, EF} { + \begin{tabular}{@{}l@{}} + \multicolumn{1}{c}{voltage dir} \\ + \multicolumn{1}{c}{dir=\mode} \\[4pt] + \begin{tikzpicture}[ + american, voltage dir=\mode, + ] + \draw (0,0) to[\element, *-o, v=$v_1$, i=$i_1$, ] (2.5,0); + \end{tikzpicture}\\ + \begin{tikzpicture}[ + european, voltage dir=\mode, + ] + \draw (0,0) to[\element, *-o, v=$v_1$, i=$i_1$, ] (2.5,0); + \end{tikzpicture} + \end{tabular} + \medskip + } + \par +} +\end{lstlisting} + + +\foreach\element in {R, C, D, battery2, V, I, sV, cV, cI}{% + \noindent\ttfamily + \begin{tabular}{p{2cm}} + \element \\ american \\[15pt] + \element \\ european \\ + \end{tabular} + \foreach\mode in {old, noold, RP, EF} { + \begin{tabular}{@{}l@{}} + \multicolumn{1}{c}{voltage dir} \\ + \multicolumn{1}{c}{dir=\mode} \\[4pt] + \begin{tikzpicture}[ + american, voltage dir=\mode, + ] + \draw (0,0) to[\element, *-o, v=$v_1$, i=$i_1$, ] (2.5,0); + \end{tikzpicture}\\ + \begin{tikzpicture}[ + european, voltage dir=\mode, + ] + \draw (0,0) to[\element, *-o, v=$v_1$, i=$i_1$, ] (2.5,0); + \end{tikzpicture} + \end{tabular} + \medskip + } + \par +} + +Obviously, you normally use just one between current and flows, but anyway you can +change direction of the voltages, +currents and flows using the complete keys \verb|i_>|, \verb|i^<|, \verb|i>_|, \verb|i>^|, +as shown in the following examples. + +This manual has been typeset with the option \texttt{\chosenvoltoption}. + +\subsection{Currents} + +Inline (along the wire) currents are selected with \verb|i_>|, \verb|i^<|, \verb|i>_|, \verb|i>^|, and various simplification; the default position and direction is obtained with the key \verb|i=...|. + \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i^>=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i_>=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i^<=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i_<=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i>^=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i>_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i<^=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i<_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} -Also +Also: \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i<=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i>=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i^=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} @@ -967,26 +2951,26 @@ Also \begin{circuitikz} \draw (0,0) to[V=10V, i_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} - +\end{LTXexample} + \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[V<=10V, i_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american] \draw (0,0) to[V=10V, i_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} - +\end{LTXexample} + \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american] \draw (0,0) to[V=10V,invert, i_=$i_1$] (2,0); \end{circuitikz} \end{LTXexample} - + \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american] \draw (0,0) to[dcisource=1A, i_=$i_1$] (2,0); @@ -997,12 +2981,12 @@ Also \begin{circuitikz}[american] \draw (0,0) to[dcisource=1A,invert, i_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \subsection{Flows}\label{flows} As an alternative for the current arrows, you can also use the following flows. They can also be used to indicate thermal or power flows. The syntax is pretty the same as for currents. -\textit{This is a new beta feature since version 0.8.3, therefore, please provide bugreports or hints to optimize this feature regarding placement and appearance! This means, that the appearance may change in the future!} +\textit{This is a new beta feature since version 0.8.3; therefore, please provide bug reports or hints to optimize this feature regarding placement and appearance! This means that the appearance may change in the future!} \begin{LTXexample}[varwidth=true] \begin{circuitikz} @@ -1047,7 +3031,7 @@ As an alternative for the current arrows, you can also use the following flows. \end{LTXexample} \subsection{Voltages} -See introduction note at Currents (chapter \ref{currents}, page \pageref{currents})! +See introduction note at Currents (chapter \ref{curr-and-volt}, page \pageref{curr-and-volt})! \subsubsection{European style} The default, with arrows. Use option \texttt{europeanvoltage} or style \verb![european voltages]!. @@ -1079,20 +3063,20 @@ See introduction note at Currents (chapter \ref{currents}, page \pageref{current \begin{circuitikz} \draw (0,0) to[V=10V, i_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} - +\end{LTXexample} + \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[V<=10V, i_=$i_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[I=1A, v_=$u_1$] (2,0); \end{circuitikz} -\end{LTXexample} - +\end{LTXexample} + \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[I<=1A, v_=$u_1$] (2,0); @@ -1104,13 +3088,24 @@ See introduction note at Currents (chapter \ref{currents}, page \pageref{current \draw (0,0) to[I=$~$,l=1A, v_=$u_1$] (2,0); \end{circuitikz} \end{LTXexample} + \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[I,l=1A, v_=$u_1$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz} + \draw (0,0) to[battery,l_=1V, v=$u_1$, i=$i_1$] (2,0); +\end{circuitikz} +\end{LTXexample} + -\subsubsection{American style} For those who like it (not me). Use option \texttt{americanvoltage} or set \verb![american voltages]!. + + +\subsubsection{American style} +Use option \texttt{americanvoltage} or set \verb![american voltages]!. \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american voltages] @@ -1140,14 +3135,111 @@ See introduction note at Currents (chapter \ref{currents}, page \pageref{current \begin{circuitikz}[american] \draw (0,0) to[I=1A, v_=$u_1$] (2,0); \end{circuitikz} -\end{LTXexample} - +\end{LTXexample} + \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american] \draw (0,0) to[I<=1A, v_=$i_1$] (2,0); \end{circuitikz} \end{LTXexample} +\subsubsection{Voltage position} It is possible to move away the arrows and the plus or minus signs with the key \texttt{voltages shift} (default value is \texttt{0}, which gives the standard position): + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[] + \draw (0,0) to[R, v=$v_1$, i=$i_1$] (2,0); + \draw (0,-1) to[R, v=$v_1$, i=$i_1$, + voltage shift=0.5] (2,-1); + \draw (0,-2) to[R, v=$v_1$, i=$i_1$, + voltage shift=1.0, ] (2,-2); +\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american voltages, voltage shift=0.5] + \draw (0,0) to[R, v=$v_1$, i=$i_1$] (2,0); +\end{circuitikz} +\end{LTXexample} + +Notes that \texttt{american voltage} also affects batteries. + +\begin{LTXexample}[varwidth=true] + \begin{circuitikz}[voltage shift=0.5] + \draw (0,0) to[battery,l_=1V, v=$u_1$, i=$i_1$] (2,0); +\end{circuitikz} +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american voltages, voltage shift=0.5] + \draw (0,0) to[battery,l_=1V, v=$u_1$, i=$i_1$] (2,0); +\end{circuitikz} +\end{LTXexample} + +\subsubsection{American voltages customization} + +Since 0.9.0, you can change the font\footnote{There where a bug before, noticed by the user \texttt{dzereb} on \href{https://tex.stackexchange.com/questions/487683/odd-minus-style-when-drawing-american-voltage}{tex.stackexchange.com} which made the symbols using different fonts in a basically random way. In the same page, user \texttt{campa} found the problem. Thanks!} used by the \texttt{american voltages} style, by setting to something different from nothing the key \texttt{voltage/american font} (default: nothing, using the current font) style: + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \begin{scope} + \ctikzset{voltage/american font=\tiny\boldmath} + \draw (0,0) to[R,v=$V_S$] ++(2,0); + \end{scope} + \draw (0,-2) to[R,v=$V_S$] ++(2,0); +\end{circuitikz} +\end{LTXexample} + +Also, if you want to change the symbols (sometime just the $+$ sign is drawn, for example, or for highlighting something), +using the keys \texttt{voltage/american plus} and \texttt{voltage/american minus} (default \verb|$+$| and \verb|$-$|). + +\begin{LTXexample}[varwidth=true] +\begin{circuitikz}[american] + \ctikzset{voltage/american font=\scriptsize\boldmath} + \ctikzset{voltage/american plus=\textcolor{red}{$\oplus$}} + \ctikzset{voltage/american minus=\textcolor{blue}{$\ominus$}} + \draw (0,0) to[R,v_>=$V_S$] ++(2,0); + \draw (0,-2) to[R,v_<=$V_S$] ++(2,0); +\end{circuitikz} +\end{LTXexample} + +This could be especially useful if you define a style, to use like this: + +\begin{LTXexample}[varwidth=true] +\tikzset{red plus/.style={ + circuitikz/voltage/american plus=\textcolor{red}{$+$}, +}} +\begin{circuitikz}[american] + \draw (0,0) to[R,v_>=$V_S$, red plus] ++(2,0); + \draw (0,-2) to[R,v_<=$V_S$] ++(2,0); +\end{circuitikz} +\end{LTXexample} +\subsubsection{Global properties of voltages and currents} + +\begin{LTXexample}[varwidth=true] +\tikz \draw (0,0) to[R, v=1<\volt>] (2,0); \par +\ctikzset{voltage/distance from node=.1} +\tikz \draw (0,0) to[R, v=1<\volt>] (2,0); +\end{LTXexample} + +\begin{LTXexample}[varwidth=true] +\tikz \draw (0,0) to[C, i=$\imath$] (2,0); \par +\ctikzset{current/distance = .2} +\tikz \draw (0,0) to[C, i=$\imath$] (2,0); +\end{LTXexample} + +\noindent However, you can override the properties \verb!voltage/distance from node!\footnote{That is, how distant from the initial and final points of the path the arrow starts and ends.}, \verb!voltage/bump b!\footnote{Controlling how high the bump of the arrow is --- how curved it is.} and \verb!voltage/european label distance!\footnote{Controlling how distant from the bipole the voltage label will be.} on a per-component basis, in order to fine-tune the voltages: + +\begin{LTXexample}[varwidth=true] +\tikz \draw (0,0) to[R, v=1<\volt>] (1.5,0) + to[C, v=2<\volt>] (3,0); \par +\ctikzset{bipoles/capacitor/voltage/% + distance from node/.initial=.7} +\tikz \draw (0,0) to[R, v=1<\volt>] (1.5,0) + to[C, v=2<\volt>] (3,0); \par +\end{LTXexample} + + + \subsection{Nodes} @@ -1278,7 +3370,7 @@ For some components label, current and voltage behave as one would expect: \end{circuitikz} \end{LTXexample} -The following results from using the option \texttt{americancurrent} or using the style \verb![american currents]!. +The following results from using the option \texttt{americancurrent} or using the style \texttt{[american currents]}. \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american currents] @@ -1346,7 +3438,7 @@ The same holds for voltage sources: \end{circuitikz} \end{LTXexample} -The following results from using the option \texttt{americanvoltage} or the style \verb![american voltages]!. +The following results from using the option \texttt{americanvoltage} or the style \texttt{[american voltages]}. \begin{LTXexample}[varwidth=true] \begin{circuitikz}[american voltages] @@ -1388,37 +3480,37 @@ If the option {\ttfamily siunitx} is active (and \emph{not} in \ConTeXt), then t \begin{circuitikz} \draw (0,0) to[R, l=1<\kilo\ohm>] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, l=$\SI{1}{\kilo\ohm}$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i=1<\milli\ampere>] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, i=$\SI{1}{\milli\ampere}$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, v=1<\volt>] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[R, v=$\SI{1}{\volt}$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} @@ -1429,7 +3521,7 @@ Bipole paths can also mirrored and inverted (or reverted) to change the drawing \begin{circuitikz} \draw (0,0) to[pD] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} @@ -1440,20 +3532,20 @@ Bipole paths can also mirrored and inverted (or reverted) to change the drawing \begin{circuitikz} \draw (0,0) to[pD, invert] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} -Placing labels, currents and voltages works also, please note, that mirroring and inverting does not incfluence the positioning of labels and voltages. Labels are by default above/right of the bipole and voltages below/left, respectively. +Placing labels, currents and voltages works also, please note, that mirroring and inverting does not influence the positioning of labels and voltages. Labels are by default above/right of the bipole and voltages below/left, respectively. \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[ospst=T, i=$i_1$, v=$v$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw (0,0) to[ospst=T, mirror, i=$i_1$, v=$v$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \begin{LTXexample}[varwidth=true] \begin{circuitikz} @@ -1464,7 +3556,7 @@ Placing labels, currents and voltages works also, please note, that mirroring an \begin{circuitikz} \draw (0,0) to[ospst=T,mirror,invert, i=$i_1$, v=$v$] (2,0); \end{circuitikz} -\end{LTXexample} +\end{LTXexample} \subsection{Putting them together} @@ -1483,7 +3575,9 @@ Placing labels, currents and voltages works also, please note, that mirroring an \end{LTXexample} \subsection{Line joins between Path Components} -Line joins should be calculated correctly, if the were on the same path and if the path is not closed. For example, the following path is not closed correctly(\textit{--cycle} does not work here!): +\label{sec:line-joins} + +Line joins should be calculated correctly, if the are on the same path and if the path is not closed. For example, the following path is not closed correctly (\textit{--cycle} does not work here!): \begin{LTXexample}[varwidth=true] \begin{tikzpicture}[line width=3pt,european] \draw (0,0) to[R]++(2,0)to[R]++(0,2) @@ -1491,7 +3585,7 @@ Line joins should be calculated correctly, if the were on the same path and if t \draw[red,line width=1pt] circle(2mm); \end{tikzpicture} \end{LTXexample} -To correct the line ending, there are support shapes to fill the missing rectangle. They can be used like the support shapes(*,o,d) using a dot (.) on one or both ends of a component(have a look at the last resistor in this example: +To correct the line ending, there are support shapes to fill the missing rectangle. They can be used like the support shapes (*,o,d) using a dot (.) on one or both ends of a component (have a look at the last resistor in this example: \begin{LTXexample}[varwidth=true] \begin{tikzpicture}[line width=3pt,european] \draw (0,0) to[R]++(2,0)to[R]++(0,2) @@ -1501,33 +3595,15 @@ To correct the line ending, there are support shapes to fill the missing rectang \end{LTXexample} -\section{Not only bipoles} -Since only bipoles (but see section~\ref{sec:transasbip}) can be placed "along a line", components with more than two terminals are placed as nodes: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} -\draw (0,0) node[npn](npn) at (0,0) {}; -\draw (npn.C) --++(0,0.5) node[vcc]{+5\,\textnormal{V}}; -\draw (npn.E) --++(0,-0.5) node[vee]{-5\,\textnormal{V}}; -\end{circuitikz} -\end{LTXexample} - -\subsection{Anchors} - -In order to allow connections with other components, all components define anchors. +\section{Colors} -\subsubsection{Logical ports} All logical ports, except \textsc{not}, have two inputs and one output. They are called respectively \texttt{in 1}, \texttt{in 2}, \texttt{out}: +\subsection{Shape colors} -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[and port] (myand) {} - (myand.in 1) node[anchor=east] {1} - (myand.in 2) node[anchor=east] {2} - (myand.out) node[anchor=west] {3} -;\end{circuitikz} -\end{LTXexample} +The color of the components is stored in the key \verb!\circuitikzbasekey/color!. Circui\TikZ\ tries to follow the color set in \TikZ, although sometimes it fails. If you change color in the picture, please do not use just the color name as a style, like \verb![red]!, but rather assign the style \verb![color=red]!. +Compare for instance \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw +\begin{circuitikz} \draw[red] (0,2) node[and port] (myand1) {} (0,0) node[and port] (myand2) {} (2,1) node[xnor port] (myxnor) {} @@ -1536,545 +3612,366 @@ In order to allow connections with other components, all components define ancho ;\end{circuitikz} \end{LTXexample} -In the case of \textsc{not}, there are only \texttt{in} and \texttt{out} (although for compatibility reasons \texttt{in 1} is still defined and equal to \texttt{in}): +and \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (1,0) node[not port] (not1) {} - (3,0) node[not port] (not2) {} - (0,0) -- (not1.in) - (not2.in) -- (not1.out) - ++(0,-1) node[ground] {} to[C] (not1.out) - (not2.out) -| (4,1) -| (0,0) +\begin{circuitikz} \draw[color=red] + (0,2) node[and port] (myand1) {} + (0,0) node[and port] (myand2) {} + (2,1) node[xnor port] (myxnor) {} + (myand1.out) -| (myxnor.in 1) + (myand2.out) -| (myxnor.in 2) ;\end{circuitikz} \end{LTXexample} -\subsubsection{Transistors} For \textsc{nmos}, \textsc{pmos}, \textsc{nfet}, \textsc{nigfete}, \textsc{nigfetd}, \textsc{pfet}, \textsc{pigfete}, and \textsc{pigfetd} transistors one has \texttt{base}, \texttt{gate}, \texttt{source} and \texttt{drain} anchors (which can be abbreviated with \texttt{B}, \texttt{G}, \texttt{S} and \texttt{D}): - -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[nmos] (mos) {} - (mos.gate) node[anchor=east] {G} - (mos.drain) node[anchor=south] {D} - (mos.source) node[anchor=north] {S} +One can of course change the color \emph{in medias res}: +\begin{LTXexample}[pos=t, varwidth=true] +\begin{circuitikz} \draw + (0,0) node[pnp, color=blue] (pnp2) {} + (pnp2.B) node[pnp, xscale=-1, anchor=B, color=brown] (pnp1) {} + (pnp1.C) node[npn, anchor=C, color=green] (npn1) {} + (pnp2.C) node[npn, xscale=-1, anchor=C, color=magenta] (npn2) {} + (pnp1.E) -- (pnp2.E) (npn1.E) -- (npn2.E) + (pnp1.B) node[circ] {} |- (pnp2.C) node[circ] {} ;\end{circuitikz} \end{LTXexample} +The all-in-one stream of bipoles poses some challanges, as only the actual body of the bipole, and not the connecting lines, will be rendered in the specified color. Also, please notice the curly braces around the \texttt{to}: \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[pigfete] (pigfete) {} - (pigfete.G) node[anchor=east] {G} - (pigfete.D) node[anchor=north] {D} - (pigfete.S) node[anchor=south] {S} - (pigfete.bulk) node[anchor=west] {Bulk} +\begin{circuitikz} \draw + (0,0) to[V=1<\volt>] (0,2) + { to[R=1<\ohm>, color=red] (2,2) } + to[C=1<\farad>] (2,0) -- (0,0) ;\end{circuitikz} \end{LTXexample} -Similarly \textsc{njfet} and \textsc{pjfet} have \texttt{gate}, \texttt{source} and \texttt{drain} anchors (which can be abbreviated with \texttt{G}, \texttt{S} and \texttt{D}): - +Which, for some bipoles, can be frustrating: \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[pjfet] (pjfet) {} - (pjfet.G) node[anchor=east] {G} - (pjfet.D) node[anchor=north] {D} - (pjfet.S) node[anchor=south] {S} +\begin{circuitikz} \draw + (0,0){to[V=1<\volt>, color=red] (0,2) } + to[R=1<\ohm>] (2,2) + to[C=1<\farad>] (2,0) -- (0,0) ;\end{circuitikz} \end{LTXexample} -For \textsc{npn}, \textsc{pnp}, \textsc{nigbt}, and \textsc{pigbt} transistors the anchors are \texttt{base}, \texttt{emitter} and \texttt{collector} anchors (which can be abbreviated with \texttt{B}, \texttt{E} and \texttt{C}): - +The only way out is to specify different paths: \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[npn] (npn) {} - (npn.base) node[anchor=east] {B} - (npn.collector) node[anchor=south] {C} - (npn.emitter) node[anchor=north] {E} +\begin{circuitikz} \draw[color=red] + (0,0) to[V=1<\volt>, color=red] (0,2); + \draw (0,2) to[R=1<\ohm>] (2,2) + to[C=1<\farad>] (2,0) -- (0,0) ;\end{circuitikz} \end{LTXexample} -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[pigbt] (pigbt) {} - (pigbt.B) node[anchor=east] {B} - (pigbt.C) node[anchor=north] {C} - (pigbt.E) node[anchor=south] {E} -;\end{circuitikz} -\end{LTXexample} +And yes: this is a bug and \emph{not} a feature\ldots -Here is one composite example (please notice that the \texttt{xscale=-1} style would also reflect the label of the transistors, so here a new node is added and its text is used, instead of that of \texttt{pnp1}): +\subsection{Fill colors} -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[pnp] (pnp2) {2} - (pnp2.B) node[pnp, xscale=-1, anchor=B] (pnp1) {} - (pnp1) node {1} - (pnp1.C) node[npn, anchor=C] (npn1) {} - (pnp2.C) node[npn, xscale=-1, anchor=C] (npn2) {} - (pnp1.E) -- (pnp2.E) (npn1.E) -- (npn2.E) - (pnp1.B) node[circ] {} |- (pnp2.C) node[circ] {} -;\end{circuitikz} -\end{LTXexample} +Since version 0.9.0, you can also fill most shapes with a color (the manual specifies which ones are fillable or not). The syntax is quite intuitive: -Similarly, transistors and other components can be reflected vertically: \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[pigfete, yscale=-1] (pigfete) {} - (pigfete.bulk) node[anchor=west] {Bulk} - (pigfete.G) node[anchor=east] {G} - (pigfete.D) node[anchor=south] {D} - (pigfete.S) node[anchor=north] {S} +\begin{circuitikz} \draw + (0,2) node[and port, fill=yellow] (myand1) {} + (0,0) node[and port, fill=cyan] (myand2) {} + (2,1) node[xnor port,fill=red!30!white] (myxnor) {} + (myand1.out) -| (myxnor.in 1) + (myand2.out) -| (myxnor.in 2) ;\end{circuitikz} \end{LTXexample} -\begin{LTXexample}[varwidth=true] - \begin{circuitikz} - \draw (0,2) - node[rground, yscale=-1] {} - to[R=$R_1$] (0,0) - node[sground] {}; - \end{circuitikz} -\end{LTXexample} +You can combine shape colors with fill colors, too, but you should use the \texttt{draw} color option style for this: -\subsubsection{Other tripoles} When inserting a thrystor, a triac or a potentiometer, one needs to refer to the third node--gate (\texttt{gate} or \texttt{G}) for the former two; wiper (\texttt{wiper} or \texttt{W}) for the latter one. This is done by giving a name to the bipole: -\label{bipole-naming} \begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) to[Tr, n=TRI] (2,0) - to[pR, n=POT] (4,0); - \draw[dashed] (TRI.G) -| (POT.wiper) +\begin{circuitikz} \draw[color=red] + (0,2) node[and port, fill=yellow] (myand1) {1} + (0,0) node[and port, fill=cyan] (myand2) {2} + (2,1) node[xnor port,fill=red!30!white] (myxnor) {3} + (myand1.out) -| (myxnor.in 1) + (myand2.out) -| (myxnor.in 2) ;\end{circuitikz} \end{LTXexample} -As for the switches: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[spdt] (Sw) {} - (Sw.in) node[left] {in} - (Sw.out 1) node[right] {out 1} - (Sw.out 2) node[right] {out 2} -;\end{circuitikz} -\end{LTXexample} -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) to[C] (1,0) to[toggle switch , n=Sw] (2.5,0) - -- (2.5,-1) to[battery1] (1.5,-1) to[R] (0,-1) -| (0,0) - (Sw.out 2) -| (2.5, 1) to[R] (0,1) -- (0,0) -;\end{circuitikz} -\end{LTXexample} +This is because, as you can see from the following example in port \texttt{2}, you can't specify both a fill and a color in the node (yes, it's a bug too, but it's quite complex to solve given the current circuit\TikZ{} architecture). a workaround is shown in port \texttt{3}: -The ports of the mixer and adder can be addressed with numbers or \texttt{west}/\texttt{south}/\texttt{east}/\texttt{north}: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[mixer] (mix) {} - (mix.1) node[left] {1} - (mix.2) node[below] {2} - (mix.3) node[right] {3} - (mix.4) node[above] {4} -;\end{circuitikz} -\end{LTXexample} -The Wilkinson divider has: \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw - (0,0) node[wilkinson] (w) {\SI{3}{dB}} - (w.in) to[short,-o] ++(-0.5,0) - (w.out1) to[short,-o] ++(0.5,0) - (w.out2) to[short,-o] ++(0.5,0) - (w.in) node[below left] {\texttt{in}} - (w.out1) node[below right] {\texttt{out1}} - (w.out2) node[above right] {\texttt{out2}} - ; -\end{circuitikz} + (0,2) node[and port, color=black] (myand1) {1} + (0,0) node[and port, color=blue, fill=cyan] (myand2) {2} + (2,1) {[color=blue] node[xnor port, fill=cyan] (myxnor) {3}} + (myand1.out) -| (myxnor.in 1) + (myand2.out) -| (myxnor.in 2) +;\end{circuitikz} \end{LTXexample} -\subsubsection{Operational amplifier} The op amp defines the inverting input (\texttt{-}), the non-inverting input (\texttt{+}) and the output (\texttt{out}) anchors: +Notice also that the connection point are always filled, although the color \emph{tries} to follow the color of the filling of the component: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[op amp] (opamp) {} - (opamp.+) node[left] {$v_+$} - (opamp.-) node[left] {$v_-$} - (opamp.out) node[right] {$v_o$} - (opamp.up) --++(0,0.5) node[vcc]{5\,\textnormal{V}} - (opamp.down) --++(0,-0.5) node[vee]{-5\,\textnormal{V}} -;\end{circuitikz} +\begin{LTXexample}[varwidth=true, pos=t] +\begin{circuitikz} + \fill[cyan] (0,3.0) rectangle (7,7); + \draw [fill=yellow, ] (4,4) to [D,o-o] ++(0,2) to[D*, fill=yellow] ++(2,0) + to[D*] ++(0,-2) to[D, fill=red, o-o] ++(-2,0); + \draw (1,4) node[ocirc]{} -- ++(1,0) node[ocirc]{}; + \draw (1,4.5) to[short, o-o] ++(1,0) to[short, -o] ++(1,0); + \draw[fill=yellow] (1,5) to[short, o-o] ++(1,0) to[short, -o] ++(1,0); + \draw (1,5.5) to[short, fill=red, o-o] ++(1,0) to[short, -o] ++(1,0); +\end{circuitikz} \end{LTXexample} -There are also two more anchors defined, \texttt{up} and \texttt{down}, for the power supplies: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[op amp] (opamp) {} - (opamp.+) node[left] {$v_+$} - (opamp.-) node[left] {$v_-$} - (opamp.out) node[right] {$v_o$} - (opamp.down) node[ground] {} - (opamp.up) ++ (0,.5) node[above] {\SI{12}{\volt}} - -- (opamp.up) -;\end{circuitikz} -\end{LTXexample} +\section{FAQ} -The fully differential op amp defines two outputs: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[fd op amp] (opamp) {} - (opamp.+) node[left] {$v_+$} - (opamp.-) node[left] {$v_-$} - (opamp.out +) node[right] {out +} - (opamp.out -) node[right] {out -} - (opamp.down) node[ground] {} -;\end{circuitikz} -\end{LTXexample} +\noindent Q: When using \verb!\tikzexternalize! I get the following error: +\begin{verbatim} + ! Emergency stop. +\end{verbatim} -\subsubsection{Double bipoles} All the (few, actually) double bipoles/quadrupoles have -the four anchors, two for each port. The first port, to the left, is port \texttt{A}, having the anchors \texttt{A1} (up) and \texttt{A2} (down); same for port \texttt{B}. They also expose the \texttt{base} anchor, for labelling: +\noindent A: The \TikZ\ manual states: +\begin{quotation} +Furthermore, the library assumes that all \LaTeX\ pictures are ended + with \\\verb!\end{tikzpicture}!. +\end{quotation} -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[transformer] (T) {} - (T.A1) node[anchor=east] {A1} - (T.A2) node[anchor=east] {A2} - (T.B1) node[anchor=west] {B1} - (T.B2) node[anchor=west] {B2} - (T.base) node{K} -;\end{circuitikz} -\end{LTXexample} +Just substitute every occurrence of the environment \verb!circuitikz! with \verb!tikzpicture!. They are actually pretty much the same. -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[gyrator] (G) {} - (G.A1) node[anchor=east] {A1} - (G.A2) node[anchor=east] {A2} - (G.B1) node[anchor=west] {B1} - (G.B2) node[anchor=west] {B2} - (G.base) node{K} -;\end{circuitikz} -\end{LTXexample} +\bigskip -However: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[coupler] (c) {\SI{10}{dB}} - (c.1) to[short,-o] ++(-0.5,0) - (c.2) to[short,-o] ++(0.5,0) - (c.3) to[short,-o] ++(0.5,0) - (c.4) to[short,-o] ++(-0.5,0) - (c.1) node[below left] {\texttt{1}} - (c.2) node[below right] {\texttt{2}} - (c.3) node[above right] {\texttt{3}} - (c.4) node[above left] {\texttt{4}} - ; -\end{circuitikz} -\end{LTXexample} - +\noindent Q: How do I draw the voltage between two nodes? + +\noindent A: Between any two nodes there is an open circuit! \begin{LTXexample}[varwidth=true] \begin{circuitikz} \draw - (0,0) node[coupler2] (c) {\SI{3}{dB}} - (c.1) to[short,-o] ++(-0.5,0) - (c.2) to[short,-o] ++(0.5,0) - (c.3) to[short,-o] ++(0.5,0) - (c.4) to[short,-o] ++(-0.5,0) - (c.1) node[below left] {\texttt{1}} - (c.2) node[below right] {\texttt{2}} - (c.3) node[above right] {\texttt{3}} - (c.4) node[above left] {\texttt{4}} - ; -\end{circuitikz} + node[ocirc] (A) at (0,0) {} + node[ocirc] (B) at (2,1) {} + (A) to[open, v=$v$] (B) +;\end{circuitikz} \end{LTXexample} +\bigskip -\subsection{Input arrows} -\subsubsection*{Two ports} -With the option \texttt{>} you can draw an arrow to the input of the block diagram symbols. -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) to[short,o-] ++(0.3,0) - to[lowpass,>] ++(2,0) - to[adc,>] ++(2,0) - to[short,-o] ++(0.3,0); -\end{circuitikz} -\end{LTXexample} +\noindent Q: I cannot write \verb!to[R = $R_1=12V$]! nor \verb!to[ospst = open, 3s]!: I get errors. +\noindent A: It is a limitation of the parser. -\subsubsection*{Multi ports} -Since inputs and outputs can vary, input arrows can be placed as nodes. Note that you have to rotate the arrow on your own: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[mixer] (m) {} - (m.1) to[short,-o] ++(-1,0) - (m.2) to[short,-o] ++(0,-1) - (m.3) to[short,-o] ++(1,0) - (m.1) node[inputarrow] {} - (m.2) node[inputarrow,rotate=90] {}; -\end{circuitikz} -\end{LTXexample} +Use \verb|\def{\eq}{=}| \verb!to[R = $R_1\eq 12V$]! and \verb!to[ospst = open{,} 3s]! instead; see caveat in section~\ref{sec:labels-and-annotations}. -\subsection{Labels and custom twoport boxes} -Some twoports have the option to place a normal label (\texttt{l=}) and a inner label (\texttt{t=}). -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} - \ctikzset{bipoles/amp/width=0.9} - \draw (0,0) to[amp,t=LNA,l_=$F{=}0.9\,$dB,o-o] ++(3,0); -\end{circuitikz} -\end{LTXexample} +\section{Defining new components} +\begin{quote} + Per me si va ne la città dolente,\\ + per me si va ne l'etterno dolore,\\ + per me si va tra la perduta gente.\\ + \dots\\ + Lasciate ogne speranza, voi ch'intrate.% + \footnote{\url{https://classicsincontext.wordpress.com/2010/02/28/canto-iii-per-me-si-va-ne-la-citta-dolente/}} +\end{quote} -\subsection{Box option} -Some devices have the possibility to add a box around them. The inner symbol scales down to fit inside the box. -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[mixer,box,anchor=east] (m) {} - to[amp,box,>,-o] ++(2.5,0) - (m.west) node[inputarrow] {} to[short,-o] ++(-0.8,0) - (m.south) node[inputarrow,rotate=90] {} -- - ++(0,-0.7) node[oscillator,box,anchor=north] {}; -\end{circuitikz} -\end{LTXexample} +\textbf{Big fat warning}: this material is reserved to \TeX-hackers; do not delve into this if you have no familiarity with (at least) a bit of core \TeX{} programming and to the basic \TikZ{} layer. You have been warned. -\subsection{Dash optional parts} -To show that a device is optional, you can dash it. The inner symbol will be kept with solid lines. -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} - \draw (0,0) to[amp,l=\SI{10}{dB}] ++(2.5,0); - \draw[dashed] (2.5,0) to[lowpass,l=opt.] ++(2.5,0); -\end{circuitikz} -\end{LTXexample} -\subsection{Transistor paths}\label{sec:transasbip} +\subsection{Suggested setup} -For syntactical convenience transistors can be placed using the normal path notation used for bipoles. The transitor type can be specified by simply adding a ``T'' (for transistor) in front of the node name of the transistor. It will be placed with the base/gate orthogonal to the direction of the path: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) node[njfet] {1} - (-1,2) to[Tnjfet=2] (1,2) - to[Tnjfet=3, mirror] (3,2); -;\end{circuitikz} -\end{LTXexample} +The suggested way to start working on a new component is to use the utilities of the \Circuitikz{} manual for checking and testing your device. Basically, find (or download) the source code of the last version of \Circuitikz{} and find the file \texttt{ctikzmanutils.sty}; copy it in your directory and prepare a file like this: -Access to the gate and/or base nodes can be gained by naming the transistors with the \texttt{n} or \texttt{name} path style: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw[yscale=1.1, xscale=.8] - (2,4.5) -- (0,4.5) to[Tpmos, n=p1] (0,3) - to[Tnmos, n=n1] (0,1.5) - to[Tnmos, n=n2] (0,0) node[ground] {} - (2,4.5) to[Tpmos,n=p2] (2,3) to[short, -*] (0,3) - (p1.G) -- (n1.G) to[short, *-o] ($(n1.G)+(3,0)$) - (n2.G) ++(2,0) node[circ] {} -| (p2.G) - (n2.G) to[short, -o] ($(n2.G)+(3,0)$) - (0,3) to[short, -o] (-1,3) -;\end{circuitikz} -\end{LTXexample} +\begin{lstlisting} +\documentclass[a4paper, titlepage]{article} +\usepackage{a4wide} %smaller borders +\usepackage[utf8]{inputenc} +\usepackage[T1]{fontenc} +\parindent=0pt +\parskip=4pt plus 6pt minus 2pt +\usepackage[siunitx, RPvoltages]{circuitikz} +\usepackage{ctikzmanutils} +\makeatletter +%% Test things here +% defines -The \texttt{name} property is available also for bipoles, although this is useful mostly for triac, potentiometer and thyristor (see~\ref{sec:othertrip}). +% components -\section{Customization} +% paths +\makeatother -\subsection{Parameters} +\begin{document} -Pretty much all Circui\TikZ\ relies heavily on \texttt{pgfkeys} for value handling and configuration. Indeed, at the beginning of \texttt{circuitikz.sty} a series of key definitions can be found that modify all the graphical characteristics of the package. +\circuitdescbip*{damper}{Mechanical damping\footnotemark}{}(left/135/0.2, right/45/0.2, center/-90/0.3) -All can be varied using the \verb!\ctikzset! command, anywhere in the code. +\geolrcoord{dampershape, fill=yellow} -\paragraph{Shape of the components} (on a per-component-class basis) -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) to[R=1<\ohm>] (2,0); \par -\ctikzset{bipoles/resistor/height=.6} -\tikz \draw (0,0) to[R=1<\ohm>] (2,0); +\begin{LTXexample}[varwidth] +\begin{circuitikz} + \draw (0,0) to[R] ++(2,0) + to[damper] ++(2,0); +\end{circuitikz} \end{LTXexample} +\end{document} +\end{lstlisting} -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) node[nand port] {}; \par -\ctikzset{tripoles/american nand port/input height=.2} -\ctikzset{tripoles/american nand port/port width=.2} -\tikz \draw (0,0) node[nand port] {}; -\end{LTXexample} +This will compile in something like this (in this case, we are using a couple of existing components to check everything is ok): -\paragraph{Thickness of the lines} (globally) -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) to[C=1<\farad>] (2,0); \par -\ctikzset{bipoles/thickness=1} -\tikz \draw (0,0) to[C=1<\farad>] (2,0); -\end{LTXexample} +\circuitdescbip*{damper}{Mechanical damping\footnotemark}{}(left/135/0.2, right/45/0.2, center/-90/0.3) +\geolrcoord{dampershape, fill=yellow} -\paragraph{Global properties} Of voltage and current -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) to[R, v=1<\volt>] (2,0); \par -\ctikzset{voltage/distance from node=.1} -\tikz \draw (0,0) to[R, v=1<\volt>] (2,0); +\begin{LTXexample}[varwidth] +\begin{circuitikz} + \draw (0,0) to[R] ++(2,0) + to[damper] ++(2,0); +\end{circuitikz} \end{LTXexample} -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) to[C, i=$\imath$] (2,0); \par -\ctikzset{current/distance = .2} -\tikz \draw (0,0) to[C, i=$\imath$] (2,0); -\end{LTXexample} +The command \verb|circuitdescbip*| is used to show the component description (you can check the definition and the usage looking at \texttt{ctikzmanutils.sty} file, and the \verb|\geolrcoord| is used to show the main anchors (geographical plus \texttt{left} and \texttt{right}) of the component. -\noindent However, you can override the properties \verb!voltage/distance from node!\footnote{That is, how distant from the initial and final points of the path the arrow starts and ends.}, \verb!voltage/bump b!\footnote{Controlling how high the bump of the arrow is --- how curved it is.} and \verb!voltage/european label distance!\footnote{Controlling how distant from the bipole the voltage label will be.} on a per-component basis, in order to fine-tune the voltages: +From now on, you can add the new commands for the component between the \verb|\makeatletter| and \verb|\makeatother| commands and, modifying the example, check the results. -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) to[R, v=1<\volt>] (1.5,0) - to[C, v=2<\volt>] (3,0); \par -\ctikzset{bipoles/capacitor/voltage/% - distance from node/.initial=.7} -\tikz \draw (0,0) to[R, v=1<\volt>] (1.5,0) - to[C, v=2<\volt>] (3,0); \par -\end{LTXexample} +\subsection{Path-style component} -\noindent Admittedly, not all graphical properties have understandable names, but for the time it will have to do: -\begin{LTXexample}[varwidth=true] -\tikz \draw (0,0) node[xnor port] {}; -\ctikzset{tripoles/american xnor port/aaa=.2} -\ctikzset{tripoles/american xnor port/bbb=.6} -\tikz \draw (0,0) node[xnor port] {}; -\end{LTXexample} +Let's define for example a path style component, like the one suggested by the user \texttt{@alex} on \href{https://tex.stackexchange.com/questions/484268/combined-spring-damper-in-circuitikz}{tex.stackexchange.com}. The component will be a mix of the \texttt{damper} and the \texttt{spring} components already present. -\subsection{Components size} -Perhaps the most important parameter is \verb!\circuitikzbasekey/bipoles/length!, which -can be interpreted as the length of a resistor (including reasonable connections): all other lenghts are relative to this value. For instance: +The first step is to check if we can use the definition already existing for similar elements (for coherence of size) or if we need to define new ones; for this you have to check the file \texttt{pgfcirc.defines.tex}: we find -\begin{LTXexample}[pos=t,varwidth=true] -\ctikzset{bipoles/length=1.4cm} -\begin{circuitikz}[scale=1.2]\draw - (0,0) node[anchor=east] {B} - to[short, o-*] (1,0) - to[R=20<\ohm>, *-*] (1,2) - to[R=10<\ohm>, v=$v_x$] (3,2) -- (4,2) - to[cI=$\frac{\si{\siemens}}{5} v_x$, *-*] (4,0) -- (3,0) - to[R=5<\ohm>, *-*] (3,2) - (3,0) -- (1,0) - (1,2) to[short, -o] (0,2) node[anchor=east]{A} -;\end{circuitikz} -\end{LTXexample} +\begin{lstlisting} + \ctikzset{bipoles/spring/height/.initial=.5} + \ctikzset{bipoles/spring/width/.initial=.5} + \ctikzset{bipoles/damper/height/.initial=.35} + \ctikzset{bipoles/damper/length/.initial=.3} + \ctikzset{bipoles/damper/width/.initial=.4} +\end{lstlisting} -\begin{LTXexample}[pos=t,varwidth=true] -\ctikzset{bipoles/length=.8cm} -\begin{circuitikz}[scale=1.2]\draw - (0,0) node[anchor=east] {B} - to[short, o-*] (1,0) - to[R=20<\ohm>, *-*] (1,2) - to[R=10<\ohm>, v=$v_x$] (3,2) -- (4,2) - to[cI=$\frac{\siemens}{5} v_x$, *-*] (4,0) -- (3,0) - to[R=5<\ohm>, *-*] (3,2) - (3,0) -- (1,0) - (1,2) to[short, -o] (0,2) node[anchor=east]{A} -;\end{circuitikz} -\end{LTXexample} +We will use them; at this stage you can decide to add other parameters if you need them. (Notice, however, than although flexibility is good, these parameters should be described in the manual, otherwise they're as good as a fixed number in the code). -\subsection{Colors} -The color of the components is stored in the key \verb!\circuitikzbasekey/color!. Circui\TikZ\ tries to follow the color set in \TikZ, although sometimes it fails. If you change color in the picture, please do not use just the color name as a style, like \verb![red]!, but rather assign the style \verb![color=red]!. +To define the new component we will look into \texttt{pgfcircbipoles.tex} and we will copy, for example, the definition of the damper into our code, just changing the name: -Compare for instance -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw[red] - (0,2) node[and port] (myand1) {} - (0,0) node[and port] (myand2) {} - (2,1) node[xnor port] (myxnor) {} - (myand1.out) -| (myxnor.in 1) - (myand2.out) -| (myxnor.in 2) -;\end{circuitikz} -\end{LTXexample} +\begin{lstlisting} +%% mechanical resistor - damper +\pgfcircdeclarebipole +{} % extra anchors +{\ctikzvalof{bipoles/damper/height}} % depth (under the path line) +{viscoe} % name +{\ctikzvalof{bipoles/damper/height}} % height (above the path line) +{\ctikzvalof{bipoles/damper/width}} % width +{ % draw the bipole + \pgfpathrectanglecorners{\pgfpoint{\ctikzvalof{bipoles/damper/length}\pgf@circ@res@right}{\pgf@circ@res@down}}{\pgfpoint{\pgf@circ@res@right}{\pgf@circ@res@up}} + \pgf@circ@maybefill + + % line into the damper + \pgfpathmoveto{\pgfpoint{\pgf@circ@res@left}{\pgf@circ@res@zero}} + \pgfpathlineto{\pgfpoint{\ctikzvalof{bipoles/damper/length}\pgf@circ@res@right} + {\pgf@circ@res@zero}} + \pgfusepath{stroke} + + % damper box + \pgfsetlinewidth{\pgfkeysvalueof{/tikz/circuitikz/bipoles/thickness}\pgfstartlinewidth} + \pgfpathmoveto{\pgfpoint{\pgf@circ@res@left}{\pgf@circ@res@down}} + \pgfpathlineto{\pgfpoint{\pgf@circ@res@right}{\pgf@circ@res@down}} + \pgfpathlineto{\pgfpoint{\pgf@circ@res@right}{\pgf@circ@res@up}} + \pgfpathlineto{\pgfpoint{\pgf@circ@res@left}{\pgf@circ@res@up}} + + \pgfsetrectcap + \pgfsetmiterjoin + \pgfusepath{stroke} + + % damper vertical element + \pgfpathmoveto{\pgfpoint{\ctikzvalof{bipoles/damper/length}\pgf@circ@res@right} + {.8\pgf@circ@res@down}} + \pgfpathlineto{\pgfpoint{\ctikzvalof{bipoles/damper/length}\pgf@circ@res@right} + {.8\pgf@circ@res@up}} + \pgfsetbuttcap + \pgfusepath{stroke} +} +\end{lstlisting} -and +This command will define a shape that is named \texttt{viscoeshape}, with all the correct geographical anchors based on the depth, height and width defined in the parameters of \verb|\pgfcircdeclarebipole|. This is not sufficient for using the element in a \texttt{to[]} path command; you need to ``activate'' it with (this commands are normally in \texttt{pgfcircpath.tex}): -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw[color=red] - (0,2) node[and port] (myand1) {} - (0,0) node[and port] (myand2) {} - (2,1) node[xnor port] (myxnor) {} - (myand1.out) -| (myxnor.in 1) - (myand2.out) -| (myxnor.in 2) -;\end{circuitikz} -\end{LTXexample} +\begin{lstlisting} +\def\pgf@circ@viscoe@path#1{\pgf@circ@bipole@path{viscoe}{#1}} +\compattikzset{viscoe/.style = {\circuitikzbasekey, + /tikz/to path=\pgf@circ@dviscoe@path, l=#1}} +\end{lstlisting} -One can of course change the color \emph{in medias res}: -\begin{LTXexample}[pos=t, varwidth=true] -\begin{circuitikz} \draw - (0,0) node[pnp, color=blue] (pnp2) {} - (pnp2.B) node[pnp, xscale=-1, anchor=B, color=brown] (pnp1) {} - (pnp1.C) node[npn, anchor=C, color=green] (npn1) {} - (pnp2.C) node[npn, xscale=-1, anchor=C, color=magenta] (npn2) {} - (pnp1.E) -- (pnp2.E) (npn1.E) -- (npn2.E) - (pnp1.B) node[circ] {} |- (pnp2.C) node[circ] {} -;\end{circuitikz} -\end{LTXexample} +And now you can show it with: -The all-in-one stream of bipoles poses some challanges, as only the actual body of the bipole, and not the connecting lines, will be rendered in the specified color. Also, please notice the curly braces around the \texttt{to}: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0) to[V=1<\volt>] (0,2) - { to[R=1<\ohm>, color=red] (2,2) } - to[C=1<\farad>] (2,0) -- (0,0) -;\end{circuitikz} -\end{LTXexample} +\begin{lstlisting} +\circuitdescbip*{viscoe}{Mechanical viscoelastic element\footnotemark}{}(left/135/0.2, right/45/0.2, center/-90/0.3) -Which, for some bipoles, can be frustrating: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - (0,0){to[V=1<\volt>, color=red] (0,2) } - to[R=1<\ohm>] (2,2) - to[C=1<\farad>] (2,0) -- (0,0) -;\end{circuitikz} -\end{LTXexample} +\geolrcoord{viscoeshape, fill=yellow} -The only way out is to specify different paths: -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw[color=red] - (0,0) to[V=1<\volt>, color=red] (0,2); - \draw (0,2) to[R=1<\ohm>] (2,2) - to[C=1<\farad>] (2,0) -- (0,0) -;\end{circuitikz} +\begin{LTXexample}[varwidth] +\begin{circuitikz} + \draw (0,0) to[spring] ++(2,0) + to[viscoe] ++(2,0); +\end{circuitikz} \end{LTXexample} +\end{lstlisting} -And yes: this is a bug and \emph{not} a feature\ldots +Obviously, at first you you just have a component that is the same as the one you copied with another name. It is now just a matter of modifying it so that it has the desired shape; in the example above you can already see the new symbol after the changes. -\section{FAQ} +When doing the drawing, the \verb|\pgfcircdeclarebipole| will setup the lengths \verb|\pgf@circ@res@right| +and \verb|\pgf@circ@res@up| as the $x$-$y$ coordinates of the upper right corner, and +\verb|\pgf@circ@res@left| and \verb|\pgf@circ@res@down| as the $x$-$y$ coordinates of the lower left corner of your shape. The \texttt{center} coordinate is usually at $(0pt, 0pt)$. -\noindent Q: When using \verb!\tikzexternalize! I get the following error: -\begin{verbatim} - ! Emergency stop. -\end{verbatim} +Looking at the implementation of the \texttt{spring} element, a possible implementation is changing the lines between lines~12 and~16 with: -\noindent A: The \TikZ\ manual states: -\begin{quotation} -Furthermore, the library assumes that all \LaTeX\ pictures are ended - with \verb!\end{tikzpicture}!. -\end{quotation} +\begin{lstlisting} + % spring into the damper + \pgfscope + \pgfpathmoveto{\pgfpoint{\pgf@circ@res@left}{\pgf@circ@res@zero}} + \pgfsetlinewidth{\pgfkeysvalueof{/tikz/circuitikz/bipoles/thickness}\pgfstartlinewidth} + \pgfsetcornersarced{\pgfpoint{.25\pgf@circ@res@up}{.25\pgf@circ@res@up}} + \pgfpathlineto{\pgfpoint{.75\pgf@circ@res@left}{.75\pgf@circ@res@up}} + \pgfpathlineto{\pgfpoint{.5\pgf@circ@res@left}{-.75\pgf@circ@res@up}} + \pgfpathlineto{\pgfpoint{.25\pgf@circ@res@left}{.75\pgf@circ@res@up}} + \pgfpathlineto{\pgfpoint{0pt}{-.75\pgf@circ@res@up}} + \pgfpathlineto{\pgfpoint{\ctikzvalof{bipoles/damper/length}\pgf@circ@res@right}{.75\pgf@circ@res@up}} + \pgfusepath{stroke} + \endpgfscope +\end{lstlisting} + +which leads to: + +\circuitdescbip*{viscoe}{Mechanical viscoelastic element\footnotemark}{}(left/135/0.2, right/45/0.2, center/-90/0.3) + +\geolrcoord{viscoeshape, fill=yellow} + +\begin{LTXexample}[varwidth] +\begin{circuitikz} + \draw (0,0) to[spring] ++(2,0) + to[viscoe] ++(2,0); +\end{circuitikz} +\end{LTXexample} -Just substitute every occurrence of the environment \verb!circuitikz! with \verb!tikzpicture!. They are actually pretty much the same. -\bigskip +As a final note, notice that the \texttt{viscoe} element is already added to the standard package. -\noindent Q: How do I draw the voltage between two nodes? +\subsection{Node-style component} -\noindent A: Between any two nodes there is an open circuit! -\begin{LTXexample}[varwidth=true] -\begin{circuitikz} \draw - node[ocirc] (A) at (0,0) {} - node[ocirc] (B) at (2,1) {} - (A) to[open, v=$v$] (B) -;\end{circuitikz} -\end{LTXexample} +Adding a node-style component is much more straightforward. Just define it by following examples in, for example, \texttt{pgfcirctripoles.tex} or the other files; be careful that you should define all the geographical anchors of the shape if you want that the \TikZ{} positioning options (like \texttt{left}, \texttt{above}, etc.) behave correctly with your component. -\bigskip +\subsubsection{Finishing your work} -\noindent Q: I cannot write \verb!to[R = $R_1=12V$]! nor \verb!to[ospst = open, 3s]!: I get errors. +Once you have a satisfactory element, you should +\begin{itemize} + \item Clean up your code; + \item write a piece of documentation explaining its use with example; + \item Propose the element for inclusion in the GitHub page of the project (you will have to license this as explained in that page, of course). +\end{itemize} + +The best way of contributing is forking the project, adding your component in the correct files, modify the manual and creating a pull request for the developers to merge. Anyway, if this is a problem, just open an issue and someone (when they have time\dots) will answer. -\noindent A: It is a limitation of the \TikZ\ parser. Use \verb!to[R = $R_1{=}12V$]! and \verb!to[ospst = open{,} 3s]! instead. \section{Examples} + \begin{LTXexample}[pos=t,varwidth=true] \begin{circuitikz}[scale=1.4]\draw (0,0) to[C, l=10<\micro\farad>] (0,2) -- (0,3) to[R, l=2.2<\kilo\ohm>] (4,3) -- (4,2) to[L, l=12<\milli\henry>, i=$i_1$,v=b] (4,0) -- (0,0) (4,2) { to[D*, *-*, color=red] (2,0) } - (0,2) to[R, l=1<\kilo\ohm>, *-] (2,2) + (0,2) to[R, l=1<\kilo\ohm>, *-] (2,2) to[cV, i=1,v=$\SI{.3}{\kilo\ohm} i_1$] (4,2) - (2,0) to[I, i=1<\milli\ampere>, -*] (2,2) + (2,0) to[I, i=1<\milli\ampere>, -*] (2,2) ;\end{circuitikz} \end{LTXexample} @@ -2088,7 +3985,7 @@ Just substitute every occurrence of the environment \verb!circuitikz! with \verb (5,0) to[I, i_=$a(t)$, -*] (5,2) -- (4,2) (0,0) -- (5,0) (0,2) -- (0,3) to[L, l=2<\milli\henry>] (5,3) -- (5,2) - + {[anchor=south east] (0,2) node {1} (2,2) node {2} (4,2) node {3}} ;\end{circuitikz} \end{LTXexample} @@ -2102,10 +3999,10 @@ Just substitute every occurrence of the environment \verb!circuitikz! with \verb to[cI=$\frac{\siemens}{5} v_x$, *-*] (4,0) -- (3,0) to[R=5<\ohm>, *-*] (3,2) (3,0) -- (1,0) - (1,2) to[short, -o] (0,2) node[anchor=east]{A} + (1,2) to[short, -o] (0,2) node[anchor=east]{A} ;\end{circuitikz} \end{LTXexample} - + \begin{LTXexample}[pos=t,varwidth=true] \begin{circuitikz}[scale=1]\draw (0,0) node[transformer] (T) {} @@ -2117,16 +4014,16 @@ Just substitute every occurrence of the environment \verb!circuitikz! with \verb \begin{LTXexample}[pos=t,varwidth=true] \begin{circuitikz}[scale=1]\draw - (5,.5) node [op amp] (opamp) {} - (0,0) node [left] {$U_{we}$} to [R, l=$R_d$, o-*] (2,0) - to [R, l=$R_d$, *-*] (opamp.+) - to [C, l_=$C_{d2}$, *-] ($(opamp.+)+(0,-2)$) node [ground] {} - (opamp.out) |- (3.5,2) to [C, l_=$C_{d1}$, *-] (2,2) to [short] (2,0) - (opamp.-) -| (3.5,2) - (opamp.out) to [short, *-o] (7,.5) node [right] {$U_{wy}$} + (5,.5) node [op amp] (opamp) {} + (0,0) node [left] {$U_{we}$} to [R, l=$R_d$, o-*] (2,0) + to [R, l=$R_d$, *-*] (opamp.+) + to [C, l_=$C_{d2}$, *-] ($(opamp.+)+(0,-2)$) node [ground] {} + (opamp.out) |- (3.5,2) to [C, l_=$C_{d1}$, *-] (2,2) to [short] (2,0) + (opamp.-) -| (3.5,2) + (opamp.out) to [short, *-o] (7,.5) node [right] {$U_{wy}$} ;\end{circuitikz} \end{LTXexample} - + \begin{LTXexample}[pos=t,varwidth=true] \begin{circuitikz}[scale=1.2, american]\draw (0,2) to[I=1<\milli\ampere>] (2,2) @@ -2142,44 +4039,44 @@ Just substitute every occurrence of the environment \verb!circuitikz! with \verb \draw [->] (-2,0) -- (2.5,0) node[anchor=west] {$v_1/\volt$}; \draw [->] (0,-2) -- (0,2) node[anchor=west] {$i_1/\SI{}{\milli\ampere}$} ; \draw (-1,0) node[anchor=north] {-2} (1,0) node[anchor=south] {2} - (0,1) node[anchor=west] {4} (0,-1) node[anchor=east] {-4} + (0,1) node[anchor=west] {4} (0,-1) node[anchor=east] {-4} (2,0) node[anchor=north west] {4} (-1.5,0) node[anchor=south east] {-3}; \draw [thick] (-2,-1) -- (-1,1) -- (1,-1) -- (2,0) -- (2.5,.5); - \draw [dotted] (-1,1) -- (-1,0) (1,-1) -- (1,0) + \draw [dotted] (-1,1) -- (-1,0) (1,-1) -- (1,0) (-1,1) -- (0,1) (1,-1) -- (0,-1); - \end{scope} + \end{scope} \end{circuitikz} \end{LTXexample} \begin{LTXexample}[pos=t,varwidth=true] - \begin{circuitikz}[scale=1] - \ctikzset{bipoles/detector/width=.35} - \ctikzset{quadpoles/coupler/width=1} - \ctikzset{quadpoles/coupler/height=1} - \ctikzset{tripoles/wilkinson/width=1} - \ctikzset{tripoles/wilkinson/height=1} - %\draw[help lines,red,thin,dotted] (0,-5) grid (5,5); - \draw - (-2,0) node[wilkinson](w1){} - (2,0) node[coupler] (c1) {} - (0,2) node[coupler,rotate=90] (c2) {} - (0,-2) node[coupler,rotate=90] (c3) {} - (w1.out1) .. controls ++(0.8,0) and ++(0,0.8) .. (c3.3) - (w1.out2) .. controls ++(0.8,0) and ++(0,-0.8) .. (c2.4) - (c1.1) .. controls ++(-0.8,0) and ++(0,0.8) .. (c3.2) - (c1.4) .. controls ++(-0.8,0) and ++(0,-0.8) .. (c2.1) - (w1.in) to[short,-o] ++(-1,0) - (w1.in) node[left=30] {LO} - (c1.2) node[match,yscale=1] {} - (c1.3) to[short,-o] ++(1,0) - (c1.3) node[right=30] {RF} - (c2.3) to[detector,-o] ++(0,1.5) - (c2.2) to[detector,-o] ++(0,1.5) - (c3.1) to[detector,-o] ++(0,-1.5) - (c3.4) to[detector,-o] ++(0,-1.5) - ; - \end{circuitikz} + \begin{circuitikz}[scale=1] + \ctikzset{bipoles/detector/width=.35} + \ctikzset{quadpoles/coupler/width=1} + \ctikzset{quadpoles/coupler/height=1} + \ctikzset{tripoles/wilkinson/width=1} + \ctikzset{tripoles/wilkinson/height=1} + %\draw[help lines,red,thin,dotted] (0,-5) grid (5,5); + \draw + (-2,0) node[wilkinson](w1){} + (2,0) node[coupler] (c1) {} + (0,2) node[coupler,rotate=90] (c2) {} + (0,-2) node[coupler,rotate=90] (c3) {} + (w1.out1) .. controls ++(0.8,0) and ++(0,0.8) .. (c3.3) + (w1.out2) .. controls ++(0.8,0) and ++(0,-0.8) .. (c2.4) + (c1.1) .. controls ++(-0.8,0) and ++(0,0.8) .. (c3.2) + (c1.4) .. controls ++(-0.8,0) and ++(0,-0.8) .. (c2.1) + (w1.in) to[short,-o] ++(-1,0) + (w1.in) node[left=30] {LO} + (c1.2) node[match,yscale=1] {} + (c1.3) to[short,-o] ++(1,0) + (c1.3) node[right=30] {RF} + (c2.3) to[detector,-o] ++(0,1.5) + (c2.2) to[detector,-o] ++(0,1.5) + (c3.1) to[detector,-o] ++(0,-1.5) + (c3.4) to[detector,-o] ++(0,-1.5) + ; + \end{circuitikz} \end{LTXexample} @@ -2194,7 +4091,7 @@ Just substitute every occurrence of the environment \verb!circuitikz! with \verb \usetikzlibrary{circuits.ee.IEC} \usetikzlibrary{positioning} -\usepackage[compatibility]{circuitikz} +\usepackage[compatibility]{circuitikzgit} \ctikzset{bipoles/length=.9cm} \begin{document} @@ -2211,7 +4108,7 @@ Just substitute every occurrence of the environment \verb!circuitikz! with \verb % % changelog.tex will be updated by makefile from CHANGELOG.md \section{Changelog} \IfFileExists{changelog.tex} -{\input{changelog.tex}} +{\sloppy\input{changelog.tex}} {The file changelog.tex was not found, run 'make changelog' at toplevel to generate it with pandoc from CHANGELOG.md} \printindex diff --git a/Master/texmf-dist/doc/latex/circuitikz/compatibility.tex b/Master/texmf-dist/doc/latex/circuitikz/compatibility.tex index 7259479e78b..0f789cb1c67 100644 --- a/Master/texmf-dist/doc/latex/circuitikz/compatibility.tex +++ b/Master/texmf-dist/doc/latex/circuitikz/compatibility.tex @@ -4,7 +4,7 @@ \usetikzlibrary{circuits.ee.IEC} \usetikzlibrary{positioning} -\usepackage[compatibility]{circuitikz} +\usepackage[compatibility, RPvoltages]{circuitikz} \ctikzset{bipoles/length=.9cm} \begin{document} diff --git a/Master/texmf-dist/doc/latex/circuitikz/ctikzmanutils.sty b/Master/texmf-dist/doc/latex/circuitikz/ctikzmanutils.sty new file mode 100644 index 00000000000..6e773c3c570 --- /dev/null +++ b/Master/texmf-dist/doc/latex/circuitikz/ctikzmanutils.sty @@ -0,0 +1,123 @@ +\NeedsTeXFormat{LaTeX2e} +\ProvidesPackage{ctikzmanutils}[2019/04/14 utilities for formatting circuitikz manual] +\RequirePackage{ifthen} +\RequirePackage{xparse} +\RequirePackage{showexpl} +% +% The following trick is used to silence showexpl a bit, so that the +% logs are readable... +% +\makeatletter +\let\SX@Info=\relax % silence showexpl a bit... +\makeatother +% +\lstset{pos=l,width=-99pt, overhang=0pt,hsep=\columnsep,vsep=\bigskipamount, + rframe=single,numbers=left,numberstyle=\tiny,numbersep=.3em, xleftmargin=1em, + columns=flexible, language=[LaTeX]TEX,breaklines=true, + basicstyle=\normalsize\ttfamily,tabsize=3} + +% +% draw the shape without affecting anything +\newcommand{\drawphantomshape}[1] {% + {\tikz [overlay, color=blue] \path (0,0) node[#1]{};} +} +%% New circuit description macros +\newcommand{\twopartbox}[2]{% + \leavevmode\null\par\noindent\fbox{\parbox[c]{0.3\linewidth}{#1} \parbox[c]{0.6\linewidth}{\raggedright #2}\par\noindent}% +} +% filling color for filled-enabled component +\colorlet{fillcol}{cyan!30!white} +% description of a node component: +% optional star for fillable +% optional: scale of the component in the entry +% mandatory shape name, description, node text: +% optional between (): anchor specification list +\NewDocumentCommand{\circuitdesc}{s O{1} m m m d()} +{ + \twopartbox{% + \begin{circuitikz}[] + \IfBooleanTF{#1}{% + \draw (0,0) node[#3,scale=#2, fill=fillcol](N){#5}; + }{ + \draw (0,0) node[#3,scale=#2](N){#5}; + } + \IfValueT{#6}{% + \foreach \n/\a/\d in {#6} \path(N.\n) \showcoord(\n)<\a:\d>; + } + \end{circuitikz}% + }{\sloppy% + {#4, type: node\IfBooleanT{#1}{, fillable}% + } (\texttt{node[#3]\{#5\}}) \index{#3} } +} +% description of a path-style component: +% optional: main name, if different from above +% mandatory component name, description, comma separated alias +% optional between (): anchor specification list +\NewDocumentCommand{\circuitdescbip}{s o m m m d()} +{ +\index{#3} \tikz\foreach \i in {#5} {\index{\i|see{#3}} }; + \twopartbox{% + \begin{circuitikz} + \IfBooleanTF{#1}{% + \draw (0,0) to[#3, name=B, fill=fillcol] (2,0); + }{ + \draw (0,0) to[#3, name=B] (2,0); + } + \IfValueT{#6}{% + \foreach \n/\a/\d in {#6} \path(B.\n) \showcoord(\n)<\a:\d>; + } + \end{circuitikz}% + }{\sloppy% + \texttt{\textbf{#3}}: #4, \texttt{type: path-style\IfBooleanT{#1}{, fillable}% + \IfValueTF{#2}{% + , nodename: #2shape.%\drawphantomshape{#2shape}% + }{ + , nodename: #3shape.%\drawphantomshape{#3shape}% + } + }% + \ifthenelse{\equal{#5}{}}{}{% + Aliases: \texttt{#5}.}% + } +} + + +%new environment for grouping descriptions +\newenvironment{groupdesc}{\medskip\begingroup}{\endgroup\par\medskip\par\noindent} + +% command to show anchors: (name)<angle> +% usage in path: \path (anchor) \coord(anchor)<60> +\makeatletter % we use the internal circuitikz base length +\def\showcoord(#1)<#2:#3>{% + node[circle, red, draw, inner sep=1pt,pin={% + [red, inner sep=0.5pt, font=\small, + pin distance=#3\pgf@circ@Rlen, pin edge={red, }% + ]#2:#1}](#1){}} +\makeatother +% show anchors of a node component: +% optional: options of the circuitikz environment +% mandatory node spec, node text +% optional between (): anchor specification list +\NewDocumentCommand{\showanchors}{O{} m m d()} +{ + \begin{circuitikz}[#1] + \draw (0,0) node[#2](N){#3}; + \IfValueT{#4}{% + \foreach \n/\a/\d in {#4} \path(N.\n) \showcoord(\n)<\a:\d>; + } + \end{circuitikz}% +} + + +\def\geolrcoord#1{\showanchors{#1}{text}(north/90/0.4, north east/45/0.4, east/0/0.4, + south east/-45/0.4, + south/-90/0.4, south west/-135/0.4, west/180/0.4, north west/135/0.4, + left/160/0.4, right/30/0.4, center/-120/0.3 + ) +} + +\def\geocoord#1{\showanchors{#1}{text}(north/90/0.4, north east/45/0.4, east/0/0.4, + south east/-45/0.4, + south/-90/0.4, south west/-135/0.4, west/180/0.4, north west/135/0.4, + center/-120/0.3 + ) +} |