Working With Impinj® ItemSense™ Management Console

Introduction

The ItemSense Management Console (IMC) is a graphical user interface (GUI) for ItemSense. The IMC runs on the ItemSense server and is accessed with a web browser.

The IMC allows you to define and configure the RAIN RFID readers; define zone maps, recipes, and jobs, which are required for an ItemSense data collection session; view the data results from a data collection session; monitor the health of the readers.

After ItemSense is installed, the user must complete an initial setup via the IMC. ItemSense is not usable from any interface until the initial setup has been completed.

Table of Contents

Provision ItemSense for the first time

When you run the IMC for the first time, a wizard walks you through the necessary steps to configure and confirm an ItemSense installation. After the wizard completes, ItemSense is ready to use.

Check Prerequisites

The following browsers are currently supported:

  • Google Chrome Latest
  • Microsoft Edge Latest
  • Mozilla Firefox Latest
  • Apple Safari 9.1.2 (ships with El Capitan)

The following steps must be completed before provisioning ItemSense:

  • Install an ItemSense server
  • Deploy RAIN RFID gateways
  • Configure the network

Connect to ItemSense

To connect to ItemSense, type http://<server IP>:3010 into the address line of a web browser and press Enter.

After you connect to ItemSense, the following page appears. Enter either your ItemSense UUID or your ItemSense Instance ID and select your regulatory region from the drop-down menu. If you do not know your UUID or your Instance ID, contact support@impinj.com.

Click the SUBMIT button to continue.

Initial page after connecting to server displays Instance ID field and Regulatory Region field.

Log in to ItemSense

It will take a few seconds for your ItemSense instance to register itself. Once this is complete, you can log in to ItemSense. Enter the username and password of the ItemSense server administrator. By default, the ItemSense server administrator has a username of admin with the password of admindefault. Click the LOG IN button.

The log in screen, with Username and Password fields, and a LOG IN button below.

Configure ItemSense

Once the user is logged in, the IMC Wizard takes the user through a six-step process to set up ItemSense. The IMC wizard executes only on the first login.

Step 1: Change the administrator password

The first step is to change the administrator password. This step is optional, but recommended.

Enter the new administrator password into the New Password and the Confirm New Password fields. Click the NEXT STEP button to continue to the next step.

Step 1: change password. Text, change administrator password, please update your administrator password. Field, New password. Field, Confirm new password field. Button, Submit. Button, Next Step.

Step 2: Create one or more facilities

The Facilities page appears. ItemSense comes with the facility default, but the user is required to create another. Click the CREATE A FACILITY button.

Enter a facility name in the New facility name field. If you want this facility to be the default, put a check mark in the Set as current facility check box. Click the CREATE NEW FACILITY button. A spinner page may briefly appear with the text Creating new facility.

Step 2: Page, Create facilities. Text, Please create at least one facility before continuing. Button, Create a facility. Field, New facility name. Check box, Set as current facility. Button, cancel. Button, create new facility.

After the facility has been created within ItemSense, the Facilities page will reappear with the text, You have 1 valid facility defined. If you want to create more facilities, click the CREATE MORE button and follow the prompts. When you have created all of the facilities that you currently want, click the NEXT STEP button.

Step 3: Define network subnets

The network subnet of the RAIN RFID readers is usually different from the network subnet of the ItemSense server. On the Configure Networking page, you must define any subnets on which RAIN RFID readers reside so that the IMC can discover which readers are connected when it scans the networks.

To define a new subnet, click the ADD SUBNET button; enter a name for the subnet in the Name field (the name aenSubnet01 is used in this example); in the IP Address/Range field, enter either the IP address of a target reader or an IP address range in CIDR format (an IP address range of 10.200.35.0/27 is used in this example).

Note: If a specific IP address, A.B.C.D, is provided instead of a range, then the following addresses are scanned: A.B.C.1–A.B.C.255. If you enter an address such as 10.200.35.66/32, using CIDR format, only this one address is scanned.

Click the ADD RANGE button to add the subnet. To add more subnets, click the ADD SUBNET button again and repeat the process. When you've finished adding subnets, click the NEXT STEP button.

Step 3: Page, Configure Networking. Text, View, validate, and define networks. Button, Add subnet.

Step 4: Scan the networks for readers

On the Scan attached networks for readers page, the subnets that you defined in step 3 are listed. Select the subnets that you want to scan (you should scan all of them for this initial setup) and click the DISCOVER READERS button. This might take some time, depending on the number of networks defined—the more networks defined in step 3, the longer this scan will take.

Step 4: Page, Scan attached networks for readers. Text, Select subnet ranges to scan for Impinj readers. Button, Discover readers.

When the scan completes, a list of valid RAIN RFID readers is displayed. If you want to register the readers later, click the SKIP READER REGISTRATION STEPS button to skip the registration process; otherwise, select the readers that you want to register and then click the REGISTER SELECTED READERS button to proceed with the registration process.

Note: If you see the following dialog box, enter the current credentials of the reader. This dialog box appears because the reader's default credentials were changed. You won't be able to register the reader without entering the reader's current credentials.

Dialog box for entering credentials of a reader.

After you click the REGISTER SELECTED READERS button, a message box requests confirmation. Click the Proceed button to confirm that you want to start the registration process. Once this process begins, it will take about five to ten minutes to complete and it cannot be canceled.

Step 5: Register readers and install the Reader Agent

The readers that you selected in step 4 are now being registered. ItemSense installs the Reader Agent on each reader that it registers.

The status of the installation on each reader is displayed on the Reader Registration page as the process continues. Once the reader registrations and Reader Agent installations have completed, ItemSense displays the message Reader registration completed successfully. Click the GO TO READER DEFINITIONS button to continue.

Reader Registration. Displays status of, Agent installer upload completed, ready for reboot.

Step 6: Complete the setup

The Setup complete page displays indicating that ItemSense is now set up and ready to use via either the IMC or the APIs. Click the GO TO DASHBOARD button to view the IMC dashboard.

Setup complete page. Text, You're good to go. Button, Go to dashboard.

Monitor Reader Health

The overall health status of the reader is displayed in the top right hand corner of the reader definition. The reader states that indicate the overall health status are described in the following table.

Reader state Meaning
AWAITING_AGENT The reader is known to ItemSense but ItemSense has not received any health updates from the reader, possibly because the Reader Agent has not yet been installed
IDLE The reader is fully configured but performing no activities. In other words, no jobs are running and no software updates are being performed.
RUNNING_JOB The reader is running a job.
UPDATING_FIRMWARE The reader is having its firmware updated.
NOT_RESPONDING The reader has stopped checking in to ItemSense.

The details of the health of the reader is viewed by clicking on the View Details link.

ItemSense Reader Health

The details include five status categories:

  • Connection status: Reported as unhealthy when there is a problem with the health and monitoring channel between the reader and ItemSense
  • Throughput status: Reported as unhealthy when the reader is accumulating data faster than it can send data to ItemSense
  • Clock synchronization status: Reported as unhealthy when the reader cannot synchronize with its time provider (e.g. its NTP server)
  • Software status: Reported as unhealthy when the reader has received invalid input or has encountered either an internal configuration error or a software error
  • Hardware status: Reported as unhealthy when a low-level error occurs on the reader

Each of these categories shows HEALTHY if there are no conditions affecting the health of the reader.

ItemSense Reader Health Categories

A category shows WARNING when a condition that affects reader health has occurred at a low enough frequency that it is not considered an error. A category shows FAILED when a condition that affects reader health has occurred at a higher frequency.

An example of a condition that produces a WARNING status for the Throughput category is shown in the screenshot below.

A status returns to healthy in the absence of conditions affecting reader health being reported to ItemSense.

ItemSense Reader Health Warning

Re-register Readers

Sometimes it may be necessary to re-register a reader if the reader loses contact with ItemSense. Re-registering a reader can also be done as a troubleshooting step if the reader in question is displaying a bad health status that has not resolved for some time.

To re-register a reader:

  • On the ItemSense menu, click readers
  • Click the SCANNER tab on the Readers submenu
  • Click the DISCOVER READERS button

Readers that have an unhealthy status appear towards the top of the reader list: Reader re-registration

A highlighted message is displayed for any reader that is unhealthy. To continue with re-registration, just select the desired readers and click the REGISTER SELECTED READERS button.

After the reader is re-registered, it may take up to ten minutes for the reader to show up as healthy on the IMC and health API endpoints. This is because ItemSense must see the reader in a healthy state for a certain period of time before the reader can be considered fully healthy again.

Update Firmware

To update the firmware on the readers, click on the vertical ellipsis to view the administration drop-down menu and click on Admin.

Administration

On the Administration page, click on the SOFTWARE INSTALL tab. In the Software to install field, select Reader Firmware. Select the version and the maximum number of readers to update in parallel.

Under Choose readers, click the arrow to the left of a facility name to view a list of all readers within a particular facility. For each facility, check the box to the left of each reader that you want to update.

Click the START INSTALLATION button and then the I understand button in the confirmation box to proceed with the installation.

Firmware