Impinj IoT Device Interface Release Notes, version 1.8.0
This document describes the changes to the Impinj IoT Device Interface as of version 1.8.0, which corresponds with the 8.2 version of the overall reader firmware.
Changes are relative to the previous release, which was the version 1.7 release that corresponded to the 8.1 version of the overall reader firmware.
Breaking Changes
There are no breaking changes in this release. The base API URL is still api/v1.
Additions
- Availability improvements
- This release makes certain endpoints available even when the reader is configured to use LLRP as the RFID interface:
- Event configuration endpoints are always available:
/mqtt,/http-streaming,/kafka, and/webhook/events. - Event streams are always available.
/profilesendpoint always available, but will only report profiles if the IoT interface is selected./profiles/stopendpoint is always available, and will remove the saved Preset (now reported under/status) if the IoT interface is not selected.
- Event configuration endpoints are always available:
- This release makes certain endpoints available even when the reader is configured to use LLRP as the RFID interface:
- RFID improvements
- Added periodic and duration triggers to inventory profile (see
PeriodicTriggerandDurationTrigger). - Added tag population estimation algorithm parameter which is enabled by default (see
InventoryRequest.tagPopulationEstimationAlgorithm). - Added advanced GPO controls (see
GpoConfiguration).
- Added periodic and duration triggers to inventory profile (see
- System reporting improvements
- Added system temparature endpoint (see
/system/temperature). - Added system utilization enpdoint (see
/system/utilization).
- Added system temparature endpoint (see
- Security improvements
- Added the ability to unassign a TLS certificate from a service (see
/system/certificates/tls/services/{tlsService}).
- Added the ability to unassign a TLS certificate from a service (see
- Schema clean-up
- Additional detail for schema validation failures (see
ErrorResponse.schemaError). - Added required properties to
/statusendpoint. - Updated descriptions to distinguish profile "configurations" (a JSON object that describes how to configure a profile) from profile "presets" (a "configuration" that is stored on the reader).
- When the IoT interface is selected, but no region has been selected, paths will no longer return a 500 response. Endpoints that depend on RFID services will instead operate similar to as if the IoT interface is disabled.
- New password requirements (regex pattern added).
- Additional detail for schema validation failures (see
- Other improvements
- System version is now reported in semantic version format.
Deprecations
No endpoints were deprecated in this release.
Removals
No endpoints were removed in this release.
Impinj IoT Device Interface Release Notes, version 1.7
This document describes the changes to the Impinj IoT Device Interface as of version 1.7, which corresponds with the 8.1 version of the overall reader firmware.
Changes are relative to the previous release, which was the version 1.6 release that corresponded to the 8.0 version of the overall reader firmware.
Breaking Changes
There are no breaking changes in this release. The base API URL is still api/v1.
Additions
- Security improvements
- New
digestoption for HTTP/HTTPS authentication, to supplement the existingnoneandbasicoptions. Set through the new/system/access/authenticationendpoint. - Ability to specify reader users and passwords through the following API endpoints:
/system/access/users/system/access/users/{userId}/password
- Added multiple endpoints and data types to manage CAP certificates on the reader, all under
/system/certificates/cap/certs/.
- New
- Reporting improvements
- New optional
AntennaActivationEventthat can be sent after successfully ramping up power on an antenna and just before starting an inventory micro-cyle. - New optional
xpcHexfield, for tags that support XPC (eXtended Protocol Control) words.
- New optional
- Data egress improvements
- Optional customization of the
keepAliveIntervalSecondsin theStreamConfigurationparameter, for HTTP/S streaming output. The default value is still 30 seconds. - LWT (Last Will and Testament) changes to match industry best practices. The new default message for the
willMessageis "connection lost" for ungraceful disconnections, and the message will only be sent if thewillTopicis set. Also added the optionalconnectMessage(for the initial connection and and reconnections) and optionaldisconnectMessage(for graceful disconnections from the broker). The default QoS (Quality of Service) level is now 1.
- Optional customization of the
- RFID improvements
- Added a new EPC filter verification type,
passive, which verifies that backscattered EPCs match configured filters before passing them on. Thepassiveoperation uses information already available to the reader, so it does not require additional tag singulation over the air. It is the new default value. Note that thepassivemode is not compatible with the TruncatedReply features, as it needs the full EPC to verify the filter.
- Added a new EPC filter verification type,
- Schema clean-up
- Increased the minimum length of a DNS SearchDomain from 1 character to 2.
- Associated the
SavedPresetBadRequestresponse with theErrorResponseparameter, like other error response values.
Deprecations
No endpoints were deprecated in this release.
Removals
No endpoints were removed in this release.
Impinj IoT Device Interface Release Notes, version 1.6
This document describes the changes to the Impinj IoT Device Interface as of version 1.6, which corresponds with the 8.0 version of the overall reader firmware.
Changes are relative to the previous release, which was the version 1.5 release that corresponded to the 7.6 version of the overall reader firmware.
Breaking Changes
There are no breaking changes in this release. The base API URL is still api/v1.
Additions
- Support for WebHooks for data egress
- New
/webhooks/eventendpoint and associated data types
- New
- Support for a new Certificate Manager
/system/certificates/ca/certsfor installing or retrieving CA certs/system/certificates/tls/certsfor installing or retrieving TLS certs/system/certificates/tls/certs/csrfor creating a CSR (Certificate Signing Request)/system/certificates/tls/servicesfor installing or retrieving TLS certs for a particular service
- New endpoints for enabling/disabling network services
/system/http/system/https/system/mdns
- Support for GPO configuration
/device/gpos
- Support for enabling/disabling CAP installation
/system/cap/installation
- New diagnostics endpoints
/system/diagnostics/debug-bundleto download a compressed set of diagnostic files/system/diagnostics/watchdog-bundleto download files related to unintended system restarts, if they exist
- Schema clean-up
- New
/openapi.jsonendpoint to retrieve the full schema - Added a new
eventTypefield to aReaderEvent - Removed some event types:
InventoryTerminatedEventTagLocationEventDiagnosticEvent
- Added a new
addressModefield to aNetworkAddress - New fields for
filterLinkandfilterVerificationin theInventoryFilterConfigurationparameter - Minor changes regarding value limits:
- New minimum (1) and maximum (25) on the GET
/profilesendpoint - Removed minumum and multipleOf limits in the
TransmitPowerCdbmparameter - Removed minimum and multipleOf limits in the
minimumPowerCdbmfield of theTransmitPowerSweepConfigurationobject - Updated the minumum and maximum values of the
stepSizeDdbfield in theTransmitPowerSweepConfigurationobject - New maximum value of 8192 on the
bitOffsetparameter in aTagFilter startTriggersandstopTriggershave a minimum and maximum value of 1 in anInventoryRequest- The maximum number of bootstraps in a
kafkaConfigurationis now 100
- New minimum (1) and maximum (25) on the GET
- New
Deprecations
GET /profiles/inventory/presets-schema is deprecated in this release. Use the new GET /openapi.json endpoint instead, as it provides the preset schema as a subset of the overall API schema.
Removals
No endpoints were removed.
Comments
Please sign in to leave a comment.