### POST /rfid/config/dyn-start-q Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Sets the starting Q value for each of the dynamic RF Modes. ```APIDOC ## POST /rfid/config/dyn-start-q ### Description Sets Starting Q value in each of the dynamic RF Modes. ### Method POST ### Endpoint `/rfid/config/dyn-start-q` ### Parameters #### Request Body - **qValue** (int) - Required - The starting Q value. ### Request Example ```json { "qValue": 10 } ``` ### Response #### Success Response (200) - **status** (string) - "success" - **message** (string) - "Starting Q value for dynamic RF modes set successfully." #### Response Example ```json { "status": "success", "message": "Starting Q value for dynamic RF modes set successfully." } ``` ``` -------------------------------- ### RF_GetSingulationControl Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Gets the singulation value of the RFID radio module, representing the starting Q value. ```APIDOC ## RF_GetSingulationControl ### Description Gets the singulation value of the RFID radio module, which represents the starting Q value for inventory operations. ### Method `public int RF_GetSingulationControl()` ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "request": null } ``` ### Response #### Success Response - **Return Value** (int) - The current singulation value. Valid values range from 0 (MIN_SINGULATION) to 15 (MAX_SINGULATION). #### Response Example ```json { "returnValue": 5 } ``` **Error Codes**: - `SDConsts.RFSingulation.OTHER_CMD_RUNNING_ERROR` (-4): Command is already running. - `SDConsts.RFSingulation.SD_NOT_CONNECTED` (-5): Device is not connected. - `SDConsts.RFSingulation.READER_OR_COM_INTERFACE_STATUS_ERROR` (-7): Reader or COM interface status error. ``` -------------------------------- ### SD_StartLogTrace Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Starts the log tracing functionality. This API is supported only on specific A10 model devices. ```APIDOC ## SD_StartLogTrace ### Description Starts the log tracing functionality. This API is currently only supported on specific A10 model devices. If called on an unsupported device, it returns false. ### Method POST (Implied, as it's an SDK method call) ### Endpoint N/A (SDK Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java // Example usage within an Android application // Assuming 'sledCommunicationManager' is an instance of the relevant interface bool started = sledCommunicationManager.SD_StartLogTrace(); ``` ### Response #### Success Response (boolean) - **True** - Indicates that log tracing was successfully started. #### Failure Response (boolean) - **False** - Indicates that log tracing failed to start or the device is unsupported. ### Response Example ```java boolean started = sledCommunicationManager.SD_StartLogTrace(); if (started) { // Log tracing started } else { // Log tracing failed or device not supported } ``` ``` -------------------------------- ### RF_GetDYNStartQ Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Retrieves the starting Q value for each dynamic RF Mode. ```APIDOC ## RF_GetDYNStartQ ### Description Gets Starting Q value in each of the dynamic RF Modes. ### Method GET ### Endpoint /api/rfid/dynStartQ ### Response #### Success Response (200) - **startQValues** (int) - The starting Q values for dynamic RF Modes. ``` -------------------------------- ### ISledConfig - Get Boot Loader Version Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Retrieves the version of the SLED boot loader. ```APIDOC ## GET /sled/bootloader/version ### Description Retrieves the version of the SLED boot loader. ### Method GET ### Endpoint /sled/bootloader/version ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **version** (string) - The version of the SLED boot loader. #### Response Example ```json { "version": "1.2.3" } ``` #### Error Responses - **SDConsts.SDResult.OTHER_CMD_RUNNING_ERROR** (-4): Serial Error or Command State Error. - **SDConsts.SDResult.READER_OR_COM_INTERFACE_STATUS_ERROR** (-7): Condition Error. - **"Error"**: Connected Error. - **SDConsts.SDResult.NOT_SUPPORTED_API_STR**: Not Supported Error. ``` -------------------------------- ### Singulation Control Functions Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/IRfidConfig.html Functions for getting and setting singulation control parameters. ```APIDOC ## RF_GetSingulationControl ### Description Gets the singulation value of RFID radio module. ### Method GET ### Endpoint /RF_GetSingulationControl ### Parameters None ### Response #### Success Response - **Execution result value** (int) - The detailed values are described in the implementation section. #### Response Example ```json { "result_value": 1 } ``` ``` ```APIDOC ## RF_GetMinSingulationControl ### Description Gets minimum singulation value of RFID radio module. ### Method GET ### Endpoint /RF_GetMinSingulationControl ### Parameters None ### Response #### Success Response - **Execution result value** (int) - The detailed values are described in the implementation section. #### Response Example ```json { "result_value": 0 } ``` ``` ```APIDOC ## RF_GetMaxSingulationControl ### Description Gets the maximum singulation value of RFID radio module. ### Method GET ### Endpoint /RF_GetMaxSingulationControl ### Parameters None ### Response #### Success Response - **Execution result value** (int) - The detailed values are described in the implementation section. #### Response Example ```json { "result_value": 100 } ``` ``` ```APIDOC ## RF_SetSingulationControl ### Description Sets the singulation control value for the RFID radio module. ### Method POST ### Endpoint /RF_SetSingulationControl ### Parameters #### Request Body - **value** (int) - Required - The desired singulation control value. ### Request Example ```json { "value": 50 } ``` ### Response #### Success Response - **Success** (int) - Indicates the result of the operation. Specific values detailed in implementation. #### Response Example ```json { "Success": 0 } ``` ``` -------------------------------- ### Barcode Preset Value API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/index-files/index-19.html Methods to get the preset values for barcode scanning, including prefix, suffix, preamble, and postamble. ```APIDOC ## GET /api/sled/barcode/preset/{type} ### Description Gets the preset values (prefix, suffix, preamble, postamble) for barcode scanning. ### Method GET ### Endpoint /api/sled/barcode/preset/{type} ### Parameters #### Path Parameters - **type** (int) - Required - The type of preset value to retrieve. (e.g., 1 for prefix, 2 for suffix, etc.) ### Response #### Success Response (200) - **value** (string) - The retrieved preset value. #### Response Example ```json { "value": "12345" } ``` ``` -------------------------------- ### writeLBTOemRegInit Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/RFOemRegUtils.html Initializes LBT settings for OEM registration. ```APIDOC ## writeLBTOemRegInit ### Description Initializes Listen Before Talk (LBT) settings for the OEM registration process. ### Method GET (or appropriate method based on context) ### Endpoint /oemReg/lbtInit ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **success** (boolean) - Indicates if the operation was successful. #### Response Example ```json { "success": true } ``` ``` -------------------------------- ### Get Dynamic RF Mode Sequence (Java) Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Retrieves the sequence of RF Modes used in the dynamic RF Mode sequence. Requires BLUETOOTH permission. Returns the starting Q value or an error code if Bluetooth is not enabled, not connected, or another command is running. ```java @RequiresPermission("android.permission.BLUETOOTH") public int RF_GetDYNModeSquence() Gets the sequence of RF Modes that are used in the dynamic RF Mode sequence value. Specified by: `[RF_GetDYNModeSquence](IRfidConfig.html#RF_GetDYNModeSquence())` in interface `[IRfidConfig](IRfidConfig.html "interface in co.kr.bluebird.sled")` Returns: Success : Starting Q value in each of the dynamic RF Modes. Enabled Error : SDConsts.RFResult.BLUETOOTH_NOT_ENABLED = -15 Connected Error : SDConsts.RFResult.SD_NOT_CONNECTED = -5 Block State Error : SDConsts.RFResult.OTHER_CMD_RUNNING_ERROR = -4 Condition Error : SDConsts.RFResult.READER_OR_COM_INTERFACE_STATUS_ERROR = -7 Command State Error : SDConsts.RFResult.OTHER_CMD_RUNNING_ERROR = -4 Hotswap Error : SDConsts.RFResult.ERROR_HOTSWAP_STATE = -37 * Can receive other error constant of "RFResult" class. ``` -------------------------------- ### SelectionCriterias.Criteria Get Methods Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SelectionCriterias.Criteria.html Provides methods to retrieve various attributes of the Criteria object, including memory type, action, mask, mask length, start position, and bit count. These methods allow external access to the selection criteria's configuration. ```java protected final int getAction() protected final int getBank() protected short getBitcnt() protected final int getBitptr() protected final String getMask() final int getSelectAction() final String getSelectMask() final int getSelectMaskLengthBit() final int getSelectMemType() final short getSelectStartPosByte() protected short getSelEndbit() ``` -------------------------------- ### RFPower Constructor Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.RFPower.html Details about the RFPower constructor. ```APIDOC ## RFPower Constructor ### Description Initializes a new instance of the RFPower class. ### Method POST ### Endpoint `/api/rfpower` ### Request Body This constructor does not take any parameters. ### Response #### Success Response (201) - **message** (string) - Indicates successful initialization. #### Response Example ```json { "message": "RFPower instance created successfully." } ``` ``` -------------------------------- ### ISledConfig - Get Trigger Mode Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Gets the trigger mode of the SLED. ```APIDOC ## GET /sled/trigger/mode ### Description Gets the trigger mode of the SLED. ### Method GET ### Endpoint /sled/trigger/mode ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **mode** (integer) - The trigger mode (0: RFID, 1: BARCODE). #### Response Example ```json { "mode": 0 } ``` #### Error Responses - **SDConsts.SDTriggerMode.OTHER_CMD_RUNNING_ERROR** (-4): Serial Error or Command State Error. - **SDConsts.SDTriggerMode.READER_OR_COM_INTERFACE_STATUS_ERROR** (-7): Condition Error. - **SDConsts.SDTriggerMode.SD_NOT_CONNECTED** (-5): Connected Error. ``` -------------------------------- ### Initialize BTState Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.BTState.html This snippet shows the basic constructor for the BTState class, used for managing Bluetooth states within the Bluebird RFID system. No specific dependencies are noted for this constructor. ```java public BTState() ``` -------------------------------- ### SDConsts.RFHopping Class Documentation Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.RFHopping.html This section provides details about the SDConsts.RFHopping class, its fields, and constructors. It is part of the co.kr.bluebird.sled package. ```APIDOC ## Class SDConsts.RFHopping ### Description This class, nested within SDConsts, defines constants related to RF hopping functionality. ### Enclosing Class `co.kr.bluebird.sled.SDConsts` ### Fields #### Field Summary - **OFF** (int) - Represents the off state for RF hopping. - **ON** (int) - Represents the on state for RF hopping. ### Constructor Summary - **RFHopping()** - Protected constructor for the RFHopping class. ### Field Details #### OFF - **Modifier:** `protected static final` - **Type:** `int` - **Description:** Constant representing the 'off' state. #### ON - **Modifier:** `protected static final` - **Type:** `int` - **Description:** Constant representing the 'on' state. ### Constructor Details #### RFHopping - **Modifier:** `protected` - **Description:** Initializes a new instance of the RFHopping class. ``` -------------------------------- ### ISledConfig - Get Battery Status Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Gets the battery status value of the SLED. ```APIDOC ## GET /sled/battery/status ### Description Gets the battery status value of the SLED. ### Method GET ### Endpoint /sled/battery/status ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **status** (integer) - The battery status value (0-100). #### Response Example ```json { "status": 85 } ``` #### Error Responses - **SDConsts.SDBatteryState.OTHER_CMD_RUNNING_ERROR** (-4): Serial Error or Command State Error. - **SDConsts.SDBatteryState.READER_OR_COM_INTERFACE_STATUS_ERROR** (-7): Condition Error. - **SDConsts.SDBatteryState.SD_NOT_CONNECTED** (-5): Connected Error. ``` -------------------------------- ### GET /SB_GetBarcodePresetValue Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Retrieves preset data for barcode prefixes, suffixes, preambles, or postambles. Use this to get the currently configured preset values. ```APIDOC ## GET /SB_GetBarcodePresetValue ### Description Gets the preset (prefix, suffix, preamble, postamble) data. ### Method GET ### Endpoint /SB_GetBarcodePresetValue ### Parameters #### Query Parameters - **SBPresetType** (integer) - Required - Specifies the type of preset data to retrieve. Valid values are 0 (PREFIX), 1 (SUFFIX), 2 (PREAMBLE), 3 (POSTAMBLE). ### Request Example ``` GET / ?SBPresetType=0 ``` ### Response #### Success Response (200) - **presetData** (string) - The data for the requested barcode preset type. ``` -------------------------------- ### Java: Create Generic Info File Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/FileUtil.html Creates a generic information file. This method accepts a string containing the information to be written to the file and returns a boolean status of the operation. ```java protected static final boolean makeInfoFile(String info) ``` -------------------------------- ### SD_StartLogTrace Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Starts log tracing. This API is currently supported only on specific A10 model devices. Calling it on unsupported devices will return false. ```APIDOC ## SD_StartLogTrace ### Description Starts log tracing. This API is currently supported only on specific A10 model devices. Calling it on an unsupported device will return false. ### Method POST ### Endpoint /api/sd/logtrace/start ### Response #### Success Response (200) - **success** (boolean) - True if log tracing was started successfully, False otherwise. #### Response Example ```json { "success": true } ``` ``` -------------------------------- ### Start Bluetooth Scan Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Initiates a Bluetooth scan for devices. This method requires BLUETOOTH and BLUETOOTH_ADMIN permissions. Note that the scan will not function if Bluetooth is currently connected. It returns true on success and false if the scan cannot be started. ```java @RequiresPermission(allOf={"android.permission.BLUETOOTH","android.permission.BLUETOOTH_ADMIN"}) public boolean BT_StartScan() ``` -------------------------------- ### SD_GetAttachStatus Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Gets the attach status of the RFID device. ```APIDOC ## SD_GetAttachStatus ### Description Gets the attach status of the RFID device. ### Method GET ### Endpoint /api/status/attach ### Parameters #### Query Parameters - **ctx** (android.content.Context) - Required - The Android context. ### Response #### Success Response (200) - **status** (int) - The attach status of the device. (e.g., 0 for attached, other values for not attached or error) #### Response Example ```json { "status": 0 } ``` ``` -------------------------------- ### SDConsts.SDHotswapState Constructor Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.SDHotswapState.html Information about the constructor for the SDConsts.SDHotswapState class. ```APIDOC ## SDConsts.SDHotswapState Constructor ### Description This section provides details about the constructor for the SDConsts.SDHotswapState class. ### Method `SDHotswapState()` ### Parameters None ### Request Example ```json { "example": "No request body for constructor." } ``` ### Response #### Success Response (200) - **Instance** (SDConsts.SDHotswapState) - An instance of the SDHotswapState class. ``` -------------------------------- ### Connection Management Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/index-files/index-19.html APIs for establishing and terminating connections with the SLED device. ```APIDOC ## Connect to SLED ### Description Connects to the SLED device. This operation should be performed after receiving a wake-up callback message (SLED_WAKEUP(47)). ### Method Various methods available depending on the interface used (e.g., ISerialManager, Reader). ### Endpoint N/A (Method Call) ### Parameters None ### Request Example ```java // Example for ISerialManager ISerialManager sledManager = ...; sledManager.SD_Connect(); // Example for Reader Reader reader = ...; reader.SD_Connect(); ``` ### Response None explicitly defined, operation success is implied. ## Disconnect from SLED ### Description Disconnects from the SLED device, closing all opened communications and unregistering features. This method must be called when closing the application if SD_Open was previously called, to prevent malfunctions. ### Method Various methods available depending on the interface used (e.g., ISerialManager, Reader). ### Endpoint N/A (Method Call) ### Parameters None ### Request Example ```java // Example for ISerialManager ISerialManager sledManager = ...; sledManager.SD_Disconnect(); // Example for Reader Reader reader = ...; reader.SD_Disconnect(); ``` ### Response None explicitly defined, operation success is implied. ``` -------------------------------- ### SD_GetOpenStatus Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Gets the open status of the RFID device. ```APIDOC ## SD_GetOpenStatus ### Description Gets the open status of the RFID device. ### Method GET ### Endpoint /api/status/open ### Parameters #### Query Parameters - **ctx** (android.content.Context) - Required - The Android context. ### Response #### Success Response (200) - **status** (int) - The open status of the device. (e.g., 0 for open, other values for closed or error) #### Response Example ```json { "status": 0 } ``` ``` -------------------------------- ### RFID Configuration Methods Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/IRfidConfig.html This section provides details on various methods for configuring and querying the RFID module's settings and capabilities. ```APIDOC ## IRfidConfig Interface ### Description Interface definition for RFID configuration. ### Methods #### RF_checkRegionISO **Description:** Gets result that compare current Region and param. **Method:** `RF_checkRegionISO(String nation)` **Parameters:** * **nation** (String) - Required - The region to compare against. **Response:** * **Success Response (200):** * boolean - True if the current region matches the provided nation, false otherwise. #### RF_GetAccessTimeout **Description:** Gets the timeout value of access APIs. **Method:** `RF_GetAccessTimeout()` **Response:** * **Success Response (200):** * int - The timeout value in milliseconds. #### RF_GetAvailableRegionAtThisDevice **Description:** Gets the available region value at this sled device. **Method:** `RF_GetAvailableRegionAtThisDevice()` **Response:** * **Success Response (200):** * String - A comma-separated string of available regions. #### RF_GetDefaultChannels **Description:** Gets enabled default selected region channel table. **Method:** `RF_GetDefaultChannels()` **Response:** * **Success Response (200):** * String[] - An array of default enabled channels. #### RF_GetDutyCycle **Description:** Gets the duty cycle value of the RFID radio module. **Method:** `RF_GetDutyCycle()` **Response:** * **Success Response (200):** * int - The duty cycle value. #### RF_GetDwelltime **Description:** Gets the dwell time (50 ~ 400, 200(default)) of the RFID radio module. **Method:** `RF_GetDwelltime()` **Response:** * **Success Response (200):** * int - The dwell time value. #### RF_GetDYNModeMinMaxMode **Description:** Gets the minimum/maximum Q value for each of the RF Modes in the sequence. **Method:** `RF_GetDYNModeMinMaxMode()` **Response:** * **Success Response (200):** * int - The minimum/maximum Q value. #### RF_GetDYNModeSquence **Description:** Gets the sequence of RF Modes that are used in the dynamic RF Mode sequence value. **Method:** `RF_GetDYNModeSquence()` **Response:** * **Success Response (200):** * int - The sequence of RF Modes. #### RF_GetDYNRFMode **Description:** Gets Dynamic mode behavior. **Method:** `RF_GetDYNRFMode()` **Response:** * **Success Response (200):** * int - The dynamic mode behavior value. #### RF_GetDYNStartQ **Description:** Gets Starting Q value in each of the dynamic RF Modes. **Method:** `RF_GetDYNStartQ()` **Response:** * **Success Response (200):** * int - The starting Q value. #### RF_GetEnableChannels **Description:** Gets enabled channel. **Method:** `RF_GetEnableChannels()` **Response:** * **Success Response (200):** * String[] - An array of enabled channels. #### RF_GetInventorySessionTarget **Description:** Gets inventory session target of RFID radio module. **Method:** `RF_GetInventorySessionTarget()` **Response:** * **Success Response (200):** * int - The inventory session target value. #### RF_GetINVTimeout **Description:** Gets the timeout value of inventory APIs for the RFID radio module. **Method:** `RF_GetINVTimeout()` **Response:** * **Success Response (200):** * int - The inventory timeout value in milliseconds. #### RF_GetLBTSValue **Description:** Updates the Dynamic Profile for EU device. Do update unconditionally. (In case of this API, Run time during about 90 seconds is required.) **Method:** `RF_GetLBTSValue()` **Response:** * **Success Response (200):** * int - An integer indicating the status of the update. #### RF_GetLibVersion **Description:** Gets the version information of the SLED library(jar). **Method:** `RF_GetLibVersion()` **Response:** * **Success Response (200):** * String - The version string of the SLED library. #### RF_GetMaxSingulationControl **Description:** Gets the maximum singulation value of RFID radio module. **Method:** `RF_GetMaxSingulationControl()` **Response:** * **Success Response (200):** * int - The maximum singulation control value. #### RF_GetMinSingulationControl **Description:** Gets minimum singulation value of RFID radio module. **Method:** `RF_GetMinSingulationControl()` **Response:** * **Success Response (200):** * int - The minimum singulation control value. #### RF_GetRadioPowerState **Description:** Gets the power state value of the RFID radio module. **Method:** `RF_GetRadioPowerState()` **Response:** * **Success Response (200):** * int - The radio power state value. #### RF_GetRegion **Description:** Gets the region value of RFID radio module (ETSI, FCC, etc). **Method:** `RF_GetRegion()` **Response:** * **Success Response (200):** * int - The region value code. #### RF_GetRFIDProtocolType **Description:** Get enabled protocol's type. **Method:** `RF_GetRFIDProtocolType()` **Response:** * **Success Response (200):** * int - The RFID protocol type code. ``` -------------------------------- ### SD_GetChargeState API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Gets the current charge state of the SLED. ```APIDOC ## GET /api/sled/charge/state ### Description Gets the charge state of the SLED. ### Method GET ### Endpoint /api/sled/charge/state ### Response #### Success Response (200) - **chargeState** (int) - Value representing the charge state of the SLED. #### Response Example { "chargeState": 1 } ``` -------------------------------- ### RF_GetRFIDVersion Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/IRfidConfig.html Gets the version information of the RFID radio module. ```APIDOC ## RF_GetRFIDVersion ### Description Gets the version of the RFID radio module. ### Method GET ### Endpoint /rfid/version ### Response #### Success Response (200) - **rfidVersion** (string) - The version string of the RFID radio module. ### Response Example ```json { "rfidVersion": "1.2.3" } ``` ``` -------------------------------- ### Constructor Details: SDBatteryState Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.SDBatteryState.html Details for the SDBatteryState constructor. ```APIDOC ## Constructor Details: SDBatteryState ### Description Constructor for the SDBatteryState class. ### Method N/A ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (200) - **SDBatteryState** (object) - An instance of SDBatteryState. #### Response Example ```json { "instance": "" } ``` ``` -------------------------------- ### RF_GetAccessTimeout API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/index-files/index-18.html Gets the timeout value for access APIs. ```APIDOC ## RF_GetAccessTimeout API ### Description Gets the timeout value for access APIs. ### Method GET ### Endpoint /rfid/access/timeout ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ``` /rfid/access/timeout ``` ### Response #### Success Response (200) - **timeoutValue** (Integer) - The current timeout value in milliseconds. #### Response Example ```json { "timeoutValue": 5000 } ``` ``` -------------------------------- ### Sound Control API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/ISoundController.html This section details the methods available in the ISoundController interface for managing sound settings. ```APIDOC ## SC_SetSoundState ### Description Sets the Inventory Sound State. ### Method POST ### Endpoint /sound/state ### Parameters #### Query Parameters - **soundState** (boolean) - Required - True : Enabled, False : Disabled ### Request Example ```json { "soundState": true } ``` ### Response #### Success Response (200) - **resultCode** (int) - Execution result value. (The detailed values are described in the implementation section.) #### Response Example ```json { "resultCode": 0 } ``` ## SC_SetSoundVolume ### Description Sets the Inventory Sound Volume. ### Method POST ### Endpoint /sound/volume ### Parameters #### Query Parameters - **level** (int) - Required - 0 : Low, 1 : Med, 2: High, default: Mid ### Request Example ```json { "level": 1 } ``` ### Response #### Success Response (200) - **resultCode** (int) - Execution result value. (The detailed values are described in the implementation section.) #### Response Example ```json { "resultCode": 0 } ``` ``` -------------------------------- ### RF_GetInventorySessionTarget Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/IRfidConfig.html Gets the inventory session target of the RFID radio module. ```APIDOC ## RF_GetInventorySessionTarget ### Description Gets the inventory session target of the RFID radio module. ### Method GET ### Endpoint /rfid/inventory/target ### Response #### Success Response (200) - **target** (integer) - The current inventory session target. ### Response Example ```json { "target": 1 } ``` ``` -------------------------------- ### SDConsts.RFPower Class Documentation Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.RFPower.html This section details the SDConsts.RFPower class, its fields, constructors, and inherited methods. ```APIDOC ## SDConsts.RFPower Class ### Description RF Power values. ### Class Hierarchy `java.lang.Object` `co.kr.bluebird.sled.SDConsts.RFCommonResult` `co.kr.bluebird.sled.SDConsts.RFPower` ### Enclosing Class `SDConsts` ### Fields #### Field Summary * `static final int MAX_POWER`: Represents the maximum RF power value. * `static final int MIN_POWER`: Represents the minimum RF power value. #### Fields Inherited from `co.kr.bluebird.sled.SDConsts.RFCommonResult` * `ACCESS_TIMEOUT` * `ALREADY_CONNECTED` * `ALREADY_DISCONNECTED` * `ALREADY_OPENED` * `ARGUMENT_ERROR` * `BLUETOOTH_NOT_ENABLED` * `CHARGING_STATE_ERROR` * `COMMUNICATION_ERROR` * `DUP_CMD_ERROR` * `E710_ERROR_BUSY` * `E710_ERROR_ENCODING_BUFFER_FULL` * `E710_ERROR_ENCODING_STATE` * `E710_ERROR_ENCODING_WORDCOUNT_OVERRUN` * `E710_ERROR_HOTSWAP` * `E710_ERROR_INVAILD_PARAM` * `E710_ERROR_NOT_READY` * `E710_ERROR_UNKOWN_CODE` * `E710_ERROR_UPDATE_CHECKSUM` * `ERROR_HOTSWAP_STATE` * `FILE_IS_NOT_EXIST` * `LOW_BATTERY` * `MODE_ERROR` * `NOT_INVENTORY_STATE` * `NOT_SUPPORTED_API` * `OTHER_CMD_RUNNING_ERROR` * `OTHER_ERROR` * `OTHER_MODEL` * `READER_OR_COM_INTERFACE_STATUS_ERROR` * `SD_NOT_CONNECTED` * `STOP_FAILED_TRY_AGAIN` ### Constructors #### Constructor Summary * `RFPower()`: Constructs an instance of `SDConsts.RFPower`. ### Methods #### Methods Inherited from `java.lang.Object` * `clone()` * `equals(Object obj)` * `finalize()` * `getClass()` * `hashCode()` * `notify()` * `notifyAll()` * `toString()` * `wait()` * `wait(long timeout)` * `wait(long timeout, int nanos)` ``` -------------------------------- ### RF_GetSelection Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/IRfidConfig.html Gets the current selection values of the RFID radio module. ```APIDOC ## RF_GetSelection ### Description Gets the selection values of the RFID radio module. ### Method GET ### Endpoint /rfid/selection ### Response #### Success Response (200) - **selectionCriteria** (object) - The current selection criteria for the RFID module. ### Response Example ```json { "selectionCriteria": { "field1": "value1", "field2": "value2" } } ``` ``` -------------------------------- ### Revision API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/index-files/index-19.html Method to get the decoder's revision value. ```APIDOC ## GET /api/sled/revision ### Description Gets the decoder's revision value. ### Method GET ### Endpoint /api/sled/revision ### Response #### Success Response (200) - **revision** (string) - The decoder's revision string. #### Response Example ```json { "revision": "1.0.0" } ``` ``` -------------------------------- ### RFID LBT and Power Settings Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/IRfidConfig.html APIs for setting Listen Before Talk (LBT) values and radio power states. ```APIDOC ## POST RF_SetLBTValue ### Description Sets the Listen Before Talk (LBT) value. ### Method POST ### Endpoint /rfid/lbt ### Parameters #### Request Body - **val** (integer) - The LBT value ### Request Example ```json { "val": 10 } ``` ### Response #### Success Response (200) - **status** (integer) - Operation status (e.g., 0 for success) #### Response Example { "status": 0 } ## POST RF_SetRadioPowerState ### Description Sets the power state value of the RFID radio module. ### Method POST ### Endpoint /rfid/power/state ### Parameters #### Request Body - **RFPower** (integer) - The power state value ### Request Example ```json { "RFPower": 30 } ``` ### Response #### Success Response (200) - **status** (integer) - Operation status (e.g., 0 for success) #### Response Example { "status": 0 } ``` -------------------------------- ### RF_SetDYNStartQ Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Sets the starting Q value for each of the dynamic RF Modes. ```APIDOC ## POST /api/rfid/settings/dyn-start-q ### Description Sets Starting Q value in each of the dynamic RF Modes. ### Method POST ### Endpoint `/api/rfid/settings/dyn-start-q` ### Parameters #### Query Parameters - **qVal** (int) - Required - The starting Q value. ### Request Example ```json { "qVal": 3 } ``` ### Response #### Success Response (200) - **operationStatus** (int) - Indicates the success or failure of the operation. (e.g., 0 for success, non-zero for failure) #### Response Example ```json { "operationStatus": 0 } ``` ``` -------------------------------- ### SD_Open (no arguments) Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Opens the SLED device, making it ready for all communication (Bluetooth, Barcode, etc.). ```APIDOC ## SD_Open (no arguments) ### Description Opens the SLED device, preparing it for all communication channels including Bluetooth and Barcode scanning. ### Method (Implicitly a method call, not a REST endpoint) ### Endpoint N/A (Local method call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (True) - **status** (boolean) - True if the SLED was opened successfully. #### Failure Response (False) - **status** (boolean) - False if the SLED could not be opened. #### Response Example ```json { "status": true } ``` ``` -------------------------------- ### SD_StartLogTrace API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Starts log tracing. Currently supported only on specific A10 model devices. Returns false on unsupported devices. ```APIDOC ## SD_StartLogTrace ### Description This API is currently only supported on specific A10 model devices, When the API is called on an unsupported device, it returns false. ### Method (Implicitly a function call, specific HTTP method not provided in source) ### Endpoint (Not applicable, appears to be a function call within an SDK) ### Parameters (None specified) ### Request Example (Code example not provided) ### Response #### Success Response (200) - **return value** (int) - Indicates success or failure of the operation. Returns false on unsupported devices. #### Response Example (Code example not provided) ``` -------------------------------- ### RF_SetDYNStartQ Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/Reader.html Sets the Starting Q value for dynamic RF modes. ```APIDOC ## RF_SetDYNStartQ ### Description Sets the Starting Q value in each of the dynamic RF Modes. ### Method POST ### Endpoint /rfid/config/dynamic-mode/startq ### Parameters #### Request Body - **qVal** (integer) - Required - The starting Q value. Must be between 0 and 15. ### Request Example ```json { "qVal": 8 } ``` ### Response #### Success Response (200) - **status** (integer) - Constants.RFResult.SUCCESS (0) indicates success. #### Response Example ```json { "status": 0 } ``` #### Error Responses - **Constants.RFResult.SUCCESS (0)**: Operation was successful. - **SDConsts.RFResult.OTHER_CMD_RUNNING_ERROR (-4)**: Serial Error or Command State Error. - **SDConsts.RFResult.SD_NOT_CONNECTED (-5)**: Connected Error. - **SDConsts.RFResult.READER_OR_COM_INTERFACE_STATUS_ERROR (-7)**: Condition Error. - Other error constants from the "RFResult" class may also be returned. ``` -------------------------------- ### ISledConfig Interface Methods Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/ISledConfig.html This section details the various methods provided by the ISledConfig interface to query the SLED's configuration and status. ```APIDOC ## ISledConfig Interface Methods ### Description Provides methods to retrieve configuration and status information from the SLED device. ### Methods * **SD_GetAutoSleepTimeout** * **Description**: Gets the auto-sleep timeout of the SLED. * **Returns**: `int` * **SD_GetBatteryStatus** * **Description**: Gets the battery status (value) of the SLED. * **Returns**: `int` * **SD_GetBootLoaderVersion** * **Description**: Gets the boot loader version of SLED. * **Returns**: `String` * **SD_GetBTName** * **Description**: Get Bluetooth name of SLED. * **Returns**: `String` * **SD_GetBTVersion** * **Description**: Gets the Bluetooth firmware version of SLED. * **Returns**: `String` * **SD_GetBuzzerLevel** * **Description**: Gets the buzzer level of the SLED. * **Returns**: `int` * **SD_GetBuzzerState** * **Description**: Gets the buzzer enable state of the SLED. * **Returns**: `int` * **SD_GetChargeState** * **Description**: Gets the charge state of the SLED. * **Returns**: `int` * **SD_GetHostSerialNumber** * **Description**: Gets the serial number of the HOST Device. * **Returns**: `String` * **SD_GetLEDEnableState** * **Description**: Gets the LED enable state of the SLED. * **Returns**: `int` * **SD_GetModeKeyEnableState** * **Description**: Gets the mode key enable state of the SLED. * **Returns**: `int` * **SD_GetModel** * **Description**: Gets the Model ID. * **Returns**: `int` * **SD_GetSerialNumber** * **Description**: Gets the serial number of the SLED. * **Returns**: `String` * **SD_GetSmartBatteryCapacity** * **Description**: Gets the Smart battery capacity. * **Returns**: `int` * **SD_GetSmartBatteryCycleCnt** * **Description**: Gets the Smart battery cycle count. * **Returns**: `int` * **SD_GetSmartBatteryHealth** * **Description**: Gets the Smart battery health. * **Returns**: `int` * **SD_GetSmartBatteryLevel** * **Description**: Gets the Smart battery level. * **Returns**: `int` * **SD_GetSmartBatteryLifeTime** * **Description**: Gets the Smart battery life time. * **Returns**: `int` * **SD_GetSmartBatteryPresentStatus** * **Description**: Gets the Smart battery present status. * **Returns**: `int` * **SD_GetSmartBatterySerial** * **Description**: Gets the Smart battery serial. * **Returns**: `String` * **SD_GetSmartBatteryStatus** * **Description**: Gets the Smart battery status. * **Returns**: `int` * **SD_GetSmartBatteryTemperature** * **Description**: Gets the Smart battery temperature. * **Returns**: `int` * **SD_GetSmartBatteryVoltage** * **Description**: Gets the Smart battery voltage. * **Returns**: `int` ``` -------------------------------- ### SD_GetModeKeyEnableState API Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/BTReader.html Gets the current mode key enable state of the SLED. ```APIDOC ## SD_GetModeKeyEnableState ### Description Gets the current mode key enable state of the SLED. ### Method `public int SD_GetModeKeyEnableState()` ### Endpoint N/A (This appears to be a method call within a library or SDK, not a REST endpoint) ### Parameters None ### Request Example ```json {} ``` ### Response #### Success Response Returns the value of the key enable state: `0` for Disabled, `1` for Enabled. #### Error Responses - `SDConsts.SDModeKeyState.BLUETOOTH_NOT_ENABLED` (-15): Bluetooth is not enabled. - `SDConsts.SDModeKeyState.SD_NOT_CONNECTED` (-5): SLED device is not connected. - `SDConsts.SDModeKeyState.OTHER_CMD_RUNNING_ERROR` (-4): Another command is currently running or Block state error. - `SDConsts.SDModeKeyState.READER_OR_COM_INTERFACE_STATUS_ERROR` (-7): Reader or COM interface status error. - `SDConsts.SDModeKeyState.ERROR_HOTSWAP_STATE` (-37): Hotswap error. *Note: Other error constants from the "SDModeKeyState" class may also be returned.* #### Response Example ```json { "currentModeKeyState": 1 } ``` ``` -------------------------------- ### FileUtil Class Methods Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/FileUtil.html This section details the static methods available in the FileUtil class for managing files. ```APIDOC ## FileUtil Class Methods ### Description Provides static methods for file operations such as creating, deleting, checking existence, and reading files. ### Method `protected static FileUtil getInstance(android.content.Context context)` ### Description Retrieves an instance of FileUtil. ### Method `protected static final boolean makeInfoFileJson(String info)` ### Description Creates a JSON file to store information. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - **info** (String) - Required - The information to be written to the JSON file. ### Request Example ```json { "info": "{\"key\": \"value\"}" } ``` ### Response #### Success Response (200) - **boolean** (boolean) - True if the file was created successfully, false otherwise. #### Response Example ```json { "success": true } ``` --- ### Method `protected static final boolean makeInfoFile(String info)` ### Description Creates a file to store information. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - **info** (String) - Required - The information to be written to the file. ### Request Example ```json { "info": "Some text content." } ``` ### Response #### Success Response (200) - **boolean** (boolean) - True if the file was created successfully, false otherwise. #### Response Example ```json { "success": true } ``` --- ### Method `protected static final void deleteFile()` ### Description Deletes the information file. ### Parameters - None ### Response #### Success Response (200) - No content is returned upon successful deletion. --- ### Method `protected static final boolean isFileExists()` ### Description Checks if the information file exists. ### Parameters - None ### Response #### Success Response (200) - **boolean** (boolean) - True if the file exists, false otherwise. #### Response Example ```json { "exists": true } ``` --- ### Method `protected static final String readInfoFile()` ### Description Reads the content of the information file. ### Parameters - None ### Response #### Success Response (200) - **String** (String) - The content of the information file. #### Response Example ```json { "content": "File content here." } ``` --- ### Method `protected static final String readInfoFile(String file, String dirPath)` ### Description Reads the content of a specified file from a given directory. ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - **file** (String) - Required - The name of the file to read. - **dirPath** (String) - Required - The path to the directory containing the file. ### Request Example ```json { "file": "my_data.txt", "dirPath": "/storage/emulated/0/Documents" } ``` ### Response #### Success Response (200) - **String** (String) - The content of the specified file. #### Response Example ```json { "content": "Content of the specified file." } ``` ``` -------------------------------- ### SDConsts.RFTamBlockLen Constructor Details Source: https://github.com/marcoscapistrano/bluebird-rfid-docs/blob/main/API Document/javadoc/co/kr/bluebird/sled/SDConsts.RFTamBlockLen.html Details of the constructor for the SDConsts.RFTamBlockLen class. ```APIDOC ## SDConsts.RFTamBlockLen Constructor Details ### RFTamBlockLen() * **Signature**: `public RFTamBlockLen()` * **Description**: Default constructor for the `SDConsts.RFTamBlockLen` class. ```