plugins/consoles/vt100cons/doc/vt100cons.pod
changeset 77 60f47003f4b1
parent 34 284c68d7a3ac
child 100 706c7a69e448
equal deleted inserted replaced
74:4349d4d62266 77:60f47003f4b1
   120 
   120 
   121   fshell --console vt100cons --console-title 'pdd=euart1, ldd=ecomm, csy=ecuart, port=comm::0, rate=115200'
   121   fshell --console vt100cons --console-title 'pdd=euart1, ldd=ecomm, csy=ecuart, port=comm::0, rate=115200'
   122 
   122 
   123 =head2 USB Variant
   123 =head2 USB Variant
   124 
   124 
   125 Vt100usbcons behaves the same as the serial variant, with the exception that it waits for USB to enumerate into a personality that supports ACM if not already present. In other words it waits for the USB cable to be inserted before trying to open the port. If necessary it also waits for the user to select a config that includes some USB serial ports. It expects the C<--console-title> argument to be of the format C<ACM::x> where x is the port number. This number is platform-specific but is usually 0 or 1. Generally this will be taken care of already in the platform-specific build of the toolkit and you can just launch the "fshell (USB)" icon.
   125 Vt100usbcons behaves the same as the serial variant, with the exception that it waits for USB to enumerate into a personality that supports ACM if not already present. In other words it waits for the USB cable to be inserted before trying to open the port. If necessary it also waits for the user to select a config that includes some USB serial ports. 
       
   126 
       
   127 vt100usbcons.dll is configured via the C<--console-title> string in a similar way to the serial variant. The follow keyword / value pairs are supported:
       
   128 
       
   129 =over 5
       
   130 
       
   131 =item * C<port=name>
       
   132 
       
   133 The USB port name. This is platform specific but is usually C<ACM::0> or C<ACM::1>. Generally this will be taken care of already in the platform-specific configuration and you can just launch the "fshell (USB)" icon or run "comm.script".
       
   134 
       
   135 =item * C<personality=value>
       
   136 
       
   137 If it is necessary to start a USB personality before connecting, specify the personality number here, for example C<personality=1>. This parameter is not usually needed except on some text-shell builds.
       
   138 
       
   139 =back
       
   140 
       
   141 Example usage:
       
   142 
       
   143   fshell --console vt100usbcons --console-title port=ACM::1,personality=1
       
   144 
       
   145 For compatibility with earlier releases, the C<port=> may be ommitted if there are no other configuration parameters. For example "fshell --console vt100usbcons --console-title ACM::1".
   126 
   146 
   127 =head2 Bluetooth Variant
   147 =head2 Bluetooth Variant
   128 
   148 
   129 Advertises a Bluetooth Serial Port called "Bluetooth Serial Console" and waits for a connection. There are no C<--console-title> configuration options for vt100btcons.
   149 Advertises a Bluetooth Serial Port called "Bluetooth Serial Console" and waits for a connection. There are no C<--console-title> configuration options for vt100btcons.
   130 
   150