Skip to main content

remotive-topology

A CLI tool for interacting with RemotiveTopology.

USAGE:
    remotive-topology
    remotive-topology --version
    remotive-topology --help
    remotive-topology help subcommand

SUBCOMMANDS:

    show                     Show information from database file                
    generate                 Generate topology environment based on instance    
                             descriptions                                       
    recording-session        Work with recording sessions                       
    split                    [DEPRECATED] Extract individual signal databases   
                             for each channel in a RemotiveTopology platform.   
    convert                  [EXPERIMENTAL] Convert signal database to different
                             format. Currently only CAN frames is supported.    
    gateway-mapping          [EXPERIMENTAL] List gateway mapping for ECU

remotive-topology show​

Show information from database file

USAGE:
    remotive-topology show

SUBCOMMANDS:

    signals          [EXPERIMENTAL] Show signals in the provided database file  
    constants        [EXPERIMENTAL] Extract constants from database file        
    topology         Shows the topology from database or instance file          
    ethernet         [EXPERIMENTAL] Shows Ethernet configuration from database  
                     file                                                       
    services         [EXPERIMENTAL] Show SOME/IP services from database file

remotive-topology show signals​

[EXPERIMENTAL] Show signals in the provided database file

USAGE:
    remotive-topology show signals [--json] [--yaml] [--jsonl] [--bf] PATH [OUT_PATH]

ARGS:

    PATH            Path to the Database file, supported extensions: extensions:
                    '.arxml', '.dbc', '.xml', '.ldf', '.signaldb.yaml'          
    OUT_PATH        Write content to provided file path                         

FLAGS:

    --json         Output results in JSON format                                
    --yaml         Output results in YAML format (default)                      
    --jsonl        Output results in JSONL format                               
    --bf           Output results in broker format

remotive-topology show constants​

[EXPERIMENTAL] Extract constants from database file

USAGE:
    remotive-topology show constants [--json] [--yaml] PATH

ARGS:

    PATH        Path to the Database file, supported extensions: extensions:    
                '.arxml'                                                        

FLAGS:

    --json        Output results in JSON format                                 
    --yaml        Output results in YAML format (default)

remotive-topology show topology​

Shows the topology from database or instance file

USAGE:
    remotive-topology show topology [--json] [--yaml] [--resolve] [--check] [--verbose] [--out-path OUT_PATH] PATH

ARGS:

    PATH        Path to the Database file, supported extensions: extensions:    
                '.arxml', '.xml', '.instance.yaml', '.platform.yaml', '.dbc',   
                '.ldf', '.signaldb.yaml'                                        

FLAGS:

    --json           Output results in JSON format                              
    --yaml           Output results in YAML format (default)                    
    --resolve        Show the resolved topology                                 
    --check          Check topology, requires --resolve                         
    --verbose        Show verbose output                                        

OPTIONS:

    -o, --out-path        Write content to provided file path

remotive-topology show ethernet​

[EXPERIMENTAL] Shows Ethernet configuration from database file

USAGE:
    remotive-topology show ethernet [--json] [--yaml] PATH

ARGS:

    PATH        Path to the Database file, supported extensions: extensions:    
                '.arxml'                                                        

FLAGS:

    --json        Output results in JSON format                                 
    --yaml        Output results in YAML format (default)

remotive-topology show services​

[EXPERIMENTAL] Show SOME/IP services from database file

USAGE:
    remotive-topology show services [--json] [--yaml] [--services SERVICES] PATH

ARGS:

    PATH        Path to the Database file, supported extensions: extensions:    
                '.arxml'                                                        

FLAGS:

    --json        Output results in JSON format                                 
    --yaml        Output results in YAML format (default)                       

OPTIONS:

    -s, --services        List of SOME/IP services to process

remotive-topology generate​

Generate topology environment based on instance descriptions

USAGE:
    remotive-topology generate [--name NAME] --file TOPOLOGY_FILES <topology_output_path>

ARGS:

    <topology_output_path>        Path to where generated files should be       
                                  written                                       

OPTIONS:

    -n, --name        Name of the generated topology                            
    -f, --file        RemotiveTopology .instance.yaml file(s), applied in the   
                      order they are provided

remotive-topology recording_session​

Work with recording sessions

USAGE:
    remotive-topology recording-session

SUBCOMMANDS:

    create             Create a new recording session from recording files      
    instantiate        Create a topology instance ready to play a recording     
                       session                                                  
    recalculate        Recalculate the recording session start and end time     
                       based on the files and their offsets

remotive-topology recording_session create​

Create a new recording session from recording files

USAGE:
    remotive-topology recording-session create [--json] [--yaml] --file RECORDING_FILES [OUT_PATH]

ARGS:

    OUT_PATH        Write content to provided file path                         

FLAGS:

    --json        Output results in JSON format                                 
    --yaml        Output results in YAML format (default)                       

OPTIONS:

    -f, --file        Recording file(s), applied in the order they are provided,
                      e.g. candump.log, .csv

remotive-topology recording_session instantiate​

Create a topology instance ready to play a recording session

USAGE:
    remotive-topology recording-session instantiate [--json] [--yaml] RECORDING_SESSION [OUT_PATH]

ARGS:

    RECORDING_SESSION        Path to the recording session file                 
    OUT_PATH                 Write content to provided file path                

FLAGS:

    --json        Output results in JSON format                                 
    --yaml        Output results in YAML format (default)

remotive-topology recording_session recalculate​

Recalculate the recording session start and end time based on the files and their offsets

USAGE:
    remotive-topology recording-session recalculate [--json] [--yaml] RECORDING_SESSION [OUT_PATH]

ARGS:

    RECORDING_SESSION        Path to the recording session file                 
    OUT_PATH                 Write content to provided file path                

FLAGS:

    --json        Output results in JSON format                                 
    --yaml        Output results in YAML format (default)

remotive-topology split​

[DEPRECATED] Extract individual signal databases for each channel in a RemotiveTopology platform.

USAGE:
    remotive-topology split --file TOPOLOGY_DESCRIPTION_FILES OUT_PATH

ARGS:

    OUT_PATH        Path to a folder where generated signal databases should be 
                    written                                                     

OPTIONS:

    -f, --file        RemotiveTopology platform file(s), applied in the order   
                      they are provided

remotive-topology convert​

[EXPERIMENTAL] Convert signal database to different format. Currently only CAN frames is supported.

USAGE:
    remotive-topology convert --file TOPOLOGY_DESCRIPTION_FILES [--output OUTPUT_FILE] [--format FORMAT] [--channel CHANNEL_NAMES]

OPTIONS:

    -f, --file           RemotiveTopology platform file                         
    -o, --output         Optional path to a file where generated signal database
                         should be written. If not provided, the result will be 
                         printed to stdout.                                     
    --format             Format to convert to. Currently only 'remotive' is     
                         supported. (default: remotive)                         
    -c, --channel        Optional channel(s) to convert. If not provided, all   
                         CAN channels will be converted.

remotive-topology gateway_mapping​

[EXPERIMENTAL] List gateway mapping for ECU

USAGE:
    remotive-topology gateway-mapping [--only-fully-resolved] --gateway-ecu GATEWAY_ECU --platform PLATFORM OUT_PATH

ARGS:

    OUT_PATH        Path to file where extracted gateway mapping should be      
                    written                                                     

FLAGS:

    -o, --only-fully-resolved        Only show fully resolved mapping           

OPTIONS:

    -g, --gateway-ecu        Gateway ECU name                                   
    -p, --platform           Topology platform