Rename cli tools/cleanup cli args [CPP-633] [CPP-655] (#417)

* rename piksi-settings -> swift-settings

* rename fileio -> swift-files

* replace subcommand style connection inputs with flags

Author: notoriaga

.cargo/config

@@ -11,5 +11,5 @@ rustflags = [
 ]
 
 [alias]
-fileio = "run --bin fileio --no-default-features --features env_logger,indicatif --"
-settings = "run --bin piksi-settings --no-default-features --features env_logger --"
+files = "run --bin swift-files --no-default-features --features env_logger,indicatif --"
+settings = "run --bin swift-settings --no-default-features --features env_logger --"

.github/workflows/main.yml

@@ -306,28 +306,28 @@ jobs:
           echo "INSTALLER_ARCHIVE=$(cat installer-archive.filename)" >>$GITHUB_ENV
         if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
 
-      - name: Build ${{ runner.os }} fileio binary.
+      - name: Build ${{ runner.os }} swift-files binary.
         run: |
-          cargo build --bin fileio --features="env_logger,indicatif" --release
+          cargo build --bin swift-files --features="env_logger,indicatif" --release
         # Building on Mac currently not working (DEVINFRA-612)
         if: matrix.os.name != 'windows-2019' && matrix.os.name != 'macos-10.15'
 
-      - name: Build ${{ runner.os }} fileio binary.
+      - name: Build ${{ runner.os }} swift-files binary.
         run: |
-          cargo build --bin fileio --features="env_logger,indicatif" --release
+          cargo build --bin swift-files --features="env_logger,indicatif" --release
         env:
           LIBCLANG_PATH: ${{ env.LIBCLANG_PATH_WIN }}
         if: matrix.os.name == 'windows-2019'
 
-      - name: Build ${{ runner.os }} piksi-settings binary.
+      - name: Build ${{ runner.os }} swift-settings binary.
         run: |
-          cargo build --bin piksi-settings --features="env_logger" --release
+          cargo build --bin swift-settings --features="env_logger" --release
         # Building on Mac currently not working (DEVINFRA-612)
         if: matrix.os.name != 'windows-2019' && matrix.os.name != 'macos-10.15'
 
-      - name: Build ${{ runner.os }} piksi-settings binary.
+      - name: Build ${{ runner.os }} swift-settings binary.
         run: |
-          cargo build --bin piksi-settings --features="env_logger" --release
+          cargo build --bin swift-settings --features="env_logger" --release
         env:
           LIBCLANG_PATH: ${{ env.LIBCLANG_PATH_WIN }}
         if: matrix.os.name == 'windows-2019'
@@ -363,12 +363,12 @@ jobs:
             release-archive.filename
       - uses: actions/upload-artifact@v2
         with:
-          name: fileio_${{ matrix.os.short_name }}
-          path: ./target/release/fileio${{ matrix.os.exe_suffix }}
+          name: swift-files_${{ matrix.os.short_name }}
+          path: ./target/release/swift-files${{ matrix.os.exe_suffix }}
       - uses: actions/upload-artifact@v2
         with:
-          name: piksi-settings_${{ matrix.os.short_name }}
-          path: ./target/release/piksi-settings${{ matrix.os.exe_suffix }}
+          name: swift-settings_${{ matrix.os.short_name }}
+          path: ./target/release/swift-settings${{ matrix.os.exe_suffix }}
       - uses: actions/upload-artifact@v2
         with:
           name: ${{ runner.os }}-artifacts-debug
@@ -533,30 +533,30 @@ jobs:
         with:
           name: Windows-installer-signed
           path: windows
-      - name: Pull Windows fileio
+      - name: Pull Windows swift-files
         uses: actions/download-artifact@v2
         with:
-          name: fileio_windows
+          name: swift-files_windows
           path: windows
-      - name: Pull Windows piksi-settings
+      - name: Pull Windows swift-settings
         uses: actions/download-artifact@v2
         with:
-          name: piksi-settings_windows
+          name: swift-settings_windows
           path: windows
       - name: Pull Linux Installer
         uses: actions/download-artifact@v2
         with:
           name: Linux-installer
           path: linux
-      - name: Pull Linux fileio
+      - name: Pull Linux swift-files
         uses: actions/download-artifact@v2
         with:
-          name: fileio_linux
+          name: swift-files_linux
           path: linux
-      - name: Pull Linux piksi-settings
+      - name: Pull Linux swift-settings
         uses: actions/download-artifact@v2
         with:
-          name: piksi-settings_linux
+          name: swift-settings_linux
           path: linux
       - name: Pull macOS Installer
         uses: actions/download-artifact@v2
@@ -567,10 +567,10 @@ jobs:
       - name: Prepare Release
         shell: bash
         run: |
-          mv linux/fileio linux/fileio_${{ env.VERSION }}_linux
-          mv linux/piksi-settings linux/piksi-settings_${{ env.VERSION }}_linux
-          mv windows/fileio.exe windows/fileio_${{ env.VERSION }}_windows.exe
-          mv windows/piksi-settings.exe windows/piksi-settings_${{ env.VERSION }}_windows.exe
+          mv linux/swift-files linux/swift-files_${{ env.VERSION }}_linux
+          mv linux/swift-settings linux/swift-settings_${{ env.VERSION }}_linux
+          mv windows/swift-files.exe windows/swift-files_${{ env.VERSION }}_windows.exe
+          mv windows/swift-settings.exe windows/swift-settings_${{ env.VERSION }}_windows.exe
           echo "WINDOWS_ARCHIVE=$(cat windows/installer-archive.filename)" >>$GITHUB_ENV
           echo "LINUX_ARCHIVE=$(cat linux/installer-archive.filename)" >>$GITHUB_ENV
           echo "MACOS_ARCHIVE=$(cat macos/installer-archive.filename)" >>$GITHUB_ENV
@@ -580,11 +580,11 @@ jobs:
           name: "${{ env.VERSION }}-${{ env.DATE }}"
           files: |
             windows/${{ env.WINDOWS_ARCHIVE }}
-            windows/fileio_${{ env.VERSION }}_windows.exe
-            windows/piksi-settings_${{ env.VERSION }}_windows.exe
+            windows/swift-files_${{ env.VERSION }}_windows.exe
+            windows/swift-settings_${{ env.VERSION }}_windows.exe
             linux/${{ env.LINUX_ARCHIVE }}
-            linux/fileio_${{ env.VERSION }}_linux
-            linux/piksi-settings_${{ env.VERSION }}_linux
+            linux/swift-files_${{ env.VERSION }}_linux
+            linux/swift-settings_${{ env.VERSION }}_linux
             macos/${{ env.MACOS_ARCHIVE }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

console_backend/Cargo.toml

@@ -73,14 +73,14 @@ name = "cpu_benches"
 harness = false
 
 [[bin]]
-name = "piksi-settings"
+name = "swift-settings"
 path = "src/bin/settings.rs"
 bench = false
 required-features = ["env_logger"]
 
 [[bin]]
-name = "fileio"
-path = "src/bin/fileio.rs"
+name = "swift-files"
+path = "src/bin/files.rs"
 bench = false
 required-features = ["env_logger", "indicatif"]
 

console_backend/src/bin/fileio.rs renamed to console_backend/src/bin/files.rs

@@ -11,16 +11,16 @@ use std::{
 use anyhow::{anyhow, Context};
 use clap::{
     AppSettings::{ArgRequiredElseHelp, DeriveDisplayOrder},
-    Parser,
+    Args, Parser,
 };
 use indicatif::{ProgressBar, ProgressStyle};
 use sbp::{link::LinkSource, SbpIterExt};
 
 use console_backend::{
-    cli_options::ConnectionOpts,
+    cli_options::is_baudrate,
     connection::Connection,
     fileio::Fileio,
-    types::{MsgSender, Result},
+    types::{FlowControl, MsgSender, Result},
 };
 
 fn main() -> Result<()> {
@@ -44,36 +44,36 @@ fn main() -> Result<()> {
     }
 }
 
-/// Piksi File IO operations.
+/// A SwiftNav fileio API client
 #[derive(Parser)]
 #[clap(
-    name = "fileio",
+    name = "swift-files",
     version = include_str!("../version.txt"),
     setting = ArgRequiredElseHelp | DeriveDisplayOrder,
     override_usage = "\
-    fileio <SRC> <DEST>
-    fileio --list <SRC>
-    fileio --delete <SRC>
+    swift-files <SRC> <DEST>
+    swift-files --list <SRC>
+    swift-files --delete <SRC>
 
     TCP Examples:
         - List files on Piksi:
-            fileio --list 192.168.0.222:/data/
+            swift-files --list 192.168.0.222:/data/
         - Read file from Piksi:
-            fileio 192.168.0.222:/persistent/config.ini ./config.ini
+            swift-files 192.168.0.222:/persistent/config.ini ./config.ini
         - Write file to Piksi:
-            fileio ./config.ini 192.168.0.222:/persistent/config.ini
+            swift-files ./config.ini 192.168.0.222:/persistent/config.ini
         - Delete file from Piksi:
-            fileio --delete 192.168.0.222:/persistent/unwanted_file
+            swift-files --delete 192.168.0.222:/persistent/unwanted_file
 
     Serial Examples:
         - List files on Piksi:
-            fileio --list /dev/ttyUSB0:/data/
+            swift-files --list /dev/ttyUSB0:/data/
         - Read file from Piksi:
-            fileio /dev/ttyUSB0:/persistent/config.ini ./config.ini
+            swift-files /dev/ttyUSB0:/persistent/config.ini ./config.ini
         - Write file to Piksi:
-            fileio ./config.ini /dev/ttyUSB0:/persistent/config.ini
+            swift-files ./config.ini /dev/ttyUSB0:/persistent/config.ini
         - Delete file from Piksi:
-            fileio --delete /dev/ttyUSB0:/persistent/unwanted_file
+            swift-files --delete /dev/ttyUSB0:/persistent/unwanted_file
     "
 )]
 struct Opts {
@@ -95,6 +95,26 @@ struct Opts {
     conn: ConnectionOpts,
 }
 
+#[derive(Clone, Copy, Args)]
+struct ConnectionOpts {
+    /// The port to use when connecting via TCP
+    #[clap(long, default_value = "55555", conflicts_with_all = &["baudrate", "flow-control"])]
+    port: u16,
+
+    /// The baudrate for processing packets when connecting via serial
+    #[clap(
+        long,
+        default_value = "115200",
+        validator(is_baudrate),
+        conflicts_with = "port"
+    )]
+    baudrate: u32,
+
+    /// The flow control spec to use when connecting via serial
+    #[clap(long, default_value = "None", conflicts_with = "port")]
+    flow_control: FlowControl,
+}
+
 fn list(target: Target, conn: ConnectionOpts) -> Result<()> {
     let remote = target
         .into_remote()
@@ -208,7 +228,7 @@ struct Remote {
 
 impl Remote {
     fn connect(&self, conn: ConnectionOpts) -> Result<Fileio> {
-        let (reader, writer) = Connection::discover(self.host.clone(), conn)?.try_connect(None)?;
+        let (reader, writer) = discover(self.host.clone(), conn)?.try_connect(None)?;
         let source = LinkSource::new();
         let link = source.link();
         std::thread::spawn(move || {
@@ -259,3 +279,18 @@ impl ReadProgress {
         }
     }
 }
+
+/// Connect via a serial port or tcp
+fn discover(host: String, opts: ConnectionOpts) -> Result<Connection> {
+    match fs::File::open(&host) {
+        Err(e) if e.kind() == io::ErrorKind::PermissionDenied => Err(e.into()),
+        Ok(_) => {
+            log::debug!("connecting via serial");
+            Ok(Connection::serial(host, opts.baudrate, opts.flow_control))
+        }
+        Err(_) => {
+            log::debug!("connecting via tcp");
+            Connection::tcp(host, opts.port)
+        }
+    }
+}

console_backend/src/bin/headless-console.rs

@@ -13,14 +13,14 @@ use crossbeam::channel;
 
 fn main() -> Result<()> {
     let opt = CliOptions::from_filtered_cli();
-    if opt.input.is_none() {
+    if opt.serial.serial.is_none() && opt.tcp.tcp.is_none() && opt.file.file.is_none() {
         eprintln!(
             r#"
 Running in headless mode only command line options work.
 Help:
 ./headless-console --help
 Usage:
-./headless-console tcp piksi-relay-bb9f2b10e53143f4a816a11884e679cf.ce.swiftnav.com --port=55555
+./headless-console --tcp piksi-relay-bb9f2b10e53143f4a816a11884e679cf.ce.swiftnav.com --port=55555
 "#
         );
         return Ok(());

console_backend/src/bin/settings.rs

@@ -1,10 +1,11 @@
 use std::{convert::Infallible, path::PathBuf, str::FromStr, sync::Arc};
 
-use clap::{AppSettings::DeriveDisplayOrder, Parser};
+use anyhow::anyhow;
+use clap::{AppSettings::DeriveDisplayOrder, ArgGroup, Parser};
 use sbp::SbpIterExt;
 
 use console_backend::{
-    cli_options::ConnectionOpts,
+    cli_options::{SerialOpts, TcpOpts},
     client_sender::TestSender,
     connection::Connection,
     settings_tab::SettingsTab,
@@ -72,33 +73,37 @@ fn write(write_cmds: &[WriteCmd], settings: &SettingsTab) -> Result<()> {
     Ok(())
 }
 
-/// Piksi settings operations.
+/// A SwiftNav settings API client
 #[derive(Parser)]
 #[clap(
-    name = "piksi-settings",
+    name = "swift-settings",
     version = include_str!("../version.txt"),
     setting = DeriveDisplayOrder,
+    group = ArgGroup::new("conn").required(true).args(&["serial", "tcp"]),
     override_usage = "\
-    piksi-settings [OPTIONS] <DEVICE>
+    swift-settings [OPTIONS]
 
     Examples:
         - Read a setting:
-            piksi-settings /dev/ttyUSB0 --read imu.acc_range
+            swift-settings --serial /dev/ttyUSB0 --read imu.acc_range
         - Read a group of settings:
-            piksi-settings /dev/ttyUSB0 --read imu
+            swift-settings --serial /dev/ttyUSB0 --read imu
         - Write a setting value:
-            piksi-settings /dev/ttyUSB0 --write imu.acc_range=2g
+            swift-settings --serial /dev/ttyUSB0 --write imu.acc_range=2g
         - Write multiple settings and save to flash:
-            piksi-settings /dev/ttyUSB0 -w imu.acc_range=2g -w imu.imu_rate=100 --save
+            swift-settings --serial /dev/ttyUSB0 -w imu.acc_range=2g -w imu.imu_rate=100 --save
         - Export a device's settings
-            piksi-settings /dev/ttyUSB0 --export ./config.ini
+            swift-settings --serial /dev/ttyUSB0 --export ./config.ini
         - Import a device's settings
-            piksi-settings /dev/ttyUSB0 --import ./config.ini
+            swift-settings --serial /dev/ttyUSB0 --import ./config.ini
     "
 )]
 struct Opts {
-    /// The serial port or TCP stream
-    device: String,
+    #[clap(flatten)]
+    serial: SerialOpts,
+
+    #[clap(flatten)]
+    tcp: TcpOpts,
 
     /// Read a setting or a group of settings
     #[clap(
@@ -147,14 +152,21 @@ struct Opts {
         conflicts_with_all = &["read", "write", "export", "import", "save"]
     )]
     reset: bool,
-
-    #[clap(flatten)]
-    conn: ConnectionOpts,
 }
 
 fn connect(opts: &Opts) -> Result<Arc<SettingsTab>> {
-    let (reader, writer) =
-        Connection::discover(opts.device.clone(), opts.conn)?.try_connect(None)?;
+    let (reader, writer) = if let Some(ref serial) = opts.serial.serial {
+        Connection::serial(
+            serial.to_string_lossy().into(),
+            opts.serial.baudrate,
+            opts.serial.flow_control,
+        )
+        .try_connect(None)?
+    } else if let Some(ref tcp) = opts.tcp.tcp {
+        Connection::tcp(tcp.host.clone(), tcp.port)?.try_connect(None)?
+    } else {
+        return Err(anyhow!("No serialport or tcp string supplied"));
+    };
     let sender = MsgSender::new(writer);
     let shared_state = SharedState::new();
     let settings = Arc::new(SettingsTab::new(shared_state, TestSender::boxed(), sender));