Working With Impinj® ItemSense™ Management Console

Introduction

The ItemSense Management Console (IMC) app runs on the ItemSense Server and is accessed with a web browser. The ItemSense Management Console provides access to the administration, configuration and data query APIs of an ItemSense instance. This allows you to define and configure the RAIN RFID gateways to use with ItemSense, in addition to defining and configuring the zone maps, recipes and jobs that are required in order to start an ItemSense data collection session. Once a data collection session is underway, the IMC also provides the means of viewing the resulting item data.

Table of Contents

Provision ItemSense for the first time

When you run the ItemSense Management Console for the first time, a wizard walks you through the necessary steps to configure and confirm an ItemSense installation. After the wizard completes, the ItemSense Management Console will be ready to create reader configurations, zones, recipes, and run jobs.

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

Log into the server and use the IMC Wizard to configure ItemSense

Note: The IMC wizard will only execute on the first login.

If you are using a docker-based installation (2016r6 and later), the server IP address is the IP address of the machine on which you installed ItemSense.

If you are using an OVA-based installation, the server displays the URL of the ItemSense Management Console below the text, "ItemSense appliance running. Please connect your web browser to the address below to configure the appliance:".

The ItemSense Server with the URL to the ItemSense Management Console

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

The Instance ID and regulatory region screen

The ItemSense Instance ID and regulatory region page appears. When you requested your ItemSense instance, you should have been provided with an ItemSense Instance ID. This id will most likely be in the form of a UUID (123e4567-e89b-12d3-a456-426655440000). However, some customers may have an Instance ID in the form IS-XXXXXX. Both formats are acceptable. If you do not know your Instance ID, please contact support@impinj.com.

Paste your Instance ID into the field labeled Please enter your Instance ID. Select a regulatory region in the Regulatory region drop down.

Click the SUBMIT button to continue.

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

It will take a few seconds for your ItemSense instance to register itself. Once this is complete, the Log in screen will appear. 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.

Step 1: Change Administrator Password

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

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.

Enter the new admin password into New Password and Confirm New Password fields.

Click NEXT STEP to continue to the next step.

Step 2: Facilities

The next step is to create a facility.

The Create a facility page will appear with the text, "Please create at least one facility before continuing." Click CREATE A 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.

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.

Page, Create facilities. Text, You have 1 valid facility defined. Button, Create more. Field, New facility name. Check box, Set as current facility. Button, cancel. Button, create new facility, Button, previous step. Button, next step.

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 the facilities you want to create now, click the NEXT STEP button.

Step 3: Configure Networking

In many ItemSense installations the RAIN RFID Gateways that will be used will be on a different network subnet than the instance of ItemSense being deployed. In the Configure Networking section you can define any subnets on which RAIN RFID Gateways reside so that the ItemSense Management Console can scan the networks in order to discover which Gateways are connected, helping to streamline the configuration process.

In order to Define a new subnet it will be necessary to know the IP Address of one of the target RAIN RFID Gateways. Enter a name for the subnet in the Name field and the IP Address of the target reader in the IP Address field. Clicking the VERIFY link will then ensure that a network connection can be established to this device. If it is possible for a network connection to be established with the selected Gateway then the ADD NETWORK button becomes active and the subnet can be added to the list of networks to scan by hitting the ADD NETWORK button.

Step 3: View, validate, and define networks page. Displays the list of available networks with a link to ping each network. A rescan button is below the list. Below this is the text, Add a new network, with name field and an IP address field. The values REC and 10.200.91.67 have been entered into the fields. A verify link is to the right. Below is an ADD NETWORK button which is disabled because the added network has not been verified.

Enter a meaningful name for the network to scan in Name ("REC" is used in this example), and the IP Address of an RAIN RFID gateway within the target subnet in IP Address.

A drop down notification shows a thumbs up icon to the left and a white check mark in a red circle to the right. The text between the symbols says, REC is alive and well.

On clicking the VERIFY button, IMC will then perform a network query on the specified RAIN RFID gateway to see whether it is accessible, and if it is the ADD NETWORK button becomes highlighted. A drop down will appear at the top of the page which says the RAIN RFID gateway is "alive and well."

Once the subnet has been verified accessible and the ADD NETWORK button becomes enabled, click ADD NETWORK to add the specified subnet to the list of available networks.

Click NEXT STEP to continue to the next step.

Step 4: Scan Attached Networks for Readers

Step 4: Scan attached networks for readers. Text, Search your local network for Rain RFID readers. Button, discover.

On the "Scan attached networks for readers" page, click the DISCOVER button.

A spinner page, with the text underneath that reads, Scanning all attached networks for readers. This may take a while.

ItemSense will scan the specified network subnets for compatible Impinj RAIN RFID devices. It does this by forwarding an HTTP request to every possible IP address on the subnet. Valid Impinj RAIN RFID devices will be identified and displayed on the page when the process completes.

Displays the list of RAIN RFID readers by name, with each reader's IP address. Each reader entry has a Facility drop down to assign the reader to a facility, and a check box named Register which, when checked, includes this reader in the list of readers to register.

The list of RAIN RFID readers is displayed. Select the readers you want to register checking the Register check box. When you have selected all the readers you want to register, click the REGISTER SELECTED READERS button to continue.

Dialog box that displays the total number of readers selected and says it is about to register those readers. Also says, This process will take about five to ten minutes and once started cannot be canceled. Default button, Let's do it. Button, I'll do it later.

A dialog appears to verify that you want to register the selected RAIN RFID readers. Click the Let's do it button to start the registration process, or click I'll do it later to skip the registration process. The registration process will take about five to ten minutes to complete, and cannot be canceled.

The registration process will install and configure the Reader Agent on the selected readers. Currently, the Reader Agent will allow the readers to report health information to the system. In future releases it will enable additional functionality.

If you click Let's do it, a spinner page appears with the text, "Registering readers with ItemSense..."

Step 5: Configure Readers

After the readers are registered, the ItemSense Management Console will configure the registered readers.

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

ItemSense will install the Reader Agent on each reader that you selected on the previous screen. The status of each reader being updated will update as the process continues.

Reader registration completed successfully. Text, The ItemSense Agent is now running on the readers. You may need to perform some additional configuration before you can start reading tags. You can do so from the Reader Definitions page.

Once the Reader Agent install process has completed, ItemSense displays, "Reader registration completed successfully." Click the GO TO READER DEFINITIONS button to continue.

Step 6: Setup Complete

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

The ItemSense Management Console is now set up and ready to run a test job.

Click GO TO DASHBOARD.

Monitor Reader Health

The health status of the reader is displayed in the top right hand corner of the reader definition. The overall reader state can be one of:

  • AWAITING_AGENT: When 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: When the reader is fully configured but performing no activities i.e. no jobs are running and no software updates are being performed
  • RUNNING_JOB: When the reader is running a job
  • UPDATING_FIRMWARE: When the reader is having its firmware updated
  • NOT_RESPONDING: When the reader has stopped checking in to ItemSense.

ItemSense Reader Health

In addition, the details of the health of the reader is viewed by clicking on the 'View Details' link. This shows the following health status of the reader:

  • 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 be sent 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 been sent invalid input, or has encountered an internal configuration or software error
  • Hardware Status: reported as unhealthy when a low level error occurs on the reader

If there are no conditions affecting the health of the reader, then each of these conditions shows HEALTHY.

ItemSense Reader Health Categories

These categories show WARNING when a condition that affects reader health has occurred at a low enough frequency that it is not considered an error.

ItemSense Reader Health Warning

And these categories show FAILED when a condition that affects reader health has occurred at a higher frequency.

ItemSense Reader Health Failed

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

Re-register readers

Sometimes it may be necessary to re-register a reader if for some reason it 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 Scanner on the Readers submenu
  • Click Discover Readers

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

The reader will be highlighted with some guidance text indicating that it will be re-registered if selected. To continue with re-registration, just select the desired reader and click Register Selected Readers.

After the reader is re-registered, it may take up to ten minutes for the reader to show up as "healthy" on the ItemSense web UI 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, go to the Administration area:

Administration

Click on the 'Firmware' tab:

Firmware

  • If you are managing more than one facility, select the facility within which you wish to update reader firmware
  • Select the version of firmware to which to update the readers
  • Press 'Update'