Skip to content

Latest commit

 

History

History

PITreaderTool

README.md

PITreaderTool

PITreaderTool is an example application for the REST API of PITreader devices.

Getting Started

Access to the REST API is secured by API tokens (see User → Device user in the web interface of the device and the API user manual).

The client (PITreaderTool) can ensure that communication is established with the correct PITreader device by specifying the certificate thumbprint for the connection (see Configuration -> Certificate in the web interface of the device).

Parameters

The tool accepts the following general parameters for the connection to a PITreader device:

  • -h, --host <host> IP address or hostname of PITreader device [optional, default: 192.168.0.12]
  • -p, --port <port> HTTPS port number of PITreader device [optional, default: 443]
  • --accept-all If set, certificates of the PITreader device are not validated [default: false]
  • --thumbprint <thumbprint> Sha2 thumbprint in hexadecimal format of the certificate of the PITreader device
  • <api token> API token for the connection to the device

Commands

Following the general parameters one of the commands can be passed to the tool for execution:

  • xpndr Transponder
  • udc User Data Configuration
  • bl Blocklist
  • coding Basic Coding
  • monitor Monitor for status changes
  • firmware Update firmware on device

Transponder

The transponder command (xpndr) has three sub-commands:

  • export <path to json> Export content of a transponder to file
  • write <path to json> Write data from file (see export) to transponders
  • log <path to csv> Log ids (order number, serial number and security id) of transponders

<path to json> is a realtive or absolute path to a file to store or read the contents of the transponder.

<path to csv> is a realtive or absolute path to a file to store data about all transpodners read by the PITreader.

The write command has two additional options:

  • --update-udc To update the user data configuration of the device before writing data onto the transponder
  • --loop To run forever (exit with Ctrl + C) and update all transponders detected by the PITreader device

The combination of the export and write command can be used to clone transponders.

Example

Example to write the data of a transponder to the file my_transponder.json
The PITreader has a certificate with SHA2 thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC and API token hJgwmy/5gyl84lKSynGIVQ==.

PITreaderTool.exe --thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC hJgwmy/5gyl84lKSynGIVQ== xpndr export my_transponder.json

User Data Configuration

The user data configuration command (udc) has two sub-commands:

  • export <path to json> Export user data configuration from a device to a json file
  • import <path to json> Import user data confguration from a json file to a device

<path to json> is a realtive of absolute path to a file to store or read the user data configuration.

Example

Example to write the data of a transponder to the file my_transponder.json
The PITreader has a certificate with SHA2 thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC and API token hJgwmy/5gyl84lKSynGIVQ==.

PITreaderTool.exe --thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC hJgwmy/5gyl84lKSynGIVQ== udc export my_udc.json

Blocklist

The blocklist command (bl) has one sub-command:

  • import <path to csv> Import blocklist from a csv file into a device

<path to csv> is a realtive of absolute path to an existing csv file with two fields/columns: Security ID and comment.
The first line of the CSV file is ignored.

Coding

The coding command (coding) has two sub-commands:

  • set <coding identifier> [<coding comment>] Set basic coding
  • delete Delete basic coding

The set command has the following arguments:

  • <coding identifier> is the identifier that should be used as basic coding
  • <coding comment> is an optional argument to set a comment for the coding identifier

Example

Example to set the basic coding to "SecretC0ding" with the comment "DE Plant 01-A"
The PITreader has a certificate with SHA2 thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC and API token hJgwmy/5gyl84lKSynGIVQ==.

PITreaderTool.exe --thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC hJgwmy/5gyl84lKSynGIVQ== coding set SecretC0ding "DE Plant 01-A"

Monitor

The monitor command (monitor) is an example for monitoring a PITreader device for changes and has no sub-commands or arguments.

It just outputs detected changes to the command line.

Example

The PITreader has a certificate with SHA2 thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC and API token hJgwmy/5gyl84lKSynGIVQ==.
Example for the monitor command:

PITreaderTool.exe --thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC hJgwmy/5gyl84lKSynGIVQ== monitor

Firmware

The firmware command (firmware) has two sub-commands:

  • version Reads the current firmware version from the device
  • update [--force] <path to fwu> Update firmware on device

The update command has the following arguments:

  • --force if set, the update is attempted although the device reports to also have the same or a newer version installed
  • <path to fwu> Path to firmware update package (*.fwu)

Example

The PITreader has a certificate with SHA2 thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC and API token hJgwmy/5gyl84lKSynGIVQ==.
Example for the firmware update command:

PITreaderTool.exe --thumbprint C44E954C64B50AA2AF7CAC9F1108CEDF59FFF7D520DE27223AF92A5976F7E5FC hJgwmy/5gyl84lKSynGIVQ== firmware update ..\PITreader_update_2-1-0.fwu