User guide

Speedway Reader IPJ-R1000 for Gen 2 UHF RFID
22
Table 6-1 Upgrade Configuration Definition
6.4. Preparing the Upgrade Configuration Metafile
The upgrade configuration metafile is prepared on the server as pointed to by the reader’s metafile URI. The data entries in the
metafile should follow the format and definition given in section 6.3. Missing mandatory data entries and bad syntax will cause
the reader to reject the metafile.
The upgrade image file pointed to by the upgrade-file-uri field must contain the same partitions, image types, and versions as
described by the partition fields in the metafile. Disagreement between the metafile and the upgrade image file will cause the
reader to reject the downloaded image file.
The path and permission of the metafile on the server should be set properly to allow file retrieval via the method specified by
the URI parameter in the config image metafile command as explained in Section 7.4.2.3.
Field Name Field Value Param Name
Param
Value
Description
This field indicates how the metafile is to be retrieved.
push This tells the reader to wait to be given upgrade information directly
retrieve-
mode
pull
retrieve-
period
<int>
This tells the reader to periodically retrieve the metafile. The
mandatory parameter specifies how often (in minutes) the
reader downloads the metafile
This field indicates how the reader determines the need for upgrade.
auto
The reader determines if an upgrade is necessary based on its knowledge of the local image
version compared to the upgrade file. Upgrade is needed if the local image has at least one
partition that has a lower version than the corresponding partition in the upgrade image file.
upgrade-
mode
forced
The reader should upgrade as long as the current image has at least one partition that has a
different version from the corresponding partition in the upgrade image file.
This field indicates how the image should be activated.
immediate
The image should be activated immediately after the upgrade is complete, causing an immediate
reboot after programming is complete.
wait-4-cmd The image should be activated by a reboot command from the user.
time <string>
Reboot is scheduled at the time indicated by the mandatory
parameter time. The value of time is a string that takes the
format of “<time-zone>:yyyy:mm:dd:hh:mm:ss” where
<time-zone> is gmt.
commit-
mode
scheduled
early-act-ok
(optional)
{no, yes}
It’s OK to activate the upgraded image before its scheduled
activation time due to an early reboot. Default value is no when
this parameter is absent.
dl-retries
<int> Number of times to retry if download fails due to timeout.
dl-retry-
period
<int> Time to wait (seconds) before retrying a download.
upgrade-file
<int> This field is used as a delimiter. It means all data fields after this one, up to the next delimiter or
end of metafile apply to the upgrade file indexed by the number in the field value <int>.
img-type
<int>
This field indicates the image type of the upgrade file specified by the
file field. The type is the
enumeration number <int>. Release notes will specify the image type. Refer to respective
release notes for each image.
upgrade-
file-uri
<string> This is the URI of the upgrade image file from which the upgrade image is downloaded.
This field is the partition descriptor in an upgrade file.
partition
<int> version <string>
Version of the partition, consisting of 4 fields of decimal
numbers separated by a dot ‘.’. The number in each field must
be in the range of 0 to 255.