MQTT Commands

The Smartreader Embedded app supports command processing over MQTT. In order to avoid command loops when the app or the reader is restarted, the command_id received is always compared to the last command received and ignored in case they are the same.

Supported Commands

The Smartreader currently supports the following MQTT commands:

• start – begin the inventory operation.

• stop – halt the inventory operation.

• reboot – reboot the reader.

• mode – configure reader settings.

• get-gpo – read the current state of the reader's GPO pins.

• set-gpo – set the state of one or more GPO pins.

• status – request compact reader status information.

• status-detailed – request a more exhaustive status report.

• impinj_iot_device_interface – proxy a request to the Impinj IoT Device Interface API.

• retrieve-settings – fetch current Smartreader application settings.

• apply-settings – apply new configuration settings.

• upgrade – trigger firmware upgrade from a specified URL.

• rshell – execute an RShell command on the reader.

• Task commands for stored tasks:

  • create

  • update

  • get

  • delete

Start Command

Description: This command starts the inventory operation (preset)

Topic: Topic for Control Command

Payload:

{
    "command": "start",
    "command_id": "1234",
    "payload": {}
}

Stop Command

Description: This command stops the inventory operation (preset)

Topic: Topic for Control Command

Payload:

{
    "command": "stop",
    "command_id": "1234",
    "payload": {}
}

Reboot Command

Description: This command reboots the reader

Topic: Topic for Control Command

Payload:

{
    "command": "reboot",
    "command_id": "1234",
    "payload": {}
}

Mode Command

Description: This command configures the reader settings

Topic: Topic for Control Command

Payload:

{
  "command": "mode",
  "command_id": "12334",
  "payload": {
    "type": "INVENTORY",
    "antennas": [
      1,
      2
    ],
    "antennaZone": "TOPSHELF",
    "antennaZoneState": "enabled",
    "transmitPower": 17.25,
    "groupIntervalInMs": 500,
    "rfMode": "MaxThroughput",
    "searchMode": "single-target",
    "session": "1",
    "tagPopulation" : 32,
    "startTrigger": {
      "startTriggerType": "1"
    },
    "stopTrigger": {
      "stopTriggerType": "1",
      "stopTriggerDuration": "1000"
    },
    "filter": {
      "value": "E280",
      "match": "prefix",
      "operation": "include",
      "status": "enabled"
    },
    "filterIncludeEpcHeaderList": {
      "value": "E280,3031",
      "status": "enabled"
    },
    "rssiFilter": {
      "threshold": -72
    }
  }
}

GPO GET Command

Description: This command gets the current status of the reader´s GPOs

Topic: Topic for Control Command

// Command example
{
  "command": "get-gpo",
  "command_id": "123456",
  "payload": {}
}

Result topic: Topic for Control Command Response Publishing

// Result example
{
  "command": "get-gpo",
  "command_id": "123456",
  "payload": {},
  "response": "success",
  "message": {
    "gpoConfigurations": [
      {
        "gpo": 1,
        "state": "high"
      },
      {
        "gpo": 2,
        "state": "low"
      },
      {
        "gpo": 3,
        "state": "low"
      }
    ]
  }
}

GPO SET Command

Description: This command sets reader´s GPOs. Note that it is not needed to include all 3 GPOs on the payload.

Topic: Topic for Control Command

// Set GPO example control command
{
    "command": "set-gpo",
    "command_id": "123456",
    "payload": {
        "gpoConfigurations": [
        {
          "gpo": 1,
          "state": "high"
        },
        {
          "gpo": 2,
          "state": "low"
        },
        {
          "gpo": 3,
          "state": "low"
        }
      ]
    }
}

Result topic: Topic for Control Command Response Publishing

// Example response to a GPO Set control command
{
  "command": "set-gpo",
  "command_id": "123456",
  "payload": {
    "gpoConfigurations": [
      {
        "gpo": 1,
        "state": "high"
      },
      {
        "gpo": 2,
        "state": "low"
      },
      {
        "gpo": 3,
        "state": "low"
      }
    ]
  },
  "response": "success",
  "message": ""
}

Status Command

Description: This command gets the status of the reader. There are two variations of this command. The default one, "status", returns a reduced and fast payload. A detailed one, "status-detailed" that returns a longer and detailed payload (but slower).

Topic: Topic for Management Command

Payload:

// Command to receive reduced status payload
{
    "command": "status",
    "command_id": "1234",
    "payload": {}
}

// Command to receive complete status payload (slower)
{
    "command": "status-detailed",
    "command_id": "1234",
    "payload": {}
}

Status Event

Description: This event contains compact status information from the reader

Topic: Topic for Management Events

Payload:

{
  "eventType": "status",
  "component": "Smartreader",
  "readerName": "r700test",
  "serialNumber": "37020391401",
  "timestamp": "2023-09-14T07:54:30.0493388Z",
  "macAddress": "00:16:25:14:02:98",
  "antenna1Enabled": "False",
  "antenna1Zone": "Access",
  "antenna1TxPower": "25",
  "antenna1RxSensitivity": "-92",
  "antenna2Enabled": "True",
  "antenna2Zone": "Access",
  "antenna2TxPower": "25",
  "antenna2RxSensitivity": "-92",
  "antenna3Enabled": "True",
  "antenna3Zone": "Cabinet",
  "antenna3TxPower": "25",
  "antenna3RxSensitivity": "-92",
  "antenna4Enabled": "False",
  "antenna4Zone": "Cabinet",
  "antenna4TxPower": "18",
  "antenna4RxSensitivity": "-60",
  "ipAddresses": "192.168.1.130;fe80::839f:1fbb:189d:c775;",
  "status": "Armed",
  "activePreset": "Smartreader",
  "manufacturer": "Impinj",
  "productHla": "103001-01B",
  "productModel": "R700",
  "productSku": "IPJ-R700-241",
  "productDescription": "Impinj R700 RAIN RFID Reader",
  "isAntennaHubEnabled": "False",
  "readerOperatingRegion": "ETSI 302-208 v1.4.1"
}

Status Detailed Event

Description: This event contains detailed status information from the reader

Topic: Topic for Management Events

Payload:

{
    "eventType": "status",
    "component": "Smartreader",
    "readerName": "r700test",
    "timestamp": "2023-09-13T13:50:12.5022132Z",
    "macAddress": "00:16:25:14:02:98",
    "antenna1Enabled": "False",
    "antenna1Zone": "Access",
    "antenna1TxPower": "25",
    "antenna1RxSensitivity": "-92",
    "antenna2Enabled": "True",
    "antenna2Zone": "Access",
    "antenna2TxPower": "25",
    "antenna2RxSensitivity": "-92",
    "antenna3Enabled": "True",
    "antenna3Zone": "Cabinet",
    "antenna3TxPower": "25",
    "antenna3RxSensitivity": "-92",
    "antenna4Enabled": "False",
    "antenna4Zone": "Cabinet",
    "antenna4TxPower": "18",
    "antenna4RxSensitivity": "-60",
    "ipAddresses": "192.168.1.130;fe80::a225:1562:3b85:2d6a;",
    "status": "Armed",
    "activePreset": "Smartreader",
    "manufacturer": "Impinj",
    "productHla": "103001-01B",
    "productModel": "R700",
    "productSku": "IPJ-R700-241",
    "productDescription": "Impinj R700 RAIN RFID Reader",
    "isAntennaHubEnabled": "False",
    "readerOperatingRegion": "ETSI 302-208 v1.4.1",
    "batteryCondition": "ok",
    "gpi1": "low",
    "gpi2": "low",
    "LastStatisticReset": "2168",
    "ReaderOperationalStatus": "enabled",
    "ReaderAdministrativeStatus": "enabled",
    "Antenna1AdministrativeStatus": "enabled",
    "Antenna2AdministrativeStatus": "enabled",
    "Antenna3AdministrativeStatus": "enabled",
    "Antenna4AdministrativeStatus": "enabled",
    "Antenna1OperationalStatus": "unknown",
    "Antenna2OperationalStatus": "enabled",
    "Antenna3OperationalStatus": "enabled",
    "Antenna4OperationalStatus": "disabled",
    "Antenna1LastPowerLevel": "1500",
    "Antenna2LastPowerLevel": "1600",
    "Antenna3LastPowerLevel": "1800",
    "Antenna4LastPowerLevel": "0",
    "Antenna1LastNoiseLevel": "0",
    "Antenna2LastNoiseLevel": "0",
    "Antenna3LastNoiseLevel": "0",
    "Antenna4LastNoiseLevel": "0",
    "Antenna1EnergizedTime": "153106",
    "Antenna2EnergizedTime": "133777",
    "Antenna3EnergizedTime": "130515",
    "Antenna4EnergizedTime": "0",
    "Antenna1UniqueInventoryCount": "6",
    "Antenna2UniqueInventoryCount": "1",
    "Antenna3UniqueInventoryCount": "0",
    "Antenna4UniqueInventoryCount": "0",
    "Antenna1TotalInventoryCount": "8655",
    "Antenna2TotalInventoryCount": "808",
    "Antenna3TotalInventoryCount": "0",
    "Antenna4TotalInventoryCount": "0",
    "Antenna1FailedInventoryCount": "0",
    "Antenna2FailedInventoryCount": "0",
    "Antenna3FailedInventoryCount": "0",
    "Antenna4FailedInventoryCount": "0",
    "Antenna1ReadCount": "0",
    "Antenna2ReadCount": "0",
    "Antenna3ReadCount": "0",
    "Antenna4ReadCount": "0",
    "Antenna1FailedReadCount": "0",
    "Antenna2FailedReadCount": "0",
    "Antenna3FailedReadCount": "0",
    "Antenna4FailedReadCount": "0",
    "Antenna1WriteCount": "0",
    "Antenna2WriteCount": "0",
    "Antenna3WriteCount": "0",
    "Antenna4WriteCount": "0",
    "Antenna1FailedWriteCount": "0",
    "Antenna2FailedWriteCount": "0",
    "Antenna3FailedWriteCount": "0",
    "Antenna4FailedWriteCount": "0",
    "Antenna1LockCount": "0",
    "Antenna2LockCount": "0",
    "Antenna3LockCount": "0",
    "Antenna4LockCount": "0",
    "Antenna1FailedLockCount": "0",
    "Antenna2FailedLockCount": "0",
    "Antenna3FailedLockCount": "0",
    "Antenna4FailedLockCount": "0",
    "Antenna1KillCount": "0",
    "Antenna2KillCount": "0",
    "Antenna3KillCount": "0",
    "Antenna4KillCount": "0",
    "Antenna1FailedKillCount": "0",
    "Antenna2FailedKillCount": "0",
    "Antenna3FailedKillCount": "0",
    "Antenna4FailedKillCount": "0",
    "Antenna1EraseCount": "0",
    "Antenna2EraseCount": "0",
    "Antenna3EraseCount": "0",
    "Antenna4EraseCount": "0",
    "Antenna1FailedEraseCount": "0",
    "Antenna2FailedEraseCount": "0",
    "Antenna3FailedEraseCount": "0",
    "Antenna4FailedEraseCount": "0",
    "GPI1TransitionCount": "0",
    "GPI2TransitionCount": "0",
    "GPO1AdminStatus": "enabled",
    "GPO2AdminStatus": "enabled",
    "GPO3AdminStatus": "enabled",
    "GPO1OperationStatus": "low",
    "GPO2OperationStatus": "low",
    "GPO3OperationStatus": "low",
    "GPI1AdminStatus": "enabled",
    "GPI2AdminStatus": "enabled",
    "GPI1OperationStatus": "low",
    "GPI2OperationStatus": "low",
    "BootEnvVersion": "2",
    "HLAVersion": "103001-01B",
    "HardwareVersion": "103250-01F",
    "IntHardwareVersion": "103250-01F",
    "ModelName": "R700",
    "SerialNumber": "37020391401",
    "IntSerialNumber": "370-20-39-1401",
    "MACAddress": "00:16:25:14:02:98",
    "FeaturesValid": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32",
    "BIOSVersion": "0.20.20.10",
    "PTN": "001.052",
    "UptimeSeconds": "2226",
    "BootStatus": "0",
    "BootReason": "Processor / Reboot",
    "PowerFailTime": "0",
    "ActivePowerSource": "poe+",
    "TotalMemory": "1050263552",
    "FreeMemory": "677355520",
    "UsedMemory": "148713472",
    "CPUUtilization": "13",
    "TotalConfigurationStorageSpace": "251567104",
    "FreeConfigurationStorageSpace": "193781760",
    "TotalApplicationStorageSpace": "125783040",
    "FreeApplicationStorageSpace": "3704832",
    "ServiceEnabled": "True",
    "NegotiationTimeout": "30000",
    "PoePlusRequired": "False",
    "NegotiationState": "PowerAllocatedByPhysicalLayer",
    "RequiredPowerAvailable": "True",
    "RequestedPower": "25500",
    "AllocatedPower": "25500",
    "PowerSource": "auto (PoE+)",
    "PrimaryImageType": "10",
    "PrimaryImageState": "Active",
    "PrimaryImageSystemVersion": "8.1.6.240",
    "PrimaryImageConfigVersion": "255.255.255.255",
    "PrimaryImageCustomAppVersion": "4.0.0.29",
    "SecondaryImageType": "10",
    "SecondaryImageState": "Active",
    "SecondaryImageSystemVersion": "8.1.6.240",
    "SecondaryImageConfigVersion": "255.255.255.255"
}

Impinj IoT Device Interface Command

Description: This command interfaces with the Impinj IoT Device Interface over MQTT

See Impinj IoT Device Interface payload examples for additional request formats.

Topic: Topic for Management Command

Payload:

{
  "command": "impinj_iot_device_interface",
  "command_id": "1234-iot",
  "payload": {
    "impinjIotApiEndpoint" : "/status",
    "impinjIotApiVerb" : "GET",
    "impinjIotApiRequest" : {}
  }
}

Retrieve Settings Command

Description: This command queries the current app settings

Topic: Topic for Management Command

Payload:

{
    "command": "retrieve-settings",
    "command_id": "1234-iot",
    "payload": {}
}

Apply Settings Command

Description: This command applies a new configuration to the app

Topic: Topic for Management Command

Payload:

{
    "command": "apply-settings",
    "command_id": "1234-iot",
    "payload": { $json_settings_data }
}

Upgrade Command

Description: This command trigger the firmware upgrade process

Topic: Topic for Management Command

Payload:

{
        "command": "upgrade",
        "command_id": "1234",
        "payload": {
                "url" : "http://$server_ip_address/r700_octane-8.1.0.240.upgx",
                "timeoutInMinutes": 4,
                "maxRetries": 3
         }
}

RShell Command

Description: Executes an RShell command on the reader. The command string is provided in payload.data and the response returns the command output split into lines.

Topic: Topic for Management Command

Payload:

{
    "command": "rshell",
    "command_id": "1234",
    "payload": {
        "data": "show version"
    }
}

Example response:

{
    "command": "rshell",
    "command_id": "1234",
    "payload": {
        "data": "show version"
    },
    "response": "success",
    "message": [
        "Impinj RShell v1",
        "OK"
    ]
}

Task Commands

Task management operations can also be performed via MQTT.

Topic format: smartreader/{deviceId}/api/v1/tasks/{action}

Where {action} is one of:

• create

• update

• get

• delete

The logicalPointId, taskId and documentId values are provided in the JSON payload as needed by each action. The logicalPointId can be omitted to query tasks for all logical points.

For the get action:

• Without taskId, the response contains tasks.

• With taskId and "progress": true, the response contains progress for the specified task.

• With taskId but no documentId, the response contains all documents for the specified task.

• With both taskId and documentId, the response contains the specified document.