<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/config/serial_ports.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="docs/config/lua/config/serial_ports.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/config/serial_ports.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="docs/config/lua/config/serial_ports.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.1" data-tip="7053748e4d899e7fc5e202d6f903b052fc78e759">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">xixishidibei</span><span class="commit-message" data-commit="832c533c5f9e8d1c3315f2fbf96c125927a232f7">chore: remove redundant words in comment</span><span class="snapshot-sha sha" data-commit="832c533c5f9e8d1c3315f2fbf96c125927a232f7">832c533c5</span><time datetime="2024-09-18T15:57:15+08:00" title="2024-09-18 15:57:15 +0800">2024-09-18</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.1</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/">lua</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/config/">config</a> / <span class="cur">serial_ports.md</span></nav>
<span class="view-stats"><span>1.6 KiB</span><span>58 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/e0904bd801d9878242d7f5eeb383623461282086/docs/config/lua/config/serial_ports.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><hr />
<p>tags:</p>
<ul>
<li>serial</li>
</ul>
<hr />
<h1><code>serial_ports = {}</code></h1>
<p>{{since('20230408-112425-69ae8472')}}</p>
<p>Define a list of serial port(s) that you use regularly.
Each entry defines a <code>SerialDomain</code> with the following fields:</p>
<ul>
<li><code>name</code> - the name to use for the serial domain. Must be unique across
all multiplexer domains in your configuration.</li>
<li><code>port</code> - the name of the serial device. On Windows systems this can be
a name like <code>COM0</code>. On Posix systems this will be a device path something
like <code>/dev/ttyUSB0</code>.  If omitted, the <code>name</code> field be interpreted as
the port name.</li>
<li><code>baud</code> - the communication speed to assign to the port. If omitted,
the default baud rate will be 9600.</li>
</ul>
<p>This configuration defines a single port:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>serial_ports</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>name</a-v> = <a-s>&#39;/dev/tty.usbserial-10&#39;</a-s><a-p>,</a-p>
    <a-v>baud</a-v> = <a-n>115200</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
<p>You can then use the port in one of the following ways:</p>
<ul>
<li><code>wezterm connect /dev/tty.usbserial-10</code> - this behaves similarly to <code>wezterm serial /dev/tty.usbserial-10 --baud 115200</code>.</li>
<li>Start wezterm normally, then use the Command Palette or Launcher Menu to
spawn a new tab in the <code>/dev/tty.usbserial-10</code> domain to connect to the
serial device</li>
<li>You can reference the serial domain by its name <code>/dev/tty.usbserial-10</code> in
the various tab/window spawning key assignments that include a
<a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/config/lua/SpawnCommand.md">SpawnCommand</a></li>
</ul>
<p>You can define multiple ports if you require, and use friendly name for them:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>serial_ports</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-v>name</a-v> = <a-s>&#39;Sensor 1&#39;</a-s><a-p>,</a-p>
    <a-v>port</a-v> = <a-s>&#39;/dev/tty.usbserial-10&#39;</a-s><a-p>,</a-p>
    <a-v>baud</a-v> = <a-n>115200</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
  <a-cr>{</a-cr>
    <a-v>name</a-v> = <a-s>&#39;Sensor 2&#39;</a-s><a-p>,</a-p>
    <a-v>port</a-v> = <a-s>&#39;/dev/tty.usbserial-11&#39;</a-s><a-p>,</a-p>
    <a-v>baud</a-v> = <a-n>115200</a-n><a-p>,</a-p>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-pr>tags</a-pr><a-p>:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">  <a-p>-</a-p> <a-s>serial</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>---</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>#</a-p> <a-tt>`serial_ports = {}`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">{{since(&#39;20230408-112425-69ae8472&#39;)}}</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">Define a list of serial port(s) that you use regularly.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">Each entry defines a `SerialDomain` with the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>* </a-p>`name` - the name to use for the serial domain. Must be unique across</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>  </a-p>all multiplexer domains in your configuration.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>* </a-p>`port` - the name of the serial device. On Windows systems this can be</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>  </a-p>a name like `COM0`. On Posix systems this will be a device path something</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>  </a-p>like `/dev/ttyUSB0`.  If omitted, the `name` field be interpreted as</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>  </a-p>the port name.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>* </a-p>`baud` - the communication speed to assign to the port. If omitted,</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>  </a-p>the default baud rate will be 9600.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>This configuration defines a single port:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>config.</a-p><a-v>serial_ports</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;/dev/tty.usbserial-10&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>    </a-p><a-v>baud</a-v><a-p> = </a-p><a-n>115200</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>You can then use the port in one of the following ways:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>* `wezterm connect /dev/tty.usbserial-10` - this behaves similarly to `wezterm</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>  serial /dev/tty.usbserial-10 --baud 115200`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>* Start wezterm normally, then use the Command Palette or Launcher Menu to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>  spawn a new tab in the `/dev/tty.usbserial-10` domain to connect to the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>  serial device</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>* You can reference the serial domain by its name `/dev/tty.usbserial-10` in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>  the various tab/window spawning key assignments that include a</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>  [SpawnCommand](../SpawnCommand.md)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>You can define multiple ports if you require, and use friendly name for them:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>config.</a-p><a-v>serial_ports</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;Sensor 1&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>    </a-p><a-v>port</a-v><a-p> = </a-p><a-s>&#39;/dev/tty.usbserial-10&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>    </a-p><a-v>baud</a-v><a-p> = </a-p><a-n>115200</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> = </a-p><a-s>&#39;Sensor 2&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>    </a-p><a-v>port</a-v><a-p> = </a-p><a-s>&#39;/dev/tty.usbserial-11&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>    </a-p><a-v>baud</a-v><a-p> = </a-p><a-n>115200</a-n><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
