Andi

Summary

This variable is available as andi global variable

Methods: Andi.auto_fix_channels()

Andi.clear_output_console()

Andi.create_channel()

Andi.create_node()

Andi.create_signals_node()

Andi.create_timer()

Andi.detect_hardware()

Andi.get_adapters()

Andi.get_output_console()

Andi.get_project_name()

Andi.load_channels()

Andi.load_database()

Structure

class Andi

auto_fix_channels(): Set the channels adapters.

clear_output_console(): Clears the ANDi's output console

create_channel(adapter_id: str) → IChannelAdapter

Creates a channel.

Parameters: adapter_id (str) – Adapter's name follows a special naming format: see Adapter Naming Notations in documentation for more info
Returns: Channel adapter.
Return type: IChannelAdapter

create_channel(driver: str, link: str, dev_port: int32, dev_id: int32 or None = None, dev_ip: str = None, dev_mac: str = None, sys_nic: str = None) → IChannelAdapter

Creates a channel.

Parameters

driver (str) – Protocol/driver used.
Possible values: tecmp, bts, btsevo.
link (str) – Link layer.
Possible values: can, canfd, lin, flexray, serial, analog, ethernet, io.
dev_port (int32) – Port assigned to the channel (CM Channel ID, BTS interface ID...).
dev_id (int32 or None) – Device ID (CM ID, BTS Board Index...).
dev_ip (str) – Device IP.
dev_mac (str) – Device MAC address.
sys_nic (str) – PC network interface.

Returns

Channel adapter.

Return type

IChannelAdapter

create_node(database: DatabaseEthernet, ecu_name: str, channel: object) → EcuNodeEthernet

Creates and returns a SOME/IP RBS node.

Parameters

database (DatabaseEthernet) – The Ethernet database from which we will get our ECU.
ecu_name (str) – ECU Name.
channel (object) – Channel object or channel name

Returns

Ethernet ECU created node

Return type

EcuNodeEthernet

create_signals_node(database: ISignalDatabase, ecu_name: str, channel: object) → IEcuSignalsNode

Creates and returns a CAN or PDU RBS node.

Parameters

database (ISignalDatabase) – The CAN or PDU database from which we will get our ECU.
ecu_name (str) – ECU Name.
channel (object) – Channel object or channel name

Returns

CAN or PDU ECU created node

Return type

IEcuSignalsNode

create_timer() → Timer

Creates and returns a timer object.

Returns: Timer object created.
Return type: Timer

detect_hardware(): Detects hardware.

get_adapters() → List[Adapter]

Gets the list of the available adapters.

Returns: List of available adapters.
Return type: List[Adapter]

get_output_console() → str

Gets the text that's displayed in the ANDi's output console.

Returns: Text displayed on output console
Return type: str

get_project_name() → str

Gets the current project name.

Returns: Project's name
Return type: str

load_channels(file_path: str) → Dictionary[str, IChannelAdapter]

Gets a dictionary of loaded channels.

Parameters: file_path (str) – Channels Configuration file path
Returns: Dictionary of loaded channels.
Return type: Dictionary[str, IChannelAdapter]

load_database(file_path: str, type: str = None, e2e_config_file: str = None) → Database

load data base.

Parameters

file_path (str) – database path
file_path could also have a specific structure in case the file_path is a db file db_file_path|database_name
type (str) – type of database to parse.
One of ethernet, pdu, can. Default: auto detect.
e2e_config_file (str) – customized E2E config file
For furter information, please refer to E2E tutorial

Returns

database given in parameter

Return type

Database