python_ics¶

Intrepid Control Systems, Inc. open source Python module for interfacing to Intrepid hardware. Basic knowledge of using and installing Python modules is assumed. Please see https://docs.python.org/3/installing/index.html for documentation on how to install Python modules.

This module is essentially just a wrapper around icsneo40.dll. For more documentation please visit neoVI DLL Documentation under https://intrepidcs.com/support/support-resources/

Whats New?¶

-Updated icsnVC40.h to v905.10 -Fixed a bunch of issues with setting structures. Script was essentially completely re-written with unit tests now.

v903+ Compatibility Changes¶

ISO 15765-2¶

old naming conventions have been updated to reflex closer to the actual codebase.

# Old:
tx_msg = ics.CmISO157652TxMessage()
rx_msg = ics.CmISO157652RxMessage()

# New:
tx_msg = ics.st_cm_iso157652_tx_message.st_cm_iso157652_tx_message()
rx_msg = ics.st_cm_iso157652_rx_message.st_cm_iso157652_rx_message()

ics.st_cm_iso157652_tx_message.st_cm_iso157652_tx_message() data structure is now a ctypes.c_ubytes array instead of a python list.

# Old:
msg.data = [x for x in range(number_of_bytes)]

# New:
my_data = [x for x in range(number_of_bytes)]
msg.data = (ctypes.c_ubyte*len(msg.data))(*my_data)

>>> msg.data
<ics.structures.st_cm_iso157652_tx_message.c_ubyte_Array_4096 object at 0x0000023E534BE940>

Settings¶

v903 and up have converted over to a new auto generation of icsnVC40.h. This enables faster support for newer Intrepid devices and less error prone. With this switch we have moved to using ics.s_device_settings.

# Old behavior:
device = ics.open_device()
settings = ics.get_device_settings(device)
# settings is a Vcan3Settings type
settings.can1.Baudrate = 1
ics.set_device_settings(device, settings)

# New behavior
device = ics.open_device()
settings = ics.get_device_settings(device)
# settings is a s_device_settings type
settings.vcan3.can1.Baudrate = 1
ics.set_device_settings(device, settings)

Setting support for the following devices:

red: s_red_settings
fire: s_fire_settings
firevnet: s_fire_vnet_settings
cyan: s_cyan_settings (FIRE2)
vcan3: svcan3_settings
vcan4: svcan4_settings
ecu: secu_settings
ievb: sievb_settings
pendant: s_pendant_settings
radgalaxy: srad_galaxy_settings
radstar2: srad_star2_settings
neoobd2_sim: sobd2_sim_settings
cmprobe: s_cm_probe_settings
obd2pro: sobd2_pro_settings
vcan412: svcan412_settings
vcan4_12: svcan412_settings
neoecu_avb: secu_avb_settings
radsupermoon: srad_super_moon_settings
radmoon2: srad_moon2_settings
pluto: srad_pluto_settings
plutoswitch: s_pluto_switch_settings_s
radgigalog: srad_gigalog_settings
canhub: scan_hub_settings
neoecu12: s_neo_ecu12_settings
vcanrf: svcanrf_settings
eevb: seevb_settings
flexvnetz: s_flex_vnetz_settings
vividcan: s_vivid_can_settings
vcan4_ind: svcan4_ind_settings
radgigastar: srad_gigastar_settings
jupiter: srad_jupiter_settings
fire3: s_fire3_settings
radmoon_duo: s_rad_moon_duo_settings

PyInstaller¶

Due to the added complexity underneath when building PyInstaller hidden_imports.py should be used now in your spec script:

# -*- mode: python ; coding: utf-8 -*-

import ics

block_cipher = None


a = Analysis(['test.py'],
             pathex=['.'],
             binaries=[],
             datas=[],
             hiddenimports=ics.hidden_imports,
             hookspath=[],
             runtime_hooks=[],
             excludes=[],
             win_no_prefer_redirects=False,
             win_private_assemblies=False,
             cipher=block_cipher,
             noarchive=False)
pyz = PYZ(a.pure, a.zipped_data,
             cipher=block_cipher)
exe = EXE(pyz,
          a.scripts,
          [],
          exclude_binaries=True,
          name='test',
          debug=False,
          bootloader_ignore_signals=False,
          strip=False,
          upx=True,
          console=True )
coll = COLLECT(exe,
               a.binaries,
               a.zipfiles,
               a.datas,
               strip=False,
               upx=True,
               upx_exclude=[],
               name='test')

Other Fixes and Changes¶

Expanded documentation.
Adding support for Python 3.8 and Python 3.9.
Updated iso15765 example to utilize new flags.
Updated documentation to mention libicsneolegacy.so
Fixed an issue when get_messages() timeout was 0 no messages were returned.
Updated documentation and added use_server option for opening devices.
Added read_jupiter_firmware and write_jupiter_firmware methods.
Fixed a memory leak in find_devices()
Add methods for Gigalog/Gigastar disk formatting
Fixed a documentation issue per issue #90
Fixed month being offset by 1 in ics.get_rtc().
Fixed transmit_messages() to handle extended network ids.
Fixed code related to meth_get_backup_power_ready() internally.

Versioning Information¶

Minor differences can occur between different icsnVC40.h versions. These differences are usually just structures and constant differences. Below is a list of how the python_ics version correlates to the icsnVC40.h version:

v903¶

Starting with 903, python_ics module will now match official upstream version releases.

pip install 'python_ics>=5.0,<904.0' --force-reinstall

Note: Refer to platform specific installation if not on Windows

Older Versions:¶

v802

pip install 'python_ics>=2.0,<3.0' --force-reinstall

Note: Refer to platform specific installation if not on Windows
v803

pip install 'python_ics>=3.0,<4.0' --force-reinstall

Note: Refer to platform specific installation if not on Windows
v900

pip install 'python_ics>=4.0,<5.0' --force-reinstall

Note: Refer to platform specific installation if not on Windows

Installation on Windows¶

PyPi provides binary packages for Windows. You can simply install the python_ics module by running the following command:

pip install python_ics

Note: pip.exe is usually located under the Scripts directory under the Python installation directory.

Building from source¶

Building from source on windows is not usually need so it won’t really be covered here in detail. As a starting point you’ll need to match the compiler version used to build the official Python binaries (MSVC). If the build environment is setup correctly, you should be able to run python setup.py build like usual.

Intrepid icsneo40 Library¶

python_ics module looks for icsneo40.dll in the normal windows DLL search paths. The module will throw an exception if its not found.

Installation on Linux¶

python_ics does not provide binaries for linux distributions so we will have to compile from source. This can be easily achieved by utilzing Python’s PIP. First we need to make sure we have some base packages installed.

libicsneo is a newer library and has wider support for Intrepid Products under linux (https://github.com/intrepidcs/libicsneo). libicsneo has a legacy library (libicsneolegacy.so) that can be loaded by utilizing ics.override_library_name("libicsneolegacy.so").

Fedora Dependencies (FC28)¶

sudo dnf install redhat-rpm-config gcc g++ python3-devel

Debian/Ubuntu Dependencies¶

sudo apt install build-essential python-dev

Others (Required dependencies)¶

GCC
G++
Python Development packages (We Need to link to Python.h)

Installation¶

After dependencies are installed we can run the following pip command:

pip install python_ics

Note: A lot of distributions have Python 2 and 3 installed side by side. As of this writing without a version suffix the commands still default to version 2 of the Python binaries. In order to utilize the Python 3 binaries you must append a 3 after the binary names (python3 and pip3 instead of just python and pip).

Intrepid libicsneoapi.so Library¶

Please see https://github.com/intrepidcs/icsneoapi for more details.

Getting Started¶

Please see https://github.com/intrepidcs/python_ics/tree/master/examples for simple examples on how to use this module. Most function documentation has a simple example on how its intended to be used. Every function was designed to be as close as possible to it’s C counterpart unless it was deemed to make the function more pythonic in nature.

For those experienced with the C API ics.open_device (icsneoOpenNeoDevice()) behavior has been changed the most (no parameters makes it auto utilize ics.find_devices (icsneoFindNeoDevices()) and open the first device). Also since python is a object oriented language the module utilizes this and auto cleans up device handles when going out of scope so there is usually no need to call ics.close_device().

Examples¶

Examples can be found at https://github.com/intrepidcs/python_ics/tree/master/examples

For extra information on data structures and underlying functionality, please visit neoVI DLL Documentation under https://intrepidcs.com/support/support-resources/

Opening a device¶

The open_device_example.py example shows how to successfully open and close an Intrepid device.

Transmitting and Receiving a CAN message¶

The following examples show how to interact with CAN messages on an Intrepid device.

transmit_can_example.py: Basic example showing how to transmit and receive standard CAN frame
transmit_can_xtd_example.py: Builds off of the CAN example and adds extended Arbitration ID attributes
canfd_transmit_example.py: Bare minimum example on how to transmit over CANFD.

ISO 15765-2 Example¶

The iso15765_example.py example shows how to setup basic ISO 15765-2 receive filters and transmitting an ISO 15765-2 message.

After opening an Intrepid device ics.iso15765_enable_networks should be called to enable ISO 15765-2.

Receive filtering can be established by passing a custom ics.CmISO157652RxMessage() to ics.iso15765_receive_message().

Similarly transmitting an ISO 15765-2 frame can be accomplished by passing a custom ics.CmISO157652TxMessage() to ics.iso15765_transmit_message().

Missing an example?¶

Need an example on something that isn’t covered here? Please submit an issue on github or feel free to send over a Pull Request of your own.

Module Documentation¶

Python C Code module for interfacing to the icsneo40 dynamic library. Code tries to respect PEP 8 (http://python.org/dev/peps/pep-0008). Function naming convention does not follow the tradition c style icsneo40 naming convention as pyics module name acts as the namespace (icsneo portion of the function) and function names are suppose to be lowercase with underscores instead of mixedCase like icsneo API.

C API can be mimiced almost identically by doing the following:

>>> import ics as icsneo
>>> devices = icsneo.FindNeoDevices()
>>> for device in devices:
...     print(device.Name, device.SerialNumber)
...
neoVI FIRE 59886

Recommended Python way by doing the following:

>>> import ics
>>> devices = ics.find_devices()
>>> for device in devices:
...     print(device.Name, device.SerialNumber)
...
neoVI FIRE 59886

It should be noted that ics.ics.NeoDevice is used a little bit differently than the C API. ics.ics.NeoDevice contains two extra members:

ics.ics.NeoDevice.AutoHandleClose and ics.ics.NeoDevice._Handle

The handle normally returned from icsneoOpenNeoDevice() is stored inside _Handle and setting AutoHandleClose to True (Default) will automatically close the handle when the ics.ics.NeoDevice goes out of scope.

Installation:

pip install python_ics

https://pypi.python.org/pypi/python-ics

exception ics.ics.ArgumentError¶: Bases: Exception

exception ics.ics.RuntimeError¶: Bases: Exception

class ics.ics.NeoDevice¶

Bases: object

NeoDevice object

AutoHandleClose¶: When NeoDevice is freed the handle will automatically be closed, if true.

DeviceType¶

Handle¶

IsOpen¶: This contains the handle returned from icsneoOpenDevice() API. If uncertain, don’t use this.

MaxAllowedClients¶

Name¶: String describing DeviceType, extension to Python api only.

NumberOfClients¶

SerialNumber¶

class ics.ics.SpyMessage¶

Bases: object

SpyMessage object

AckBytes¶

ArbIDOrHeader¶

Data¶

DescriptionID¶: Not Used

ExtraDataPtr¶

ExtraDataPtrEnabled¶

MessagePieceID¶: Not Used

MiscData¶

NetworkID¶: This value is used to identify which network this message was received on.

NetworkID2¶: This value is used to identify which network this message was received on.

NodeID¶: Not Used

NumberBytesData¶: Holds the number of bytes in the Data(1 to 8) array or the number of bytes in a CAN remote frame (The DLC).

NumberBytesHeader¶: Used for J1850/ISO messages. It indicates how many bytes are stored in the Header(1 to 4) array.

Protocol¶: Valid values are SPY_PROTOCOL_CAN, SPY_PROTOCOL_J1850VPW, and SPY_PROTOCOL_ISO9141.

StatusBitField¶

StatusBitField2¶

StatusBitField3¶

StatusBitField4¶

TimeHardware¶: Hardware time stamp. The TimeStamp is reset on device open

TimeHardware2¶: Hardware time stamp. The TimeStamp is reset on device open

TimeStampHardwareID¶: This is an identifier of what type of hardware timestamp is used. Since neoVI’s timestamp is always the same, this doesn’t change.

TimeStampSystemID¶: This is an identifier of what type of system timestamp is used. Since WIN32 neoVI’s timestamp is always the same, from the timeGetTime API, this doesn’t change.

TimeSystem¶: TimeSystem is loaded with the value received from the timeGetTime call in the WIN32 multimedia API.

TimeSystem2¶: TimeSystem is loaded with the value received from the timeGetTime call in the WIN32 multimedia API.

noExtraDataPtrCleanup¶: Tells Python to not clean up ExtraDataPtrMemory, If this is enabled. Ignore, if unsure.

class ics.ics.SpyMessageJ1850¶

Bases: object

SpyMessageJ1850 object

AckBytes¶

Data¶

DescriptionID¶: Not Used

ExtraDataPtr¶

ExtraDataPtrEnabled¶

Header¶

MessagePieceID¶: Not Used

MiscData¶

NetworkID¶: This value is used to identify which network this message was received on.

NetworkID2¶: This value is used to identify which network this message was received on.

NodeID¶: Not Used

NumberBytesData¶: Holds the number of bytes in the Data(1 to 8) array or the number of bytes in a CAN remote frame (The DLC).

NumberBytesHeader¶: Used for J1850/ISO messages. It indicates how many bytes are stored in the Header(1 to 4) array.

Protocol¶: Valid values are SPY_PROTOCOL_CAN, SPY_PROTOCOL_J1850VPW, and SPY_PROTOCOL_ISO9141.

StatusBitField¶

StatusBitField2¶

StatusBitField3¶

StatusBitField4¶

TimeHardware¶: Hardware time stamp. The TimeStamp is reset on device open

TimeHardware2¶: Hardware time stamp. The TimeStamp is reset on device open

TimeStampHardwareID¶: This is an identifier of what type of hardware timestamp is used. Since neoVI’s timestamp is always the same, this doesn’t change.

TimeStampSystemID¶: This is an identifier of what type of system timestamp is used. Since WIN32 neoVI’s timestamp is always the same, from the timeGetTime API, this doesn’t change.

TimeSystem¶: TimeSystem is loaded with the value received from the timeGetTime call in the WIN32 multimedia API.

TimeSystem2¶: TimeSystem is loaded with the value received from the timeGetTime call in the WIN32 multimedia API.

noExtraDataPtrCleanup¶: Tells Python to not clean up ExtraDataPtrMemory, If this is enabled. Ignore, if unsure.

ics.ics.ClosePort()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.close_device() method.

ics.ics.EnableBusVoltageMonitor()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.enable_bus_voltage_monitor() method.

ics.ics.EnableNetworkCom()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.enable_network_com() method.

ics.ics.FindNeoDevices()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.find_devices() method.

ics.ics.FirmwareUpdateRequired()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.firmware_update_required() method.

ics.ics.ForceFirmwareUpdate()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.force_firmware_update() method.

ics.ics.GetActiveVNETChannel()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_active_vnet_channel() method.

ics.ics.GetBackupPowerEnabled()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_backup_power_enabled() method.

ics.ics.GetBackupPowerReady()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_backup_power_ready() method.

ics.ics.GetBusVoltage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_bus_voltage() method.

ics.ics.GetDLLFirmwareInfo()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_dll_firmware_info() method.

ics.ics.GetDLLVersion()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_dll_version() method.

ics.ics.GetDeviceSettings()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_device_settings() method.

ics.ics.GetDeviceStatus()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_device_status() method.

ics.ics.GetErrorMessages()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_error_messages() method.

ics.ics.GetHWFirmwareInfo()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_hw_firmware_info() method.

ics.ics.GetLastAPIError()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_last_api_error() method.

ics.ics.GetMessages()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_messages() method.

ics.ics.GetPerformanceParameters()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_performance_parameters() method.

ics.ics.GetRTC()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_rtc() method.

ics.ics.GetSerialNumber()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_serial_number() method.

ics.ics.GetTimeStampForMsg()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_timestamp_for_msg() method.

ics.ics.ISO15765_DisableNetworks()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.iso15765_disable_networks() method.

ics.ics.ISO15765_EnableNetworks()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.iso15765_enable_networks() method.

ics.ics.ISO15765_ReceiveMessage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.iso15765_receive_message() method.

ics.ics.ISO15765_TransmitMessage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.iso15765_transmit_message() method.

ics.ics.LoadDefaultSettings()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.load_default_settings() method.

ics.ics.OpenNeoDevice()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.open_device() method.

ics.ics.ReadJupiterFirmware()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.read_jupiter_firmware() method.

ics.ics.ReadSDCard()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.read_sdcard() method.

ics.ics.RequestDiskDetails()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_disk_details() method.

ics.ics.RequestDiskFormat()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.disk_format() method.

ics.ics.RequestDiskFormatCancel()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.disk_format_cancel() method.

ics.ics.RequestDiskFormatProgress()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_disk_format_progress() method.

ics.ics.RequestEnterSleepMode()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.request_enter_sleep_mode() method.

ics.ics.ScriptClear()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_clear() method.

ics.ics.ScriptGetFBlockStatus()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_get_fblock_status() method.

ics.ics.ScriptGetScriptStatus()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_get_status() method.

ics.ics.ScriptGetScriptStatusEx()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.get_script_status() method.

ics.ics.ScriptLoad()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_load() method.

ics.ics.ScriptReadAppSignal()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_read_app_signal() method.

ics.ics.ScriptReadRxMessage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_read_rx_message() method.

ics.ics.ScriptReadTxMessage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_read_tx_message() method.

ics.ics.ScriptStart()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_start() method.

ics.ics.ScriptStartFBlock()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_start_fblock() method.

ics.ics.ScriptStop()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_stop() method.

ics.ics.ScriptStopFBlock()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_stop_fblock() method.

ics.ics.ScriptWriteAppSignal()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_write_app_signal() method.

ics.ics.ScriptWriteRxMessage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_write_rx_message() method.

ics.ics.ScriptWriteTxMessage()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.coremini_write_tx_message() method.

ics.ics.SetActiveVNETChannel()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_active_vnet_channel() method.

ics.ics.SetBackupPowerEnabled()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_backup_power_enabled() method.

ics.ics.SetBitRate()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_bit_rate() method.

ics.ics.SetBitRateEx()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_bit_rate_ex() method.

ics.ics.SetContext()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_context() method.

ics.ics.SetDeviceSettings()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_device_settings() method.

ics.ics.SetFDBitRate()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_fd_bit_rate() method.

ics.ics.SetRTC()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_rtc() method.

ics.ics.SetReflashDisplayCallback()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.set_reflash_callback() method.

ics.ics.TxMessages()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.transmit_messages() method.

ics.ics.ValidateHObject()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.validate_hobject() method.

ics.ics.WriteJupiterFirmware()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.write_jupiter_firmware() method.

ics.ics.WriteSDCard()¶: Note

Compatibility Function: Identical to PEP8 compliant ics.ics.write_sdcard() method.

ics.ics.base36enc(serial)¶

Converts a decimal serial number to base36.

Args:

serial (int): serial number.

Raises:

`ics.ISO15765_DisableNetworks`
`ics.ISO15765_EnableNetworks`
`ics.ISO15765_ReceiveMessage`
`ics.ISO15765_TransmitMessage`
`ics.close_device`
`ics.coremini_clear`
`ics.coremini_get_fblock_status`
`ics.coremini_get_status`
`ics.coremini_load`
`ics.coremini_read_app_signal`
`ics.coremini_read_rx_message`
`ics.coremini_read_tx_message`
`ics.coremini_start`
`ics.coremini_start_fblock`
`ics.coremini_stop`
`ics.coremini_stop_fblock`
`ics.coremini_write_app_signal`
`ics.coremini_write_rx_message`
`ics.coremini_write_tx_message`
`ics.create_neovi_radio_message`
`ics.disk_format`
`ics.disk_format_cancel`
`ics.enable_bus_voltage_monitor`
`ics.enable_network_com`
`ics.find_devices`
`ics.firmware_update_required`
`ics.force_firmware_update`
`ics.get_active_vnet_channel`
`ics.get_backup_power_enabled`
`ics.get_backup_power_ready`
`ics.get_bus_voltage`
`ics.get_device_settings`
`ics.get_device_status`
`ics.get_disk_details`
`ics.get_disk_format_progress`
`ics.get_dll_firmware_info`
`ics.get_dll_version`
`ics.get_error_messages`
`ics.get_hw_firmware_info`
`ics.get_last_api_error`
`ics.get_library_path`
`ics.get_messages`
`ics.get_performance_parameters`
`ics.get_rtc`
`ics.get_script_status`
`ics.get_serial_number`
`ics.get_timestamp_for_msg`
`ics.iso15765_disable_networks`
`ics.iso15765_enable_networks`
`ics.iso15765_receive_message`
`ics.iso15765_transmit_message`
`ics.load_default_settings`
`ics.open_device`
`ics.override_library_name`
`ics.read_jupiter_firmware`
`ics.read_sdcard`
`ics.request_enter_sleep_mode`
`ics.set_active_vnet_channel`
`ics.set_backup_power_enabled`
`ics.set_bit_rate`
`ics.set_bit_rate_ex`
`ics.set_context`
`ics.set_device_settings`
`ics.set_fd_bit_rate`
`ics.set_reflash_callback`
`ics.set_rtc`
`ics.transmit_messages`
`ics.validate_hobject`
`ics.write_jupiter_firmware`
`ics.write_sdcard`
`ics.ClosePort`
`ics.EnableBusVoltageMonitor`
`ics.EnableNetworkCom`
`ics.FindNeoDevices`
`ics.FirmwareUpdateRequired`
`ics.ForceFirmwareUpdate`
`ics.GetActiveVNETChannel`
`ics.GetBackupPowerEnabled`
`ics.GetBackupPowerReady`
`ics.GetBusVoltage`
`ics.GetDLLFirmwareInfo`
`ics.GetDLLVersion`
`ics.GetDeviceSettings`
`ics.GetDeviceStatus`
`ics.GetErrorMessages`
`ics.GetHWFirmwareInfo`
`ics.GetLastAPIError`
`ics.GetMessages`
`ics.GetPerformanceParameters`
`ics.GetRTC`
`ics.GetSerialNumber`
`ics.GetTimeStampForMsg`
`ics.LoadDefaultSettings`
`ics.OpenNeoDevice`
`ics.ReadJupiterFirmware`
`ics.ReadSDCard`
`ics.RequestDiskDetails`
`ics.RequestDiskFormat`
`ics.RequestDiskFormatCancel`
`ics.RequestDiskFormatProgress`
`ics.RequestEnterSleepMode`
`ics.ScriptClear`
`ics.ScriptGetFBlockStatus`
`ics.ScriptGetScriptStatus`
`ics.ScriptGetScriptStatusEx`
`ics.ScriptLoad`
`ics.ScriptReadAppSignal`
`ics.ScriptReadRxMessage`
`ics.ScriptReadTxMessage`
`ics.ScriptStart`
`ics.ScriptStartFBlock`
`ics.ScriptStop`
`ics.ScriptStopFBlock`
`ics.ScriptWriteAppSignal`
`ics.ScriptWriteRxMessage`
`ics.ScriptWriteTxMessage`
`ics.SetActiveVNETChannel`
`ics.SetBackupPowerEnabled`
`ics.SetBitRate`
`ics.SetBitRateEx`
`ics.SetContext`
`ics.SetDeviceSettings`
`ics.SetFDBitRate`
`ics.SetRTC`
`ics.SetReflashDisplayCallback`
`ics.TxMessages`
`ics.ValidateHObject`
`ics.WriteJupiterFirmware`
`ics.WriteSDCard`
`ics.base36enc`
`ics.icsneoClosePort`
`ics.icsneoEnableBusVoltageMonitor`
`ics.icsneoEnableNetworkCom`
`ics.icsneoFindNeoDevices`
`ics.icsneoFirmwareUpdateRequired`
`ics.icsneoForceFirmwareUpdate`
`ics.icsneoGetActiveVNETChannel`
`ics.icsneoGetBackupPowerEnabled`
`ics.icsneoGetBackupPowerReady`
`ics.icsneoGetBusVoltage`
`ics.icsneoGetDLLFirmwareInfo`
`ics.icsneoGetDLLVersion`
`ics.icsneoGetDeviceSettings`
`ics.icsneoGetDeviceStatus`
`ics.icsneoGetErrorMessages`
`ics.icsneoGetHWFirmwareInfo`
`ics.icsneoGetLastAPIError`
`ics.icsneoGetMessages`
`ics.icsneoGetPerformanceParameters`
`ics.icsneoGetRTC`
`ics.icsneoGetSerialNumber`
`ics.icsneoGetTimeStampForMsg`
`ics.icsneoISO15765_DisableNetworks`
`ics.icsneoISO15765_EnableNetworks`
`ics.icsneoISO15765_ReceiveMessage`
`ics.icsneoISO15765_TransmitMessage`
`ics.icsneoLoadDefaultSettings`
`ics.icsneoOpenNeoDevice`
`ics.icsneoReadJupiterFirmware`
`ics.icsneoReadSDCard`
`ics.icsneoRequestDiskDetails`
`ics.icsneoRequestDiskFormat`
`ics.icsneoRequestDiskFormatCancel`
`ics.icsneoRequestDiskFormatProgress`
`ics.icsneoRequestEnterSleepMode`
`ics.icsneoScriptClear`
`ics.icsneoScriptGetFBlockStatus`
`ics.icsneoScriptGetScriptStatus`
`ics.icsneoScriptGetScriptStatusEx`
`ics.icsneoScriptLoad`
`ics.icsneoScriptReadAppSignal`
`ics.icsneoScriptReadRxMessage`
`ics.icsneoScriptReadTxMessage`
`ics.icsneoScriptStart`
`ics.icsneoScriptStartFBlock`
`ics.icsneoScriptStop`
`ics.icsneoScriptStopFBlock`
`ics.icsneoScriptWriteAppSignal`
`ics.icsneoScriptWriteRxMessage`
`ics.icsneoScriptWriteTxMessage`
`ics.icsneoSetActiveVNETChannel`
`ics.icsneoSetBackupPowerEnabled`
`ics.icsneoSetBitRate`
`ics.icsneoSetBitRateEx`
`ics.icsneoSetContext`
`ics.icsneoSetDeviceSettings`
`ics.icsneoSetFDBitRate`
`ics.icsneoSetRTC`
`ics.icsneoSetReflashDisplayCallbacks`
`ics.icsneoTxMessages`
`ics.icsneoValidateHObject`
`ics.icsneoWriteJupiterFirmware`
`ics.icsneoWriteSDCard`

python_ics¶

Whats New?¶

v903+ Compatibility Changes¶

ISO 15765-2¶

Settings¶

PyInstaller¶

Other Fixes and Changes¶

Versioning Information¶

v903¶

Older Versions:¶

Installation on Windows¶

Building from source¶

Intrepid icsneo40 Library¶

Installation on Linux¶

Fedora Dependencies (FC28)¶

Debian/Ubuntu Dependencies¶

Others (Required dependencies)¶

Installation¶

Intrepid libicsneoapi.so Library¶

Getting Started¶

Examples¶

Opening a device¶

Transmitting and Receiving a CAN message¶

ISO 15765-2 Example¶

Missing an example?¶

Module Documentation¶

Module Functions¶

Module Structures¶

Module Variables¶