summaryrefslogtreecommitdiff
path: root/interface-definitions/service_serial-proxy.xml.in
blob: 917af0122592e9608e21ee7ac7015f6cd55a250e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="serial-proxy" owner="${vyos_conf_scripts_dir}/service_serial-proxy.py">
        <properties>
          <help>Serial to Network</help>
        </properties>
        <children>
          <tagNode name="device">
            <properties>
              <help>System serial interface name (ttyS or ttyUSB)</help>
              <completionHelp>
                <script>ls -1 /dev | grep ttyS</script>
                <script>ls -1 /dev/serial/by-bus</script>
              </completionHelp>
              <valueHelp>
                <format>ttySxxx</format>
                <description>Regular serial interface</description>
              </valueHelp>
              <valueHelp>
                <format>usbxbxpx</format>
                <description>USB based serial interface</description>
              </valueHelp>
              <constraint>
                <regex>^(ttyS\d+|usb\d+b.*p.*)$</regex>
              </constraint>
            </properties>
            <children>
              #include <include/interface-description.xml.i>
              #include <include/port-number.xml.i>
              <leafNode name="speed">
                <properties>
                  <help>Serial port baud rate</help>
                  <completionHelp>
                    <list>300 1200 2400 4800 9600 19200 38400 57600 115200</list>
                  </completionHelp>
                  <constraint>
                    <regex>(300|1200|2400|4800|9600|19200|38400|57600|115200)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="data-bits">
                <properties>
                  <help>Serial port data bits (default: 8)</help>
                  <completionHelp>
                    <list>7 8</list>
                  </completionHelp>
                  <constraint>
                    <regex>(7|8)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="stop-bits">
                <properties>
                  <help>Serial port stop bits (default: 1)</help>
                  <completionHelp>
                    <list>1 2</list>
                  </completionHelp>
                  <constraint>
                    <regex>(1|2)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="parity">
                <properties>
                  <help>Parity setting (default: none)</help>
                  <completionHelp>
                    <list>even odd none</list>
                  </completionHelp>
                  <constraint>
                    <regex>(even|odd|none)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <node name="ssh">
                <properties>
                  <help>SSH remote access to this console</help>
                </properties>
                <children>
                  #include <include/port-number.xml.i>
                </children>
              </node>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>