All pages
Powered by GitBook
1 of 6

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

0x1Fnn - Device Control

Device Control

This section of the DynaFamily Programmer's Manual lists available Device Control commands to initiate various functions in the device.

Applies to: All Dyna Family products

Information in this group

Section

Information

The host uses this command to reset the device.

0x1F01 - Reset Device

The host uses this command to reset the device.

1

The host constructs the command request for Command 0x1F01 - Reset Device in the format below.

2

The host sends the command request to the device.

3

Device responds

The device sends a response in the format below to the host.

4

Device resets

The device starts an automatic reset within 500ms.

Tag
Len
Value / Description
Typ
Req
Default

Beginning of any wrappers, at minimum including Request Message

Tag
Len
Value / Description
Typ
Req
Default

Beginning of any wrappers, at minimum including Response Message

Construct the command request

Send the command request

Example (Hex)
AA 00 81 04 01 12 1F 01 84 02 1F 01
Response Example (Hex)
AA 00 81 04 82 12 1F 01 82 04 00 00 00 00

Reset Device - Request Data for Command 0x1F01

Reset Device - Response Data for Command 0x1F01

Request Example - Command 0x1F01

Response Example - Command 0x1F01

The host uses this command to specify which notifications the device should send on each of its available interfaces.

0x1F03 - Extend Session (Session Managements Only)

The host can use this command to extend a session for open protocol interfaces, such as the WLAN interface, which require session management to meet PCI requirements.

0x1F04 - Terminate Bluetooth LE Connection

The host can use this command to terminate a Bluetooth LE connection.

0x1F05 - Erase All Bluetooth LE Bonds

The host can use this command to erase all Bluetooth® LE bonds.

Need More Help

Need Help?

For additional support, please contact MagTek Support:

Technical Support:

  • 📧 Email: support@magtek.com

  • 📞 Phone: 1-562-546-6800 (US)

  • 🕐 Hours: Monday-Friday, 5:30 AM - 5:00 PM PST

Online Resources:

  • 🌐 Support Portal: developer.magtek.com

Documentation Feedback:

Help us improve this documentation!

0x1F01 - Reset Device
0x1F02 - et Notification Subscriptions

1F01 = Reset Device - Command 0x1F01

81

01

Power Off Option

  • 0x00 = Reset

  • 0x01 = Power Off

Power off only works while a device is running on its battery. If a device is powered off while it is powered by USB, the device will immediately turn back on.

B

O

0x00

End of any wrappers, at minimum including Request Message

1F01 = Reset Device - Command 0x1F01

No parameters.

End of any wrappers, at minimum including Response Message

feedback@magtek.com

0x1F05 - Erase All Bluetooth LE Bonds (Bluetooth LE Only)

The host can use this command to erase all Bluetooth® LE bonds. The user should then forget the device and re-pair the device on any host that it was previously paired with if that host needs to communicate with the device again.

The sequence of events is as follows:

1

Construct the command request

The host constructs the command request for Command 0x1F01 - Reset Device in the format below.

2

Send the command

The host sends the command request to the device.

3

The device sends a response in the format below to the host.

4

The device erases all Bluetooth® LE bonds within around 500ms.

Tag
Len
Value / Description
Typ
Req
Default
Tag
Len
Value / Description
Typ
Req
Default

0x1F04 - Terminate Bluetooth LE Connection (Bluetooth LE Only)

The host can use this command to terminate a Bluetooth® LE connection. The host may also be able to terminate a Bluetooth® LE connection directly without using this command.

The sequence of events is as follows:

1

The host constructs the command request for Device in the format below.

2

The host sends the command request to the device.

3

The device sends a response in the format below to the host.

4

The device terminates the Bluetooth® LE connection within around 500 ms.

Tag
Len
Value / Description
Typ
Req
Default
Tag
Len
Value / Description
Typ
Req
Default

0x1F03 - Extend Session (Session Management Only)

The host can use this command to extend a session for open protocol interfaces, such as the WLAN interface, which require session management to meet PCI requirements.

The sequence of events is as follows:

1

Session start

The host establishes a session with the device on a given interface. For the WLAN interface, a session starts when the host establishes a TLS websocket connection with the device.

2

Device session timer

The device starts a countdown timer for a 30 minute session timeout period.

3

Five minutes before the session timeout period expires, the device starts repeatedly (every minute) sending Device Information Update - Notification 0x1001 to report Session Management / Session Expiring Soon.

4

The host may extend the session multiple times, until the device automatically resets to meet PCI’s 24 hour self-test requirement, by sending any command request using the same interface before the timeout occurs. Upon receiving the command, the device resets the session countdown timer to 30 minutes. This helps prevent the session from expiring while the host is actively using the device, including when the device is performing a transaction.

If the host wants to extend the session but does not need to send another command, it may follow these steps at any time during the session:

1

The host constructs the command request in the format below.

2
5

When the session expires, the device closes the websocket connection.

For the WLAN interface, if the device is configured to allow connections to more than one client at the same time with Maximum Client Connections - Property 1.2.2.1.1.A and more than one client is connected, then the following applies. There is always only a single session and it applies to all clients. There is not a separate session for each client. The session starts when the first client connects. Only one client needs to send a command on its connection to extend the session. The other clients do not need to send any commands. When the session expires, all clients will be disconnected.

Tag
Len
Value / Description
Typ
Req
Default
Tag
Len
Value / Description
Typ
Req
Default

1F05 = Erase All Bluetooth® LE Bonds - Command 0x1F05

No parameters.

End of any wrappers, at minimum including Request Message

1F05 = Erase All Bluetooth LE Bonds - Command 0x1F05

No parameters.

End of any wrappers, at minimum including Response Message

Beginning of any wrappers, at minimum including Request Message

Beginning of any wrappers, at minimum including Response Message

Device responds

Device erases bonds

Erase All Bluetooth® LE Bonds - Request Data for Command 0x1F05

Erase All Bluetooth LE Bonds - Response Data for Command 0x1F05

Request Example - Command 0x1F05

Response Example - Command 0x1F05

1F04 = Terminate Bluetooth® LE Connection - Command 0x1F04

No parameters.

End of any wrappers, at minimum including Request Message

1F04 = Terminate Bluetooth® LE Connection - Command 0x1F04

No parameters.

End of any wrappers, at minimum including Response Message

Beginning of any wrappers, at minimum including Request Message

Beginning of any wrappers, at minimum including Response Message

Request Data for Command 0x1F04 – Terminate Bluetooth® LE Connection

Response Data for Terminate Bluetooth® LE Connection - Command 0x1F04

Request Example - Command 0x1F04

Response Example - Command 0x1F04

Send command request

The host sends the command request to the device.

3

Device responds

The device sends a response in the format below to the host.

4

Timer reset

The device resets the session countdown timer to 30 minutes.

1F03 = Extend Session (Session Management Only) - Command 0x1F03

End of any wrappers, at minimum including Request Message

1F03 = Extend Session (Session Management Only) - Command 0x1F03

No parameters.

End of any wrappers, at minimum including Response Message

Beginning of any wrappers, at minimum including Request Message

Beginning of any wrappers, at minimum including Response Message

Session expiring notifications

Host may extend the session

Construct command request

Session expiration

Extend Session (Session Management Only) - Request Data for Command 0x1F03

Extend Session (Session Management Only) - Response Data for Command 0x1F03

Request Example - Command 0x1F03

Response Example - Command 0x1F03

Example (Hex)
AA 00 81 04 01 55 1F 05 84 02 1F 05
Example (Hex)
AA 00 81 04 82 55 1F 05 82 04 00 00 00 00 84 02 1F 05
Example (Hex)
AA 00 81 04 01 55 1F 04 84 02 1F 04
Example (Hex)
AA 00 81 04 82 55 1F 04 82 04 00 00 00 00 84 02 1F 04
Request (Hex)
AA00 810401551F03 8402 1F03
Response (Hex)
AA00 810482551F03 820400000000 8402 1F03

0x1F02 - Set Notification Subscriptions

The host uses this command to specify which notifications the device should send on each of its available interfaces. By default, the device sends notifications to the host on all interfaces.

1

Sequence of events

The sequence of events is as follows:

  1. The host constructs the command request in the format below.

  2. The host sends the command request to the device.

  3. The device sends a response in the format below to the host.

  4. The device immediately begins routing notifications per the request.

  5. If the device restarts or loses power, the device resets its notification subscriptions to defaults, and the host must call this command again to change them.

Tag
Len
Value / Description
Typ
Req
Default
Tag
Len
Value / Description
Typ
Req
Default

1F02 = Set Notification Subscriptions - Command 0x1F02

81

01

Subscribe

  • 0x00 = Unsubscribe

  • 0x01 = Subscribe

B

O

0x01

82

01

Notifications Affected

  • 0x00 = Only subscribe or unsubscribe to notification messages in the Notification Message ID List parameter

  • 0x01 = Subscribe or unsubscribe to all notifications

B

O

0x01

83

var

Notification Message ID List List of two-byte Notification Message IDs (MSB first) from section 7 Notifications to be subscribed / unsubscribed by this command. For example, to subscribe to Notification 0x0105 - Transaction Operation Complete on the interface being used to send this command, the host would include 0x0105 as two bytes in the list. The device ignores any Notification Message IDs in the list that do not exist.

B

O

Null

A4

var

Interfaces

List of interfaces this command should change the subscription settings for. If the host does not specify any interfaces here, the command applies only to the interface the host is using to send the command.

B

)

Null

/81

00

Apply changes to the USB interface

O

/82

00

Apply changes to the WLAN interface

O

/83

00

Apply changes to the Bluetooth® LE interface

O

/84

00

Apply changes to the UART interface

O

End of any wrappers, at minimum including Request Message

1F02 = Set Notification Subscriptions - Command 0x1F02

No parameters.

End of any wrappers, at minimum including Response Message

Beginning of any wrappers, at minimum including Request Message

Beginning of any wrappers, at minimum including Response Message

Set Notification Subscriptions - Request Data for Command 0x1F02

Set Notification Subscriptions - Response Data for Command 0x1F02

Request Example - Command 0x1F02

Response Example - Command 0x1F02

Example (Hex)
AA00 810401551F02 8402 1F02
Example (Hex)
AA00 810482551F02 820400000000 8402 1F02