CanPostal Decoder

RhoElements 2.x API

Overview

The CanPostal Decoder is used to enable or disable the canpostal decoder.

Syntax

canPostal (Decoder) <META> Syntax

<META HTTP-Equiv="scanner" content="canpostal:[parameter]">

canPostal JavaScript Object Syntax:
By default the JavaScript Object 'scanner' will exist on the current page and can be used to interact directly with the canPostal.
To Set canPostal parameters via JavaScript use the following syntax: scanner.Parameter = Value;

e.g. scanner.canPostal = Value;

Parameters

Items listed in this section indicate parameters, or attributes which can be set.

NamePossible ValuesDescriptionDefault Value
canPostal:[Value] Enabled/DisabledEnables/Disables Canpostal Decoder. N/A

Requirements

RhoElements Version1.0.0 or above
Supported DevicesAll supported devices.
Minimum RequirementsScanner or Imager module and device that supports canpostal.
PersistenceTransient - Decoder settings are only guaranteed to persist until the Scanner is disabled

HTML/JavaScript Examples

The following example enables the scanner to read only canpostal labels:

<META HTTP-Equiv="scanner" Content="allDecoders:disabled">
<META HTTP-Equiv="scanner" Content="canpostal:enabled">
<META HTTP-Equiv="scanner" Content="enabled">

Above example can also be written as shown below:

<META HTTP-Equiv="scanner" Content="allDecoders:disabled;canpostal:enabled;enabled">

or

<META HTTP-Equiv="scanner-all_decoders" Content="disabled">
<META HTTP-Equiv="scanner-canpostal" Content="enabled">
<META HTTP-Equiv="scanner-enabled" Content="SCN1">

The following example enables the scanner to read all labels except canpostal:

<META HTTP-Equiv="scanner" Content="allDecoders:enabled">
<META HTTP-Equiv="scanner" Content="canpostal:disabled">
<META HTTP-Equiv="scanner" Content="enabled">