📜 Table of Contents

• Introduction
• Xcom-API-Class
  • Create and Delete an Object
  • Class-Attributes
  • Information-Methods
    • get_source_address
    • get_destination_address
    • is_crc_check_active
    • get_object_counter
    • get_prog_name
    • get_prog_version
  • Public-Class-Methods
    • get_read_frame
    • get_read_frame_ext
    • get_write_frame
    • get_write_frame_ext
    • get_data_from_frame
    • get_data_from_frame_ext
    • get_bin_from_frame_flags
    • get_text_from_frame_flags
    • get_text_from_error_id
• Hardware Setup
  • Hardware Information
  • Xcom-232i-Setup
  • Raspberry Pi Setup
    • Copy Image to a SD-Card
    • Create your own Image
• Test-Program
  • Run Test-Program
  • Xcom-Test-Loop-Program
  • Xcom-Test-Program

Public-Class-Methods

The Public-Class-Methods are used to encode and decode byte-frames. There are also Private-Class-Methods of the API, but they are only used inside the API for internal instructions and they are not available for the user. So the Private-Class-Methods will not be further described. The Public-Class-Methods are:

• get_read_frame
• get_read_frame_ext
• get_write_frame
• get_write_frame_ext
• get_data_from_frame
• get_data_from_frame_ext
• get_bin_from_frame_flags
• get_text_from_frame_flags
• get_text_from_error_id

There are Methods either to encode 'read' or 'write' byte-frames and there are Methods to decode byte-frames. Furthermore there are also Methods to decode frame-flags and error-id as well.

The non extended methods, these are methods without an '_ext' expression inside the method names, can only be used with a known Object_ID, which are listed in the section Class-Attributes. These known Object_IDs contains info and parameter numbers, which are often used. So you can easily encode and decode byte-frames without the need to know of the background informations of the byte-frame structure.

If you want to encode and decode byte-frames with other Object-IDs, you must used the extended methods. To use these Methods, you need background informations of the byte-frame structure, wich are well explained in the technical documentation of the Xcom-232i. Otherwise the Xtender-System will possibly not understand the byte-frame and will send you an error.

Note: The link to the documentation of the Xcom-232i can you find under the section: Hardware Information.

Hochschule Anhalt | Anhalt University of Applied Sciences | Department 6 EMW
Xcom-API

Tobias Müller, M. Eng.
📧 Tobias.Mueller@HS-Anhalt.de

© es-lab.de, 31.10.2017