PEDDevice object
Name | Description |
|---|---|
|
|
PED object that represents the terminal. |
Getter
Name | Description |
|---|---|
|
|
Retrieves information from the PED. |
Returned Parameters
| Name | Type | Description |
|---|---|---|
id |
Variant | Unique ID of the terminal. |
brand |
Variant | Brand of the terminal, i.e. Verifone. |
type |
Variant | Type of the terminal. |
snr |
Variant | Serial number of the terminal. |
hw |
Variant | Terminal hardware version. |
os |
Variant | Terminal Operating System. |
api |
Variant | Terminal firmware version |
Method
| Name | Description |
|---|---|
RefreshPed |
Updates the terminal information. Triggers a PED state callback from which you can query the state using GetDeviceState. |
Parameters
Name | Type | Required | Description |
|---|---|---|---|
|
|
Int |
|
Number of times to retry refreshing the PED state. If you have multiple POS systems connected to a single PED, there may be an active transaction on the device which would block the request. Set this to a high number to avoid blocking. |
Callback
| Name | Description |
|---|---|
PedStateChange |
Callback that returns the current PED state. |
Getter
Name | Description |
|---|---|
|
|
Used on PedStateChange to return the current PED state. |
PED States
| State | Description |
|---|---|
ped_state_undetected | Incorrect IP, cannot detect the PED. This is a final state. |
ped_state_detected | PED detected, correct serial/IP address. |
ped_state_identified | Valid PED. |
ped_state_registered | PED is registered, final result on RegisterPED. |
ped_state_config_synced | PED is has synchronized its configuration. |
ped_state_wait_reboot_ready | PED is rebooting. |
ped_state_wait_ready_for_transaction | PED must complete another process before it is ready to create a transaction. |
ped_state_not_ready | PED is busy. This is a final state. |
ped_state_ready_for_transaction | PED is ready for transaction. |
ped_state_tender | PED is busy with a tender. |