### Start Property Editor with Context (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Starts a settings activity to configure the properties of the BarcodeReader. This method requires a Context to launch the activity.

```java
public void startPropertyEditor(Context context)
```

--------------------------------

### List All Installed Barcode Devices

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

Returns a list of BarcodeReaderInfo objects for all barcode devices installed since the device was powered on. This list may include devices that are not currently attached. Returns null if functionality is limited.

```java
public List<BarcodeReaderInfo> listBarcodeDevices()
```

--------------------------------

### Start Property Editor with Context, Group, and Title (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Starts a settings activity to configure specific property groups of the BarcodeReader. This method allows specifying the context, property group, and activity title.

```java
public void startPropertyEditor(Context context,
                       String propertyGroup,
                       String activityTitle)
```

--------------------------------

### Get Multiple Scanner Properties

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves a map of properties from the scanner. The names of the properties to get are provided as a Set. getAllProperties() can be used to get the map of all properties.

```java
public Map<String, Object> getProperties(Set<String> names) {
    // Implementation details
}
```

--------------------------------

### Barcode Reader Property Editor API

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Start a settings activity to configure BarcodeReader properties.

```APIDOC
## Barcode Reader Property Editor API

This API provides methods to launch a user interface for configuring BarcodeReader properties.

### Start Property Editor

Starts a settings activity that can configure the properties of this `BarcodeReader`.

- **Method**: POST
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Query Parameters**:
    - **context** (Context) - Required - The application context.
    - **propertyGroup** (String) - Optional - The property group to focus on.
    - **activityTitle** (String) - Optional - The title for the settings activity.

```

--------------------------------

### Get All Properties (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves a map containing all properties of the BarcodeReader. This method returns a Map<String, Object> representing the current configuration.

```java
public Map<String,Object> getAllProperties()
```

--------------------------------

### Get Scanner Information

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves information about the barcode scanner. The getInfo() method may throw a ScannerUnavailableException if the scanner is not available.

```java
public BarcodeReaderInfo getInfo() throws ScannerUnavailableException
```

--------------------------------

### Signature Area Binarization API

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Provides methods to get and set the binarization state of the signature area.

```APIDOC
## GET /signature/binarized

### Description
Retrieves whether the signature area is set to be converted to black and white pixels.

### Method
GET

### Endpoint
/signature/binarized

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **binarized** (boolean) - True if the image should be converted to black and white pixels, false otherwise.

#### Response Example
```json
{
  "binarized": true
}
```

## POST /signature/binarized

### Description
Sets whether the image generated from the signature area should be converted to black and white pixels.

### Method
POST

### Endpoint
/signature/binarized

### Parameters
#### Request Body
- **binarized** (boolean) - Required - Set to true to convert the image to black and white pixels, false otherwise.

### Request Example
```json
{
  "binarized": false
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Signature area binarization setting updated successfully."
}
```
```

--------------------------------

### Get Connection Status Method

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeDeviceConnectionEvent

Gets the connection status of the barcode device. This method returns an integer representing the current connection state.

```java
public int getConnectionStatus()

Gets the connection status of the Barcode Device 

Returns:
    An integer relaying the connection status

See Also:
    AidcManager.BARCODE_DEVICE_DISCONNECTED, AidcManager.BARCODE_DEVICE_CONNECTED
```

--------------------------------

### Barcode Reader Properties API

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

This section details how to get and set various properties of the BarcodeReader, including image-related settings and UPC-E configurations.

```APIDOC
## Barcode Reader Properties API

This API allows for the retrieval and modification of various properties associated with the BarcodeReader.

### Get All Default Properties

Retrieves the map of all default properties.

- **Method**: GET
- **Endpoint**: N/A (Method call)
- **Response**:
  - **Map<String, Object>** (Map) - A map containing all default properties.

### Get All Properties

Retrieves the map of all current properties.

- **Method**: GET
- **Endpoint**: N/A (Method call)
- **Response**:
  - **Map<String, Object>** (Map) - A map containing all current properties.

### Get Boolean Property

Retrieves a boolean property value.

- **Method**: GET
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Path Parameters**:
    - **name** (String) - Required - The name of the property to retrieve.
- **Response**:
  - **boolean** (Boolean) - The boolean value of the property.

### Get Integer Property

Retrieves an integer property value.

- **Method**: GET
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Path Parameters**:
    - **name** (String) - Required - The name of the property to retrieve.
- **Response**:
  - **int** (Integer) - The integer value of the property.

### Get String Property

Retrieves a string property value.

- **Method**: GET
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Path Parameters**:
    - **name** (String) - Required - The name of the property to retrieve.
- **Response**:
  - **String** (String) - The string value of the property.

### Get Properties by Names

Retrieves a map of properties based on a set of names.

- **Method**: GET
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Query Parameters**:
    - **names** (Set<String>) - Required - A set of property names to retrieve.
- **Response**:
  - **Map<String, Object>** (Map) - A map containing the requested properties.

### Set Properties

Sets a map of properties.

- **Method**: POST
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Request Body**:
    - **properties** (Map<String, Object>) - Required - A map of properties to set.

### Set Boolean Property

Sets a boolean property.

- **Method**: POST
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Query Parameters**:
    - **name** (String) - Required - The name of the property to set.
    - **value** (boolean) - Required - The boolean value to set.

### Set Integer Property

Sets an integer property.

- **Method**: POST
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Query Parameters**:
    - **name** (String) - Required - The name of the property to set.
    - **value** (int) - Required - The integer value to set.

### Set String or Enum Property

Sets a string or enum property.

- **Method**: POST
- **Endpoint**: N/A (Method call)
- **Parameters**:
  - **Query Parameters**:
    - **name** (String) - Required - The name of the property to set.
    - **value** (String) - Required - The string value to set.

### Property Details

- **PROPERTY_UPC_E_EXPAND_TO_UPC_A**: Enable or disable expanding a UPC-E barcode into a UPC-A standard code.
- **PROPERTY_UPC_E_FIVE_CHAR_ADDENDA_ENABLED**: Enable or disable add-on 5 for UPC-E.
- **PROPERTY_UPC_E_NUMBER_SYSTEM_TRANSMIT_ENABLED**: Enable or disable number system transmission for UPC-E.
- **PROPERTY_UPC_E_TWO_CHAR_ADDENDA_ENABLED**: Enable or disable add-on 2 for UPC-E.
- **TRIGGER_CONTROL_MODE_AUTO_CONTROL**: Automatic control mode for triggers.
- **TRIGGER_CONTROL_MODE_CLIENT_CONTROL**: Client control mode for triggers.
- **TRIGGER_CONTROL_MODE_DISABLE**: Trigger control disabled.
- **PROPERTY_IMAGER_LIGHT_INTENSITY**: Imager illumination intensity as a percentage of the maximum.
- **PROPERTY_IMAGER_EXPOSURE**: Exposure time in microseconds when using fixed exposure.
- **PROPERTY_IMAGER_GAIN**: Sensitivity of image sensor when using fixed exposure.
- **PROPERTY_IMAGER_MAXIMUM_EXPOSURE**: Maximum exposure time in microseconds when using automatic exposure.
- **PROPERTY_IMAGER_MAXIMUM_GAIN**: Maximum sensitivity of image sensor when using automatic exposure.
- **PROPERTY_IMAGER_TARGET_VALUE**: Target value for image sensor sensitivity in automatic exposure.

```

--------------------------------

### BarcodeReader Overview

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

The BarcodeReader class represents a session to an installed scanner. Multiple instances can be created, each maintaining independent properties and operating separately. A specific permission is required to use this class.

```APIDOC
## BarcodeReader Class

### Description
This class represents a session to an installed scanner. Any number of `BarcodeReader` objects can be created, and each will maintain its own properties and will operate independently from other `BarcodeReader` objects.

Permission required: "com.honeywell.decode.permission.DECODE"

### Scanner Claim/Release
Only one `BarcodeReader` object can hold a claim to the scanner at a time. The last `BarcodeReader` to call `claim()` will receive the claim, causing the previous owner's claim to be released. `release()` can be called to voluntarily release the scanner claim. When no `BarcodeReader` holds a scanner claim, the application profile properties will be applied. Therefore, voluntarily releasing the scanner is required if the behavior of application profiles is desired.

When the `BarcodeReader` holds the scanner claim, you can control the scanner via `aim(boolean)`, `light(boolean)` and `decode(boolean)`, and can receive bar code data asynchronously. If the `BarcodeReader` does not hold the scanner claim, `ScannerNotClaimedException` will be thrown.

Whether or not the `BarcodeReader` holds the scanner claim, you may get and set `BarcodeReader` properties. Note, however, that properties will only be applied when the scanner is claimed. If properties are set prior to calling `claim()`, those properties will be applied as soon as `claim()` is called.
```

--------------------------------

### Get Default Properties (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves a map containing all default properties of the BarcodeReader. This method returns a Map<String, Object> representing the factory default configuration.

```java
public Map<String,Object> getAllDefaultProperties()
```

--------------------------------

### SignatureParameters Methods

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

This section details the methods available for the SignatureParameters class, used to get and set various signature extraction parameters.

```APIDOC
## SignatureParameters Methods

### Description
Provides methods to retrieve and modify the parameters for signature extraction, including dimensions, offsets, resolution, and binarization.

### Method Summary

#### Getter Methods:
- **getAspectRatio**() (int)
  Returns the height of the barcode relative to the narrow bar width.

- **getHeight**() (int)
  Returns the height of the signature area.

- **getHorizontalOffset**() (int)
  Returns the horizontal offset of the signature area.

- **getResolution**() (int)
  Returns the number of pixels per unit in the returned image.

- **getVerticalOffset**() (int)
  Returns the vertical offset of the signature area.

- **getWidth**() (int)
  Returns the width of the signature area.

- **isBinarized**() (boolean)
  Returns `true` if the image should be converted to black and white pixels, `false` otherwise.

#### Setter Methods:
- **setAspectRatio**(int aspectRatio)
  Sets the height of the barcode relative to the narrow bar width.
  - **aspectRatio** (int) - The height of the barcode relative to narrow bar width.

- **setBinarized**(boolean binarized)
  Sets whether the image should be converted to black and white pixels.
  - **binarized** (boolean) - `true` to convert to black and white pixels, `false` otherwise.

- **setHeight**(int height)
  Sets the height of the signature area.
  - **height** (int) - The desired height of the signature area.

- **setHorizontalOffset**(int horizontalOffset)
  Sets the horizontal offset of the signature area.
  - **horizontalOffset** (int) - The desired horizontal offset.

- **setResolution**(int resolution)
  Sets the number of pixels per unit in the returned image.
  - **resolution** (int) - The desired resolution.

- **setVerticalOffset**(int verticalOffset)
  Sets the vertical offset of the signature area.
  - **verticalOffset** (int) - The desired vertical offset.

- **setWidth**(int width)
  Sets the width of the signature area.
  - **width** (int) - The desired width of the signature area.
```

--------------------------------

### AidcException Description (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/UnsupportedPropertyException

This describes the AidcException, which is the superclass of UnsupportedPropertyException. It is thrown when attempting to get or set a property that the scanner service does not support.

```java
AidcException thrown when attempting to get/set a property that is unsupported by the scanner service.
```

--------------------------------

### AidcManager Creation and BarcodeReader Instantiation

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

This section details how to create an instance of AidcManager and subsequently create a BarcodeReader object to interact with the scanner.

```APIDOC
## POST /websites/download_salamandre_tm_fr_api/AidcManager

### Description
Provides static methods to create and manage the AidcManager singleton and BarcodeReader instances.

### Method
POST

### Endpoint
/websites/download_salamandre_tm_fr_api/AidcManager

### Parameters
#### Query Parameters
- **context** (Context) - Required - The context of the client application.
- **callback** (AidcManager.CreatedCallback) - Required - An object implementing the AidcManager.CreatedCallback interface.

### Request Body
This endpoint does not have a request body.

### Response
#### Success Response (200)
- **AidcManager** (AidcManager) - The created AidcManager instance.

#### Response Example
```json
{
  "message": "AidcManager created successfully"
}
```

## POST /websites/download_salamandre_tm_fr_api/AidcManager/createBarcodeReader

### Description
Attempts to instantiate a BarcodeReader object connected to the internal scanner.

### Method
POST

### Endpoint
/websites/download_salamandre_tm_fr_api/AidcManager/createBarcodeReader

### Parameters
#### Query Parameters
- **scannerName** (String) - Optional - The name of the scanner to create the BarcodeReader for.

### Request Body
This endpoint does not have a request body.

### Response
#### Success Response (200)
- **BarcodeReader** (BarcodeReader) - The created BarcodeReader object.

#### Response Example
```json
{
  "message": "BarcodeReader created successfully"
}
```
```

--------------------------------

### Get String Scanner Property

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves a string property value from the scanner. Parameters include the name of the property to get. This method may throw UnsupportedPropertyException.

```java
public String getStringProperty(String name) throws UnsupportedPropertyException {
    // Implementation details
}
```

--------------------------------

### Get Boolean Scanner Property

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves a boolean property value from the scanner. Parameters include the name of the property to get. This method may throw UnsupportedPropertyException.

```java
public boolean getBooleanProperty(String name) throws UnsupportedPropertyException {
    // Implementation details
}
```

--------------------------------

### Create AidcManager Instance

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

Binds to the scanner service and creates the singleton instance of AidcManager. The created instance is then passed to the provided callback.

```java
public static void create(Context context, AidcManager.CreatedCallback callback)
```

--------------------------------

### Get Integer Scanner Property

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Retrieves an integer property value from the scanner. Parameters include the name of the property to get. This method may throw UnsupportedPropertyException.

```java
public int getIntProperty(String name) throws UnsupportedPropertyException {
    // Implementation details
}
```

--------------------------------

### UnsupportedPropertyException Class

Source: https://download.salamandre.tm.fr/api/serialized-form

Indicates that a requested property is not supported by the device. It extends AidcException and is Serializable.

```APIDOC
## Class com.honeywell.aidc.UnsupportedPropertyException

### Description
Indicates that a requested property is not supported by the device. It extends AidcException and is Serializable.

### Method
N/A (Class Definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Error Handling
N/A
```

--------------------------------

### Create Default BarcodeReader

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

Attempts to instantiate a BarcodeReader for the internal scanner. Throws an exception if an error occurs. The returned object represents a session with the internal scanner.

```java
public BarcodeReader createBarcodeReader()
```

--------------------------------

### List Currently Connected Barcode Devices

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

Returns a list of BarcodeReaderInfo objects for barcode devices currently connected to the device. Returns null if functionality is limited.

```java
public List<BarcodeReaderInfo> listConnectedBarcodeDevices()
```

--------------------------------

### Enable Planet and Postnet Mode

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Sets the postal 2D mode to enable Planet and Postnet. This is a common configuration for postal services.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_POSTNET
```

--------------------------------

### SignatureParameters Constructors

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

This section details the constructors available for the SignatureParameters class, used to initialize signature extraction settings.

```APIDOC
## SignatureParameters Constructors

### Description
Provides methods to construct a SignatureParameters object, which holds the configuration for signature extraction from an image.

### Constructor Summary

- **SignatureParameters**()
  Constructs a new SignatureParameters object with default values.

- **SignatureParameters**(int aspectRatio, int horizontalOffset, int verticalOffset, int width, int height, int resolution, boolean binarized)
  Constructs a new SignatureParameters object with specified values. All measurements are relative to the narrow bar width of the barcode.

  #### Parameters for SignatureParameters(int, int, int, int, int, int, boolean):
  - **aspectRatio** (int) - The height of the barcode relative to narrow bar width.
  - **horizontalOffset** (int) - The horizontal offset of the signature area.
  - **verticalOffset** (int) - The vertical offset of the signature area.
  - **width** (int) - The width of the signature area.
  - **height** (int) - The height of the signature area.
  - **resolution** (int) - The number of pixels per unit in the returned image.
  - **binarized** (boolean) - Indicates whether the image should be converted to black and white pixels.
```

--------------------------------

### Signature Area Resolution API

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Provides methods to get and set the resolution of the signature area.

```APIDOC
## GET /signature/resolution

### Description
Retrieves the current resolution of the signature area, which defines the number of pixels per unit in the returned image.

### Method
GET

### Endpoint
/signature/resolution

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **resolution** (integer) - The number of pixels per unit in the returned image.

#### Response Example
```json
{
  "resolution": 300
}
```

## POST /signature/resolution

### Description
Sets the resolution for the signature area. This determines the number of pixels per unit in the generated image.

### Method
POST

### Endpoint
/signature/resolution

### Parameters
#### Request Body
- **resolution** (integer) - Required - The desired number of pixels per unit.

### Request Example
```json
{
  "resolution": 600
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Signature area resolution set successfully."
}
```
```

--------------------------------

### Enable Planet, Postnet, and UPU Modes

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Configures the postal 2D mode to support Planet, Postnet, and UPU. This is a comprehensive setting for various postal encoding standards.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU
```

--------------------------------

### Signature Area Height API

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Provides methods to get and set the height of the signature area.

```APIDOC
## GET /signature/height

### Description
Retrieves the current height of the signature area.

### Method
GET

### Endpoint
/signature/height

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **height** (integer) - The height of the signature area.

#### Response Example
```json
{
  "height": 300
}
```

## POST /signature/height

### Description
Sets the height of the signature area.

### Method
POST

### Endpoint
/signature/height

### Parameters
#### Request Body
- **height** (integer) - Required - The desired height of the signature area.

### Request Example
```json
{
  "height": 350
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Signature area height set successfully."
}
```
```

--------------------------------

### Enable Planet, Postnet, and UPU with B and B Fields

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables Planet, Postnet, and UPU modes along with 'B and B fields'. This advanced configuration caters to complex postal data requirements.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_UPU_PLUS_BNB
```

--------------------------------

### Signature Area Width API

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Provides methods to get and set the width of the signature area.

```APIDOC
## GET /signature/width

### Description
Retrieves the current width of the signature area.

### Method
GET

### Endpoint
/signature/width

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **width** (integer) - The width of the signature area.

#### Response Example
```json
{
  "width": 500
}
```

## POST /signature/width

### Description
Sets the width of the signature area.

### Method
POST

### Endpoint
/signature/width

### Parameters
#### Request Body
- **width** (integer) - Required - The desired width of the signature area.

### Request Example
```json
{
  "width": 600
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Signature area width set successfully."
}
```
```

--------------------------------

### Barcode Device Information

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

APIs to retrieve lists of available and connected barcode devices.

```APIDOC
## GET /websites/download_salamandre_tm_fr_api/AidcManager/listBarcodeDevices

### Description
Returns a list of all available `BarcodeReaderInfo` objects, representing all barcode devices recognized by the system.

### Method
GET

### Endpoint
/websites/download_salamandre_tm_fr_api/AidcManager/listBarcodeDevices

### Parameters
This endpoint does not have any parameters.

### Request Body
This endpoint does not have a request body.

### Response
#### Success Response (200)
- **barcodeDevices** (List<BarcodeReaderInfo>) - A list of `BarcodeReaderInfo` objects.

#### Response Example
```json
{
  "barcodeDevices": [
    {
      "name": "SCANNER_1",
      "model": "H1234",
      "version": "1.0.0"
    }
  ]
}
```

## GET /websites/download_salamandre_tm_fr_api/AidcManager/listConnectedBarcodeDevices

### Description
Returns a list of `BarcodeReaderInfo` objects for only the barcode devices that are currently connected.

### Method
GET

### Endpoint
/websites/download_salamandre_tm_fr_api/AidcManager/listConnectedBarcodeDevices

### Parameters
This endpoint does not have any parameters.

### Request Body
This endpoint does not have a request body.

### Response
#### Success Response (200)
- **connectedBarcodeDevices** (List<BarcodeReaderInfo>) - A list of `BarcodeReaderInfo` objects for connected devices.

#### Response Example
```json
{
  "connectedBarcodeDevices": [
    {
      "name": "SCANNER_1",
      "model": "H1234",
      "version": "1.0.0"
    }
  ]
}
```
```

--------------------------------

### Create BarcodeReader for Specific Scanner

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

Attempts to instantiate a BarcodeReader for a specified scanner name. Throws an exception if an error occurs. The returned object represents a session with the specified scanner.

```java
public BarcodeReader createBarcodeReader(String scannerName)
```

--------------------------------

### Launch Behavior Properties

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Properties that control the behavior when scanning specific types of barcodes, such as URLs or intents.

```APIDOC
## Launch Behavior Properties

### Description
Properties that determine whether scanning certain barcodes will launch external applications or intents.

### Method
N/A (Constants)

### Endpoint
N/A (Constants)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
N/A (Constants)

#### Response Example
None

## Constants

### `PROPERTY_DATA_PROCESSOR_LAUNCH_BROWSER`

**Description:** Indicates if scanning bar codes containing URLs will open the internet browser. Bar codes containing URLs will not cause a `BarcodeReadEvent` if this property is true. It is true by default.

### `PROPERTY_DATA_PROCESSOR_SCAN_TO_INTENT`

**Description:** Indicates if bar codes starting with "//" will attempt to open an application. Bar codes with the format "//" or "//$ " will launch an application listening for an intent with the action "com.honeywell.scantointent.intent.action." where the name has all letters capitalized. Data if present will be included as an extra. The extra key for the data is "com.honeywell.scantointent.intent.extra.DATA". Bar codes starting with "//" will not cause a `BarcodeReadEvent` if this property is true. It is true by default.

### `PROPERTY_DATA_PROCESSOR_LAUNCH_EZ_CONFIG`

**Description:** Indicates if scanning bar codes generated by EZ Config for Mobility will launch EZ Config on the mobile computer to apply settings. Aztec bar codes with "ecfg" near the beginning will not cause a `BarcodeReadEvent` if this property is true. It is true by default.
```

--------------------------------

### Enable/Disable Codabar Start/Stop Transmission

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Controls whether the start and stop transmission characters for Codabar barcodes are transmitted. This is a boolean property.

```Java
public static final String PROPERTY_CODABAR_START_STOP_TRANSMIT_ENABLED
```

--------------------------------

### Enable Planet and Postnet with B and B Fields

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables Planet and Postnet modes along with 'B and B fields'. This configuration is used for specific postal data processing requirements.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_PLUS_BNB
```

--------------------------------

### Enable Planet, Postnet, and USPS Modes

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Sets the postal 2D mode to include Planet, Postnet, and USPS. This configuration supports a broad range of postal services.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_POSTNET_AND_USPS
```

--------------------------------

### Telepen Configuration

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables or disables the old-style Telepen functionality.

```APIDOC
## PUT /websites/download_salamandre_tm_fr_api/configuration/telepen

### Description
Enables or disables old-style Telepen.

### Method
PUT

### Endpoint
/websites/download_salamandre_tm_fr_api/configuration/telepen

### Parameters
#### Request Body
- **enabled** (boolean) - Required - Set to true to enable old-style Telepen, false to disable.

### Request Example
{
  "enabled": true
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Old-style Telepen configuration updated successfully."
}
```

--------------------------------

### Get Scanner ID - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the unique identifier for the scan engine. This method is part of the BarcodeReaderInfo class.

```Java
public String getScannerId() {
    // Implementation to retrieve scanner ID
}
```

--------------------------------

### SignatureParameters Constructors

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Provides the default constructor and a parameterized constructor for SignatureParameters. The parameterized constructor allows setting various options for signature extraction, with all measurements relative to the barcode's narrow bar width.

```java
public SignatureParameters()

Constructs a new SignatureParameters object
```

```java
public SignatureParameters(int aspectRatio,
                   int horizontalOffset,
                   int verticalOffset,
                   int width,
                   int height,
                   int resolution,
                   boolean binarized)

Constructs a new SignatureParameters object All measurements are relative to the narrow bar width of the bar code. 

Parameters:
    aspectRatio - the height of the bar code relative to narrow bar width.    horizontalOffset - the horizontal offset of the signature area.    verticalOffset - the vertical offset of the signature area.    width - the width of the signature area    height - the height of the signature area    resolution - the number of pixels per unit in returned image.    binarized - if the image should be converted to white and black pixels.
```

--------------------------------

### Get Scanner Name - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the unique name of the barcode scanner. This method is part of the BarcodeReaderInfo class.

```Java
public String getName() {
    // Implementation to retrieve scanner name
}
```

--------------------------------

### Get Scanner Version Number - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the version number of the scan engine. This method is part of the BarcodeReaderInfo class.

```Java
public String getScannerVersionNumber() {
    // Implementation to retrieve scanner version number
}
```

--------------------------------

### Create and Use AidcManager and BarcodeReader in Android

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

This snippet demonstrates how to create an AidcManager instance using a Context and a CreatedCallback. It then proceeds to create a BarcodeReader object from the manager and includes cleanup logic in onDestroy to close both the reader and the manager, releasing resources.

```java
import com.honeywell.aidc.*;
public class MainActivity extends Activity {
    private AidcManager manager;
    private BarcodeReader reader;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // create the AidcManager providing a Context and an
        // CreatedCallback implementation.
        AidcManager.create(this, new AidcManager.CreatedCallback() {

            @Override
            public void onCreated(AidcManager aidcManager) {
                manager = aidcManager;
                reader = manager.createBarcodeReader();
            }
        });
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        // make sure that AidcManager isn't null
        if (reader != null) {
            // close BarcodeReader to clean up resources.
            // once closed, the object can no longer be used.
            reader.close();
        }
        if (manager != null) {
            // close AidcManager to disconnect from the scanner service.
            // once closed, the object can no longer be used.
            manager.close();
        }
    }
}
```

--------------------------------

### Set Binarized Image Conversion (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Configures whether the image should be converted to black and white pixels. This method takes a boolean parameter: true to binarize, false otherwise.

```java
public void setBinarized(boolean binarized)

```

--------------------------------

### Get Control Logic Version - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the revision number of the control logic. This method is part of the BarcodeReaderInfo class.

```Java
public String getControlLogicVersion() {
    // Implementation to retrieve control logic version
}
```

--------------------------------

### Get Fast Decoder Version - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the revision number of the fast decoder. This method is part of the BarcodeReaderInfo class.

```Java
public String getFastDecodeVersion() {
    // Implementation to retrieve fast decoder version
}
```

--------------------------------

### Enable Postnet and UPU Modes

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Sets the postal 2D mode to enable Postnet and UPU. This is a standard configuration for many postal systems.

```java
public static final String POSTAL_2D_MODE_POSTNET_AND_UPU
```

--------------------------------

### Get Full Decoder Version - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the full version number of the decoder. This method is part of the BarcodeReaderInfo class.

```Java
public String getFullDecodeVersion() {
    // Implementation to retrieve full decoder version
}
```

--------------------------------

### Enable Postnet and UPU with B and B Fields

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables Postnet and UPU modes along with 'B and B fields'. This configuration is used for specific postal data processing scenarios.

```java
public static final String POSTAL_2D_MODE_POSTNET_AND_UPU_PLUS_BNB
```

--------------------------------

### Get Scanner Friendly Name - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the user-friendly name of the barcode scanner. This method is part of the BarcodeReaderInfo class.

```Java
public String getFriendlyName() {
    // Implementation to retrieve friendly scanner name
}
```

--------------------------------

### Configure BarcodeReader for Client Trigger Control (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

This Java code snippet demonstrates how to configure the `BarcodeReader` to enable client-controlled trigger mode. It involves setting the `PROPERTY_TRIGGER_CONTROL_MODE` property to `TRIGGER_CONTROL_MODE_CLIENT_CONTROL` and registering a `BarcodeReader.TriggerListener` to handle trigger events.

```java
import com.honeywell.aidc.*;

public class MainActivity extends Activity implements BarcodeReader.BarcodeListener,
        BarcodeReader.TriggerListener {
    private AidcManager manager;
    private BarcodeReader reader;
    private boolean triggerState = false;

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // create the AidcManager providing a Context and an
        // CreatedCallback implementation.
        AidcManager.create(this, new AidcManager.CreatedCallback() {

            @Override
            public void onCreated(AidcManager aidcManager) {
                manager = aidcManager;
                // use the manager to create a BarcodeReader with a session
                // associated with the internal imager.
                reader = manager.createBarcodeReader();

                try {
                    // apply settings
                    reader.setProperty(BarcodeReader.PROPERTY_CODE_39_ENABLED, false);
                    reader.setProperty(BarcodeReader.PROPERTY_DATAMATRIX_ENABLED, true);

                    // set the trigger mode to client control
                    reader.setProperty(BarcodeReader.PROPERTY_TRIGGER_CONTROL_MODE,
                        BarcodeReader.TRIGGER_CONTROL_MODE_CLIENT_CONTROL);
                } catch (UnsupportedPropertyException e) {
                    Toast.makeText(MainActivity.this, "Failed to apply properties",
                        Toast.LENGTH_SHORT).show();
                }

                // register bar code event listener
                reader.addBarcodeListener(MainActivity.this);

                // register trigger state change listener
                reader.addTriggerListener(MainActivity.this);
            }
        });
    }

    @Override
    public void onResume() {
        super.onResume();
        if (reader != null) {
            try {
                reader.claim();
            } catch (ScannerUnavailableException e) {
                e.printStackTrace();
                Toast.makeText(this, "Scanner unavailable", Toast.LENGTH_SHORT).show();
            }
        }
    }

    @Override
    public void onPause() {
        super.onPause();
        if (reader != null) {
            // release the scanner claim so we don't get any scanner
            // notifications while paused.
            reader.release();
        }
    }

    @Override
    public void onDestroy() {
        super.onDestroy();
        if (reader != null) {
            // unregister barcode event listener
            reader.removeBarcodeListener(this);

            // unregister trigger state change listener
            reader.removeTriggerListener(this);

            // close BarcodeReader to clean up resources.
            // once closed, the object can no longer be used.
            reader.close();
        }
        if (manager != null) {
            // close AidcManager to disconnect from the scanner service.
            // once closed, the object can no longer be used.
            manager.close();
        }
    }

    @Override
    public void onBarcodeEvent(final BarcodeReadEvent event) {
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                String barcodeData = event.getBarcodeData();
                String timestamp = event.getTimestamp();

                // update UI to reflect the data
            }
        });

        // reset the trigger state
        triggerState = false;
    }

    @Override
    public void onFailureEvent(final BarcodeFailureEvent event) {
        runOnUiThread(new Runnable() {
            @Override
            public void run() {
                Toast.makeText(MainActivity.this, "Barcode read failed",
                    Toast.LENGTH_SHORT).show();
            }
        });
    }

    // these events can be used to implement custom trigger modes if the automatic
    // behavior provided by the scanner service is insufficient for your application.
    // the following code demonstrates a "toggle" mode implementation, where the state
    // of the scanner changes each time the scan trigger is pressed.
    @Override
    public void onTriggerEvent(TriggerStateChangeEvent event) {
        try {
            // only handle trigger presses

```

--------------------------------

### Get Timestamp Method - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeFailureEvent

Retrieves the date/time when the BarcodeFailureEvent occurred in ISO 8601 format. This method is part of the BarcodeFailureEvent class.

```java
public
String getTimestamp()
```

--------------------------------

### Enable Planet, UPU, and USPS Modes

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Configures the postal 2D mode for Planet, UPU, and USPS. This setting is useful for international and domestic postal services.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_UPU_AND_USPS
```

--------------------------------

### Trioptic Configuration

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables or disables the Trioptic functionality.

```APIDOC
## PUT /websites/download_salamandre_tm_fr_api/configuration/trioptic

### Description
Enables or disables Trioptic.

### Method
PUT

### Endpoint
/websites/download_salamandre_tm_fr_api/configuration/trioptic

### Parameters
#### Request Body
- **enabled** (boolean) - Required - Set to true to enable Trioptic, false to disable.

### Request Example
{
  "enabled": true
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "Trioptic configuration updated successfully."
}
```

--------------------------------

### Signature Parameters

Source: https://download.salamandre.tm.fr/api/index-all

Methods for configuring parameters to extract a signature from an image after a barcode scan.

```APIDOC
## Signature Parameters

### `SignatureParameters` Class

- **Description**: Options to specify for extracting a signature from an image after a successful barcode scan.

### Constructors

- **`SignatureParameters()`**
  - **Description**: Constructs a new `SignatureParameters` object.

- **`SignatureParameters(int aspectRatio, int height, int horizontalOffset, int resolution, int verticalOffset, int width, boolean binarized)`**
  - **Description**: Constructs a new `SignatureParameters` object. All measurements are relative to the narrow bar width of the barcode.

### Methods

- **`setAspectRatio(int aspectRatio)`**
  - **Description**: Sets the height of the barcode relative to the narrow bar width.

- **`setBinarized(boolean binarized)`**
  - **Description**: Sets whether the image should be converted to black and white pixels.

- **`setHeight(int height)`**
  - **Description**: Sets the height of the signature area.

- **`setHorizontalOffset(int horizontalOffset)`**
  - **Description**: Sets the horizontal offset of the signature area.

- **`setResolution(int resolution)`**
  - **Description**: Sets the number of pixels per unit in the returned image.

- **`setVerticalOffset(int verticalOffset)`**
  - **Description**: Sets the vertical offset of the signature area.

- **`setWidth(int width)`**
  - **Description**: Sets the width of the signature area.
```

--------------------------------

### Get Frame Width - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the width of the scan engine's frame in pixels. This method is part of the BarcodeReaderInfo class.

```Java
public int getFrameWidth() {
    // Implementation to retrieve frame width
}
```

--------------------------------

### Get Frame Height - Java

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReaderInfo

Retrieves the height of the scan engine's frame in pixels. This method is part of the BarcodeReaderInfo class.

```Java
public int getFrameHeight() {
    // Implementation to retrieve frame height
}
```

--------------------------------

### BarcodeReader Methods and Properties

Source: https://download.salamandre.tm.fr/api/index-all

Methods and properties for interacting with the BarcodeReader, including setting properties, triggering scans, and managing property editors.

```APIDOC
## BarcodeReader Methods and Properties

### `BarcodeReader` Class

### Methods

- **`setProperties(Map<String, Object> properties)`**
  - **Description**: Sets a map of properties for the BarcodeReader.

- **`setProperty(String name, int value)`**
  - **Description**: Sets an integer property.

- **`setProperty(String name, boolean value)`**
  - **Description**: Sets a boolean property.

- **`setProperty(String name, String value)`**
  - **Description**: Sets a string or enum property.

- **`softwareTrigger(boolean state)`**
  - **Description**: Sends a trigger up/down action.

- **`startPropertyEditor(Context context)`**
  - **Description**: Starts a settings activity to configure the properties of this `BarcodeReader`.

- **`startPropertyEditor(Context context, String packageName, String activityName)`**
  - **Description**: Starts a settings activity to configure the properties of this `BarcodeReader` with a specific package and activity.

- **`writeToParcel(Parcel dest, int flags)`**
  - **Description**: Writes the BarcodeReader object to a Parcel.

### Static Variables

- **`TRIGGER_CONTROL_MODE_AUTO_CONTROL`**
  - **Description**: Represents automatic trigger control mode.

- **`TRIGGER_CONTROL_MODE_CLIENT_CONTROL`**
  - **Description**: Represents client-controlled trigger mode.

- **`TRIGGER_CONTROL_MODE_DISABLE`**
  - **Description**: Represents disabled trigger mode.
```

--------------------------------

### Center Decode and Scan Window Constants

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Constants for controlling the scanning area. PROPERTY_CENTER_DECODE enables scanning only near the aimer center. PROPERTY_DECODE_WINDOW_* constants allow customization of the scan window's boundaries.

```java
public static final String PROPERTY_CENTER_DECODE
```

```java
public static final String PROPERTY_DECODE_WINDOW_TOP
```

```java
public static final String PROPERTY_DECODE_WINDOW_BOTTOM
```

```java
public static final String PROPERTY_DECODE_WINDOW_LEFT
```

```java
public static final String PROPERTY_DECODE_WINDOW_RIGHT
```

--------------------------------

### Barcode Device Event Listeners

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/AidcManager

APIs for managing listeners that are notified when barcode devices are connected or disconnected.

```APIDOC
## POST /websites/download_salamandre_tm_fr_api/AidcManager/addBarcodeDeviceListener

### Description
Registers a callback to be invoked when the list of barcode devices changes (connected or disconnected).

### Method
POST

### Endpoint
/websites/download_salamandre_tm_fr_api/AidcManager/addBarcodeDeviceListener

### Parameters
#### Request Body
- **listener** (AidcManager.BarcodeDeviceListener) - Required - The callback to register.

### Request Example
```json
{
  "listener": "YourBarcodeDeviceListenerImplementation"
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message that the listener has been added.

#### Response Example
```json
{
  "message": "BarcodeDeviceListener added successfully."
}
```

## DELETE /websites/download_salamandre_tm_fr_api/AidcManager/removeBarcodeDeviceListener

### Description
Unregisters a previously registered barcode device change callback.

### Method
DELETE

### Endpoint
/websites/download_salamandre_tm_fr_api/AidcManager/removeBarcodeDeviceListener

### Parameters
#### Request Body
- **listener** (AidcManager.BarcodeDeviceListener) - Required - The callback to unregister.

### Request Example
```json
{
  "listener": "YourBarcodeDeviceListenerImplementation"
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message that the listener has been removed.

#### Response Example
```json
{
  "message": "BarcodeDeviceListener removed successfully."
}
```
```

--------------------------------

### Get Signature Area Resolution (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Retrieves the current resolution of the signature area, indicating pixels per unit. This method returns an integer.

```java
public int getResolution()

```

--------------------------------

### MSI Checksum Modes

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Details the specific checksum modes available for MSI barcodes, including options with and without checksum stripping.

```APIDOC
## MSI Checksum Modes

### Description
Provides details on the various checksum checking strategies supported for MSI barcodes.

### Method
GET (assumed for retrieving available modes)

### Endpoint
/config/barcode/msi/checksum/modes

### Parameters
None

### Request Example
(No request body for GET)

### Response
#### Success Response (200)
- **modes** (array of strings) - A list of supported MSI checksum modes.

#### Response Example
```json
{
  "modes": [
    "NO_CHECK",
    "SINGLE_MOD_10_CHECK",
    "SINGLE_MOD_11_PLUS_MOD_10_CHECK",
    "DOUBLE_MOD_10_CHECK",
    "SINGLE_MOD_10_CHECK_AND_STRIP",
    "SINGLE_MOD_11_PLUS_MOD_10_CHECK_AND_STRIP",
    "DOUBLE_MOD_10_CHECK_AND_STRIP"
  ]
}
```
```

--------------------------------

### Get Signature Area Height (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Retrieves the current height of the signature area. This method does not take any parameters and returns an integer representing the height.

```java
public int getHeight()

```

--------------------------------

### Get Signature Area Width (Java)

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/SignatureParameters

Retrieves the current width of the signature area. This method does not take any parameters and returns an integer representing the width.

```java
public int getWidth()

```

--------------------------------

### TLC 39 Configuration

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables or disables the TLC 39 functionality.

```APIDOC
## PUT /websites/download_salamandre_tm_fr_api/configuration/tlc39

### Description
Enables or disables TLC 39.

### Method
PUT

### Endpoint
/websites/download_salamandre_tm_fr_api/configuration/tlc39

### Parameters
#### Request Body
- **enabled** (boolean) - Required - Set to true to enable TLC 39, false to disable.

### Request Example
{
  "enabled": true
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
{
  "message": "TLC 39 configuration updated successfully."
}
```

--------------------------------

### Enable Planet, UPU, and USPS with B and B Fields

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Enables Planet, UPU, and USPS modes along with 'B and B fields'. This configuration is designed for advanced postal data handling.

```java
public static final String POSTAL_2D_MODE_PLANET_AND_UPU_AND_USPS_PLUS_BNB
```

--------------------------------

### Enable Postnet and USPS Modes

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeReader

Configures the postal 2D mode to support Postnet and USPS. This setting is common for domestic postal services.

```java
public static final String POSTAL_2D_MODE_POSTNET_AND_USPS
```

--------------------------------

### Get Barcode Reader Info Method

Source: https://download.salamandre.tm.fr/api/com/honeywell/aidc/BarcodeDeviceConnectionEvent

Retrieves the BarcodeReaderInfo object associated with the barcode device event. This method returns details about the connected or disconnected device.

```java
public BarcodeReaderInfo getBarcodeReaderInfo()

Retrieves the BarcodeReaderInfo Object 

Returns:
    BarcodeReaderInfo of the device connected or disconnected
```