### Start Example App Packager

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Starts the Metro server for the example application, which is necessary for running the app on devices or simulators.

```sh
yarn example start
```

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

### Start Metro Server (npm)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/package/example/README.md

Use this command to start the Metro bundler when using npm.

```bash
npm start
```

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

### Start Application on iOS (npm)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/package/example/README.md

Run this command to start your iOS application using npm.

```bash
npm run ios
```

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

### Start Application on Android (npm)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/package/example/README.md

Run this command to start your Android application using npm.

```bash
npm run android
```

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

### Start Application on iOS (Yarn)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/package/example/README.md

Run this command to start your iOS application using Yarn.

```bash
yarn ios
```

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

### Run Example App on iOS

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Builds and runs the example application on an iOS simulator or device.

```sh
yarn example ios
```

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

### Run Example App on Android

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Builds and runs the example application on an Android device or emulator.

```sh
yarn example android
```

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

### Start Metro Server (Yarn)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/package/example/README.md

Use this command to start the Metro bundler when using Yarn.

```bash
yarn start
```

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

### Start Application on Android (Yarn)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/package/example/README.md

Run this command to start your Android application using Yarn.

```bash
yarn android
```

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

### Install ESC/POS Printer for Expo

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/README.md

Install the library and prebuild for Expo projects.

```sh
npx expo install react-native-esc-pos-printer
npx expo prebuild
```

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

### start

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/PrintersDiscovery.md

Starts searching for the specified device type. An event is generated for each device detected. By default, the search stops after 5 seconds, but this can be changed using the `timeout` parameter.

```APIDOC
## start

### Description
Starts searching for the specified device type. An event is generated for each device detected. By default, the search stops after 5 seconds, but this can be changed using the `timeout` parameter.

### Method
`start(params: DiscoveryStartParams): void`

### Parameters
#### Path Parameters
- **params** (DiscoveryStartParams) - Required - The search parameters.

### Example
```typescript
PrintersDiscovery.start({
  timeout: 2000,
  filterOption: {
    deviceModel: DiscoveryFilterOption.MODEL_ALL,
  },
});
```
```

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

### Install Project Dependencies

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Run this command in the root directory to install all dependencies for the monorepo using Yarn workspaces.

```sh
yarn
```

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

### start

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/usePrintersDiscovery.md

Starts searching for printers. The search automatically stops after a default timeout of 5 seconds, which can be customized using the `timeout` parameter.

```APIDOC
## start

### Description
Starts searching for the specified device type. An event is generated for each device detected. By default, the search will be stopped after 5 seconds. To change this behavior, use the `timeout` parameter.

### Method
`start(params?: DiscoveryStartParams): void`

### Parameters
#### Parameters
- **params** (`DiscoveryStartParams`) - Required - The search parameters, including optional `timeout` and `filterOption`.

### Request Example
```typescript
const { start } = usePrintersDiscovery()

start({
  timeout: 2000,
  filterOption: {
    deviceModel: DiscoveryFilterOption.MODEL_ALL,
  },
});
```
```

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

### Add patch-package and postinstall-postinstall

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/flipperWorkaround.md

Install necessary packages for patching dependencies. Refer to the patch-package documentation for more details.

```bash
yarn add patch-package postinstall-postinstall
```

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

### Example IP Address

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/deviceInfo.md

Stores the IP address of the device. If it could not be acquired, a blank character is stored.

```string
`TCP: "192.168.192.168"`
```

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

### Install React Native ESC/POS Printer

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/README.md

Install the library using Yarn for React Native projects.

```sh
yarn add react-native-esc-pos-printer
```

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

### connect

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Starts communication with the printer. It can optionally accept a timeout value.

```APIDOC
## connect

### Description
Starts communication with the printer.

### Method
`connect(timeout?: string): Promise<void>`

### Parameters
#### Query Parameters
- **timeout** (string) - Optional - The timeout duration for the connection.

### Request Example
```typescript
await printerInstance.connect();
```
```

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

### Install iOS Pods for Bare React Native

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/INSTALLATION.md

Run this command in your iOS project directory to install necessary CocoaPods dependencies for bare React Native projects.

```sh
pod install
```

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

### Connect to Printer

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Starts communication with the printer. This method initiates the connection process.

```typescript
await printerInstance.connect();
```

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

### Example MAC Address

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/deviceInfo.md

Stores the MAC address of the device. If it could not be acquired, a blank character is stored.

```string
`TCP: "12:34:56:78:56:78"`
```

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

### Example Device Name

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/deviceInfo.md

Stores the name set to the device. If it could not be acquired, a blank character or 'TM Printer' is stored.

```string
`TM-T88V`
```

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

### connect

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/connect.md

Starts communication with the printer. This method establishes a connection and returns a Promise that resolves when communication is successfully initiated.

```APIDOC
## connect

Starts communication with the printer.

### Parameters

#### timeout *(optional)*

- `number`

Specifies the maximum time (in milliseconds) to wait for communication with the printer to be established.

| **Value** |  **Description** | **Default** |
| --- | --- | --- |
| 1000 to 300000 | Maximum wait time before an error is returned (in milliseconds). | 15000 |

### Returns

`Promise<void>`

### Errors

| **Error status** | **Description** |
| --- | --- |
| ERR_PARAM | An invalid parameter was passed. |
| ERR_CONNECT | Failed to open the device. |
| ERR_TIMEOUT | Failed to communicate with the devices within the specified time. |
| ERR_ILLEGAL | Tried to start communication with a printer with which communication had been already established. Tried to start communication with a printer during reconnection process. |
| ERR_MEMORY | Necessary memory could not be allocated. |
| ERR_FAILURE | An unknown error occurred. |
| ERR_PROCESSING | Could not run the process. |
| ERR_NOT_FOUND | The printer could not be found. |
| ERR_IN_USE | The device was in use. |
| ERR_TYPE_INVALID | The device type is different. |
| ERR_RECOVERY_FAILURE | Failed to recover the printer. |

### Supplementary explanation

Android:

- When communication with the printer is no longer necessary, be sure to call disconnect to terminate it.
- If you are using DHCP to assign the IP address of the printer, specify the MAC address or host name of the
printer as the identifier.
-  When connecting through the USB, the identifiers that can be specified differ depending on the shape of
the USB connector.
When the identifier is omitted, Android OS connects with the USB device found first.
When the Android terminal is set to the developer mode, you may not be able to connect through USB-A - Device Charging.
- Devices other than printers are exclusively locked.
- If error with status ERR_RECOVERY_FAILURE occurs, restart the printer.

iOS:

- When communication with the printer is no longer necessary, be sure to call disconnect to terminate it.
- For TM-DT series, MAC address cannot be specified.
- When connecting with the printer using Bluetooth, complete pairing before calling the connect command.
- Depending on the project settings, Bluetooth communication may be disconnected if the application runs in the background.
- If Bluetooth and USB are used simultaneously, priority is given to the USB.
- Devices other than printers are exclusively locked.
- If error with status ERR_RECOVERY_FAILURE occurs, restart the printer.
- Since it takes time to send and receive a large amount of data with BLE connection, the following APIs not recommended be used. (addImage)
```

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

### Add postinstall script to package.json

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/flipperWorkaround.md

Configure package.json to automatically run patch-package after installations. This ensures patches are applied consistently.

```json
"scripts": {
  "postinstall": "patch-package"
}
```

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

### Example Bluetooth Device Address

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/deviceInfo.md

Stores the Bluetooth device address. If it could not be acquired, a blank character is stored.

```string
`BT: "00:22:15:7D:70:9C"`
```

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

### Printer.monitorPrinter()

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Starts monitoring the printer status at a specified interval and provides a callback for status updates.

```APIDOC
## Printer.monitorPrinter()

### Description
Starts monitoring the printer status.

### Method
`Printer.monitorPrinter(printerInstance: Printer, listener: Listener, interval: number): () => void`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **printerInstance** (Printer) - Required - The printer instance to monitor.
* **listener** (Listener) - Required - A callback function that receives the printer status.
* **interval** (number) - Required - The interval in milliseconds to check the printer status.

### Request Example
```typescript
const stop = Printer.monitorPrinter(printerInstance, (status) => {
  console.log(status);
}, 5000);

// call stop() to stop monitoring
```

### Response
#### Success Response (200)
* **() => void** - A function to stop monitoring the printer.

#### Response Example
None
```

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

### Printer.addViewShot()

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Prints an image captured from a React Native View. Requires 'react-native-view-shot' to be installed.

```APIDOC
## Printer.addViewShot()

### Description
Prints image captured from React Native View. Requires `react-native-view-shot` to be installed.

### Method
`Printer.addViewShot(printerInstance: Printer, params: AddViewShotParams): Promise<void>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **printerInstance** (Printer) - Required - The printer instance to use.
* **params** (AddViewShotParams) - Required - Parameters for capturing and printing the view.
  * **viewNode** (React Native View Node) - Required - The reference to the React Native View to capture.

### Request Example
```typescript
const ref = useRef<View>(null);

... 

await Printer.addViewShot(printerInstance, {
  viewNode: ref.current,
});

... 

return (
  <View ref={ref}>
    <Text>Print me</Text>
  </View>
);
```

### Response
#### Success Response (200)
void

#### Response Example
None
```

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

### Start Printer Discovery

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/PrintersDiscovery.md

Initiates a search for printers with a specified timeout and filter options. The search stops automatically after the timeout period.

```typescript
PrintersDiscovery.start({
  timeout: 2000,
  filterOption: {
    deviceModel: DiscoveryFilterOption.MODEL_ALL,
  },
});
```

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

### Start Printer Discovery with Timeout and Filter

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/usePrintersDiscovery.md

Initiates a search for printers with a specified timeout and filter options. The search will automatically stop after the given timeout in milliseconds.

```typescript
const { start } = usePrintersDiscovery()

start({
  timeout: 2000,
  filterOption: {
    deviceModel: DiscoveryFilterOption.MODEL_ALL,
  },
});
```

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

### Access Discovered Printers List

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/usePrintersDiscovery.md

Starts the printer discovery process and logs the list of discovered printers. The 'printers' array is updated dynamically as new devices are found.

```typescript
const { printers, start } = usePrintersDiscovery()

start()
console.log(printers)  // will be update when every new printer is discovered
```

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

### Printer.monitorPrinter

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/monitorPrinter.md

Starts monitoring the printer status and provides updates via a listener function. It allows for custom intervals and internally utilizes connect, getStatus, and disconnect commands.

```APIDOC
## static Printer.monitorPrinter

Starts monitoring the printer status.

### Parameters

#### printerInstance

- `Printer`

Printer instance defined by calling `new Printer(...)`.

#### listener

- (status: [PrinterStatus](../interfaces/printerStatus.md)) => void

Listener function that will be called with printer status.

#### interval (optional)

- `number`

Interval in milliseconds. Default: 1000.

### Returns

`() => void`

### Supplementary explanation

- Internaly uses [connect](./connect.md), [getStatus](./getStatus.md) and [disconnect](./disconnect.md) commands.
```

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

### Get Printer Status

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Acquires the current status information of the printer.

```typescript
const printerStatus = await printerInstance.getStatus();
```

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

### Initialize Printer with Bluetooth Target

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/constructor.md

Instantiates a new Printer object, specifying a Bluetooth device address as the connection target and the printer's model name.

```typescript
const printer = new Printer({
  target: "BT:00:22:15:7D:70:9C",
  deviceName: "TM-T88V",
})
```

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

### Printer Constructor

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/constructor.md

Initializes a new Printer instance. This constructor implements a singleton pattern, returning the same instance if the same target is provided.

```APIDOC
## Printer constructor

Initializes the printer object.

> [!NOTE]
> Implements singletone pattern. Return the same instance if the same target is passed.

### Parameters

#### target

- `string`

Specifies the method of connecting to the printer by a character string. The connection method varies according to the system configuration. Can be retrieved from the [discovery](../discovery/discovery.md).

| **I/F** | **Connec-tion type** | **Identifier** | **Example** |
| --- | --- | --- | --- |
| Wi-Fi/Ethernet | "TCP" | - IP address in IPv4 format<br/>  - MAC address<br/> - Host name | "TCP:192.168.192.168" |
| Bluetooth | "BT" | BD address | "BT:00:22:15:7D:70:9C" |
| USB | "USB" | - Device node<br/> - USB Serial number<br/> - Omitted | "USB:/dev/udev/*", "USB:00000000000000000", "USB:" |

---
#### deviceName

- `string`

The name set to the device is stored.

Example: `TM-T88V`

---
#### lang

- `enum PrinterModelLang`

Specifies the language of the printer.

| **Value** | **Description** |
| --- | --- |
| `PrinterConstants.MODEL_ANK` | ANK model |
| `PrinterConstants.MODEL_CHINESE` | Simplified Chinese model |
| `PrinterConstants.MODEL_TAIWAN` | Taiwan model |
| `PrinterConstants.MODEL_KOREAN` | Korean model |
| `PrinterConstants.MODEL_THAI` | Thai model |
| `PrinterConstants.MODEL_SOUTHASIA` | South Asian model |

Note: The default value is `PrinterConstants.MODEL_ANK`.

### Example
```typescript
const printer = new Printer({
  target: "BT:00:22:15:7D:70:9C",
  deviceName: "TM-T88V",
})
```
```

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

### Get Printer Setting

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Acquires the set value of a printer setting. The value is notified to a listener method.

```typescript
const printerSetting = await printerInstance.getPrinterSetting(PrinterConstants.PRINTER_SETTING_PAPERWIDTH);
```

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

### Device Connection Targets

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/deviceInfo.md

Specifies various connection targets for different device types (TCP, Bluetooth, USB). Use these strings to establish a connection to the device.

```string
"TCP:192.168.192.168"
```

```string
"BT:00:22:15:7D:70:9C"
```

```string
"USB:/dev/udev/*"
```

```string
"USB:000000000000000000"
```

```string
"TCP:192.168.192.168[local_printer]"
```

```string
"TCP:192.168.192.168[local_display]"
```

```string
"TCP:12:34:56:78:56:78"
```

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

### DiscoveryStartParams

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/discoveryStartParams.md

Parameters for initiating a discovery process. Allows configuration of search timeout, automatic stopping, and filtering.

```APIDOC
## DiscoveryStartParams

### Description

An interface defining the parameters for starting a discovery process. It allows customization of the search duration, whether the search stops automatically, and filtering options.

### Parameters

#### Optional Parameters

- **timeout** (number) - Optional - The search timeout in milliseconds. The default value is 5000 ms.
- **autoStop** (boolean) - Optional - If true, the search will stop automatically after the timeout. The default value is true.
- **filterOption** (FilterOption) - Optional - The search filter options. See [FilterOption](./filterOption.md) for more details.
```

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

### Publish New Versions

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Uses release-it to automate the process of publishing new versions to npm, including version bumping and tag creation.

```sh
yarn release
```

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

### Print Image from React Native View

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Prints an image captured from a React Native View component. Requires `react-native-view-shot` to be installed and configured.

```bash
yarn add react-native-view-shot

# For iOS, run:
cd ios && pod install
```

```typescript
const ref = useRef<View>(null);

...

await Printer.addViewShot(printerInstance, {
  viewNode: ref.current,
});

...

return (
  <View ref={ref}>
    <Text>Print me</Text>
  </View>
);
```

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

### Printer.tryToConnectUntil

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/tryToConnectUntil.md

Attempts to establish a connection with the printer, retrying until the provided predicate function returns true based on the printer's status. This is useful for scenarios like waiting for a printer to recover from a connection loss.

```APIDOC
## static Printer.tryToConnectUntil

Tries to connect to the printer until the condition is met.

### Parameters

#### printerInstance

- `Printer`

Printer instance defined by calling `new Printer(...)`.

#### predicate

- `(status: [PrinterStatus](../interfaces/printerStatus.md)) => boolean`

Predicate function that will be called with printer status. If returns `true` promise will be resolved and next steps will be executed.

### Returns

`Promise<void>`

### Supplementary explanation

- Can be used to wait for printer to be ready based on its status. I.e. connection loss.
- Internaly uses [connect](./connect.md), [getStatus](./getStatus.md) commands.
```

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

### Print Text to Discovered Printers

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/README.md

Instantiate a Printer, connect to it, add text and formatting commands, and send the data. Ensure to handle connection status and disconnect after printing.

```tsx
import { Printer } from 'react-native-esc-pos-printer';

function App() {
  const { start, isDiscovering, printers } = 
    usePrintersDiscovery();

    useEffect(() => {
      start();
    }, []);

    const print = () => {
      // printing on all discovered printers
      printers.forEach(printersData => {
          const printerInstance = new Printer({
            target: printersData.target,
            deviceName: printersData.deviceName,
          });

          const res = await printerInstance.addQueueTask(async () => {
            await Printer.tryToConnectUntil(
              printerInstance,
              (status) => status.online.statusCode === PrinterConstants.TRUE
            );
            await printerInstance.addText('DUDE!');
            await printerInstance.addFeedLine();
            await printerInstance.addCut();
            const result = await printerInstance.sendData();
            await printerInstance.disconnect();
            return result;
        })
      })
  }

  return <Button title="Print" onPress={print} />;
}
```

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

### Monitor Discovery Status

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/usePrintersDiscovery.md

Starts and stops the discovery process while monitoring the 'isDiscovering' boolean. 'isDiscovering' is true when the search is active and false when stopped.

```typescript
const { isDiscovering, start, stop } = usePrintersDiscovery()

start() // isDiscovering -> true
...
stop() // isDiscovering -> false
```

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

### Printer.tryToConnectUntil()

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Attempts to connect to the printer repeatedly until a specified condition is met.

```APIDOC
## Printer.tryToConnectUntil()

### Description
Tries to connect to the printer until the condition is met.

### Method
`Printer.tryToConnectUntil(printerInstance: Printer, condition: (status: PrinterStatusResponse) => boolean): Promise<void>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **printerInstance** (Printer) - Required - The printer instance to connect to.
* **condition** ((status: PrinterStatusResponse) => boolean) - Required - A function that returns true when the connection condition is met.

### Request Example
```typescript
await Printer.tryToConnectUntil(
  printerInstance,
  (status) => status.online.statusCode === PrinterConstants.TRUE
);
```

### Response
#### Success Response (200)
void

#### Response Example
None
```

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

### Clear Command Buffer

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Resets the command buffer, removing all pending print commands. Use this to start a new print job or correct errors.

```typescript
await printerInstance.clearCommandBuffer();
```

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

### Run Unit Tests

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Executes the unit tests using Jest to verify the functionality of the library's code.

```sh
yarn test
```

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

### Lint Project Files

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Runs ESLint to check for code style and potential errors according to the project's linting rules.

```sh
yarn lint
```

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

### onDiscovery

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/PrintersDiscovery.md

Adds a listener for the `discovery` event, which is triggered when a new printer is discovered.

```APIDOC
## onDiscovery

### Description
Adds a listener for the `discovery` event. This event is called whenever a new printer is discovered.

### Method
`onDiscovery(listener: (printers: DeviceInfo[]) => void): () => void`

### Parameters
#### Path Parameters
- **listener** ((printers: DeviceInfo[]) => void) - Required - The listener function that will receive an array of discovered printers.

### Returns
- `remove()` - A function to remove the listener.

### Example
```typescript
PrintersDiscovery.onDiscovery((printers) => {
  console.log(printers);
});
```
```

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

### Monitor Printer Status

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Starts a process to continuously monitor the printer's status. A callback function receives the status updates, and the returned function can be called to stop monitoring.

```typescript
const stop = Printer.monitorPrinter(printerInstance, (status) => {
  console.log(status);
});

// call stop() to stop monitoring
```

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

### Discover Printers with usePrintersDiscovery Hook

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/README.md

Use the usePrintersDiscovery hook to start discovering available printers. This hook should be called within a useEffect hook to initiate discovery upon component mount.

```tsx
import { usePrintersDiscovery } from 'react-native-esc-pos-printer';

function App() {
  const { start, isDiscovering, printers } = 
    usePrintersDiscovery();

    useEffect(() => {
      start();
    }, []);
}
```

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

### addCommand

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds a raw command to the command buffer, allowing direct ESC/POS command sending.

```APIDOC
## addCommand

### Description
Adds a command to the command buffer. Sends the ESC/POS command.

### Method
`addCommand(data: Uint8Array): Promise<void>`

### Parameters
#### Query Parameters
- **data** (Uint8Array) - Required - The raw ESC/POS command data.

### Request Example
```typescript
import EscPosEncoder from 'esc-pos-encoder';

let encoder = new EscPosEncoder();

let result = encoder
    .initialize()
    .text('The quick brown fox jumps over the lazy dog')
    .newline()
    .qrcode('https://nielsleenheer.com')
    .encode(); // or any other way to get the Uint8Array

await printerInstance.addCommand(result);
```
```

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

### addPulse

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds a drawer kick command to the command buffer, setting the drawer kick parameters.

```APIDOC
## addPulse

### Description
Adds a drawer kick command to the command buffer. Sets the drawer kick.

### Method
`addPulse(params?: AddPulseParams): Promise<void>`

### Parameters
#### Query Parameters
- **params** (AddPulseParams) - Optional - Parameters for the pulse command.

### Request Example
```typescript
await printerInstance.addPulse();
```
```

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

### addCommand

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/addCommand.md

Adds a command to the command buffer and sends the ESC/POS command to the printer.

```APIDOC
## addCommand

### Description

Adds a command to the command buffer. Sends the ESC/POS command.

### Parameters

#### data

- `Uint8Array` - Required - Specifies the ESC/POS command. Specifies the binary data.

### Returns

`Promise<void>`

### Errors

- **ERR_PARAM**: An invalid parameter was passed.
- **ERR_TIMEOUT**: Failed to communicate with the devices within the specified time.
- **ERR_MEMORY**: Necessary memory could not be allocated.
```

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

### PrinterSettingsResponse Interface

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/printerSettings.md

Details the structure and possible values for printer settings within the PrinterSettingsResponse interface.

```APIDOC
## Interface: PrinterSettingsResponse

### typeCode

*typeCode*: `number`

The acquired printer setting item is stored.

| *Value* |
| --- |
| `PrinterConstants.PRINTER_SETTING_PAPERWIDTH` |
| `PrinterConstants.PRINTER_SETTING_PRINTDENSITY` |
| `PrinterConstants.PRINTER_SETTING_PRINTSPEED` |

### type

*type*: `string`

The acquired printer setting item is stored. (string representation)

| *Value* |
| --- |
| `"PRINTER_SETTING_PAPERWIDTH"` |
| `"PRINTER_SETTING_PRINTDENSITY"` |
| `"PRINTER_SETTING_PRINTSPEED"` |

### value

*value*: `number`

The acquired set value of the printer setting is stored.

#### For paper width

| *Value* |
| --- |
| `58` |
| `60` |
| `70` |
| `76` |
| `80` |

#### For print density

| *Value* |
| --- |
| `0` |
| `70` |
| `75` |
| `80` |
| `85` |
| `90` |
| `95` |
| `100` |
| `105` |
| `110` |
| `115` |
| `120` |
| `125` |
| `130` |

#### For print speed

| *Value* |
| --- |
| `1` |
| `2` |
| `3` |
| `4` |
| `5` |
| `6` |
| `7` |
| `8` |
| `9` |
| `10` |
| `11` |
| `12` |
| `13` |
| `14` |
| `15` |
| `16` |
| `17` |
```

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

### Add Smoothing Setting

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Use this method to add a smoothing setting to the command buffer. It takes a boolean parameter indicating whether smoothing should be enabled.

```typescript
await printerInstance.addTextSmooth(PrinterConstants.TRUE);
```

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

### Expo iOS Info.plist Configuration

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/INSTALLATION.md

Update your `app.json` file with these iOS configurations for Expo projects. This includes setting the Bluetooth usage description and supported accessory protocols.

```json
{
  "ios": {
    "infoPlist": {
      "NSBluetoothAlwaysUsageDescription": "Use this to communicate with the printer.",
      "UISupportedExternalAccessoryProtocols": ["com.epson.escpos"]
    }
  }
}
```

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

### Barcode Parameters

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/interfaces/addBarcodeParams.md

Parameters for configuring barcode generation.

```APIDOC
## Barcode Parameters

This section details the parameters that can be used when adding a barcode.

### type

*type*: `number`

Specifies the barcode type. Supported values include:
- `PrinterConstants.BARCODE_UPC_A` (UPC-A)
- `PrinterConstants.BARCODE_UPC_E` (UPC-E)
- `PrinterConstants.BARCODE_EAN13` (EAN13)
- `PrinterConstants.BARCODE_JAN13` (JAN13)
- `PrinterConstants.BARCODE_EAN8` (EAN8)
- `PrinterConstants.BARCODE_JAN8` (JAN8)
- `PrinterConstants.BARCODE_CODE39` (CODE39)
- `PrinterConstants.BARCODE_ITF` (ITF)
- `PrinterConstants.BARCODE_CODABAR` (CODABAR)
- `PrinterConstants.BARCODE_CODE93` (CODE93)
- `PrinterConstants.BARCODE_CODE128` (CODE128)
- `PrinterConstants.BARCODE_CODE128_AUTO` (CODE128 auto)
- `PrinterConstants.BARCODE_GS1_128` (GS1-128)
- `PrinterConstants.BARCODE_GS1_DATABAR_OMNIDIRECTIONAL` (GS1 DataBar Omnidirectional)
- `PrinterConstants.BARCODE_GS1_DATABAR_TRUNCATED` (GS1 DataBar Truncated)
- `PrinterConstants.BARCODE_GS1_DATABAR_LIMITED` (GS1 DataBar Limited)
- `PrinterConstants.BARCODE_GS1_DATABAR_EXPANDED` (GS1 DataBar Expanded)

### hri *(optional)*

*hri?*: `number`

Specifies the HRI (Human Readable Interpretation) position. Possible values are:
- `PrinterConstants.HRI_NONE` (default): No printing
- `PrinterConstants.HRI_ABOVE`: Above the barcode
- `PrinterConstants.HRI_BELOW`: Below the barcode
- `PrinterConstants.HRI_BOTH`: Both above and below the barcode
- `PrinterConstants.PARAM_DEFAULT`: Specifies the default value (no printing)
- `PrinterConstants.PARAM_UNSPECIFIED`: <Obsolete> Not specify

### font *(optional)*

*font?*: `number`

Specifies the HRI font. Possible values are:
- `PrinterConstants.FONT_A` (default): Font A
- `PrinterConstants.FONT_B`: Font B
- `PrinterConstants.FONT_C`: Font C
- `PrinterConstants.FONT_D`: Font D
- `PrinterConstants.FONT_E`: Font E
- `PrinterConstants.PARAM_DEFAULT`: Specifies the default value (font A).
- `PrinterConstants.PARAM_UNSPECIFIED`: <Obsolete> Not specify

### width *(optional)*

*width?*: `number`

Specifies the width of a single module in dots. Must be an integer from 2 to 6.

### height *(optional)*

*height?*: `number`

Specifies the height of the barcode in dots. Must be an integer from 1 to 255.
```

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

### Typecheck Project Files

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/CONTRIBUTING.md

Verifies the TypeScript types across the project to ensure code quality and prevent type-related errors.

```sh
yarn typecheck
```

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

### Android Manifest Permissions for Bare React Native

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/INSTALLATION.md

Add these permissions to your `android/app/src/main/AndroidManifest.xml` file for bare React Native projects. These grant the app necessary access to internet, Bluetooth, and location services.

```xml
<uses-permission android:name="android.permission.INTERNET" />

  <uses-permission android:name="android.permission.BLUETOOTH_SCAN"
      android:usesPermissionFlags="neverForLocation"/>
  <uses-permission android:name="android.permission.BLUETOOTH_CONNECT"/>

  <!-- Request legacy permissions on older devices. -->
  <uses-permission android:name="android.permission.BLUETOOTH"
      android:maxSdkVersion="30"/>
  <uses-permission android:name="android.permission.BLUETOOTH_ADMIN"
      android:maxSdkVersion="30"/>
  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
      android:maxSdkVersion="30"/>
  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"
      android:maxSdkVersion="28"/>
  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="18"/>
```

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

### Add Drawer Kick Command

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds a drawer kick command to the command buffer. This command triggers the cash drawer.

```typescript
await printerInstance.addPulse();
```

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

### Add Text Size Command

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds character scaling factor setting to the command buffer. Define the width and height for text scaling.

```typescript
await printerInstance.addTextSize({
  width: 2,
  height: 2,
});
```

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

### addTextLang

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/addTextLang.md

Adds language setting to the command buffer. This API is called before the addText API and should be used at the top of each print job.

```APIDOC
## addTextLang

Adds language setting to the command buffer.

### Description

This API sets the language encoding for subsequent text printing operations. It is crucial to call this API before `addText` to ensure correct character rendering based on the printer's capabilities.

### Method

(Not specified, likely a method call in an SDK)

### Parameters

#### lang

- **lang** (number) - Required - Specifies the target language.

  | **Value** | **Description** |
  | --- | --- |
  | `PrinterConstants.LANG_EN` (default) | English (ANK specification) |
  | `PrinterConstants.LANG_JA` | Japanese |
  | `PrinterConstants.LANG_ZH_CN` | Simplified Chinese |
  | `PrinterConstants.LANG_ZH_TW` | Traditional Chinese |
  | `PrinterConstants.LANG_KO` | Korean |
  | `PrinterConstants.LANG_TH` | Thai (South Asian specification) |
  | `PrinterConstants.LANG_VI` | Vietnamese (South Asian specification) |
  | `PrinterConstants.LANG_MULTI` | Multiple languages (UTF-8) |
  | `PrinterConstants.PARAM_DEFAULT` | Specifies the default value (English). |

### Returns

`Promise<void>`

### Errors

| **Error status** | **Description** |
| --- | --- |
| ERR_PARAM | An invalid parameter was passed. |
| ERR_TIMEOUT | Failed to communicate with the devices within the specified time. |
| ERR_MEMORY | Necessary memory could not be allocated. |

### Supplementary explanation

- This API is called before the [addText](./addText.md) API.
- Use this API at the top of each print job.
- Available languages differ depending on character specifications of the printer. For details, see Technical Reference Guide of the printer.
```

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

### Pair Bluetooth Device (iOS)

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/usePrintersDiscovery.md

Initiates pairing with a Bluetooth device. If no MAC address is provided, a native dialog will prompt the user to select a device.

```typescript
const { pairBluetoothDevice } = usePrintersDiscovery()

pairBluetoothDevice();
```

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

### Printers Discovery Class

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/discovery.md

Use this class for class-based printer discovery. It allows registering listeners for discovery events, errors, and status changes.

```typescript
import { PrintersDiscovery } from 'react-native-esc-pos-printer';

// add listener
PrintersDiscovery.onDiscovery(printers => {
  console.log(printers);
})

// start discovering
PrintersDiscovery.start()


// handle error
PrintersDiscovery.onError(error => {
  console.log(error);
})

// handle status change
PrintersDiscovery.onStatusChange(status => {
  console.log(status);
})
```

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

### Connect to Printer Until Condition Met

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Attempts to establish a connection with the printer repeatedly until a specified condition based on the printer's status is satisfied.

```typescript
await Printer.tryToConnectUntil(
  printerInstance,
  (status) => status.online.statusCode === PrinterConstants.TRUE
);
```

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

### onStatusChange

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/PrintersDiscovery.md

Adds a listener for the `statusChange` event, which is triggered when the discovery status changes.

```APIDOC
## onStatusChange

### Description
Adds a listener for the `statusChange` event. This event is called when the discovery status changes between 'discovering' and 'inactive'.

### Method
`onStatusChange(listener: (status: 'discovering' | 'inactive') => void): () => void`

### Parameters
#### Path Parameters
- **listener** ((status: 'discovering' | 'inactive') => void) - Required - The listener function that will receive the new status.

### Returns
- `remove()` - A function to remove the listener.

### Example
```typescript
PrintersDiscovery.onStatusChange((status) => {
  console.log(status);
});
```
```

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

### Add Line Spacing Command

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds line spacing setting to the command buffer. Set the desired line spacing value.

```typescript
await printerInstance.addLineSpace(50);
```

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

### Listen for Discovery Errors

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/discovery/PrintersDiscovery.md

Adds a listener to handle errors that occur during the printer discovery process. The listener function receives an error object.

```typescript
PrintersDiscovery.onError((error) => {
  console.log(error); // will be called when an error occurs
});
```

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

### addImage

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds a raster image print command to the command buffer.

```APIDOC
## addImage

### Description
Adds a raster image print command to the command buffer.

### Method
`addImage(params: AddImageParams): Promise<void>`

### Parameters
#### Request Body
- **params** (AddImageParams) - Required - Parameters for the image to be added.
  - **source** (any) - Required - The source of the image.
  - **width** (number) - Required - The width of the image.

### Request Example
```typescript
await printerInstance.addImage({
  source: require('../store.png'),
  width: 100,
});
```
```

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

### sendData

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Sends the print command buffer to the printer.

```APIDOC
## sendData

### Description
Sends the print command buffer to the printer.

### Method
`sendData(timeout?: number): Promise<PrinterStatusResponse>`

### Parameters
#### Query Parameters
- **timeout** (number) - Optional - The timeout duration for sending data.

### Response
#### Success Response (200)
- **PrinterStatusResponse** - An object containing the printer's status.

### Request Example
```typescript
const printerStatus = await printerInstance.sendData();
```
```

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

### addTextStyle

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/addTextStyle.md

Adds character style setting to the command buffer. This method allows you to customize the appearance of text in your print output.

```APIDOC
## addTextStyle

### Description
Adds character style setting to the command buffer.

### Parameters
#### params
- **params** (AddTextStyleParams) - Required - An object conforming to the AddTextStyleParams interface, specifying the text styles to apply.

### Returns
`Promise<void>` - A promise that resolves when the text style has been successfully added to the command buffer.

### Errors
- **ERR_PARAM**: An invalid parameter was passed.
- **ERR_TIMEOUT**: Failed to communicate with the devices within the specified time.
- **ERR_MEMORY**: Necessary memory could not be allocated.

### Supplementary explanation
- If all the parameters are set to "PARAM_UNSPECIFIED," EPOS2_ERR_PARAM will be returned.
```

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

### addTextLang()

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/Printer.md

Adds language setting to the command buffer, affecting text encoding.

```APIDOC
## addTextLang()

### Description
Adds language setting to the command buffer. A text string specified by the [addText](./addText.md) API is encoded according to the language specified by this API.

### Method
`addTextLang(lang: AddTextLangParam): Promise<void>`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **lang** (AddTextLangParam) - Required - The language setting for text encoding.

### Request Example
```typescript
await printerInstance.addTextLang(PrinterConstants.LANG_JA);
```

### Response
#### Success Response (200)
void

#### Response Example
None
```

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

### addImage

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/addImage.md

Adds a raster image print command to the command buffer. An image is binarized and converted into a raster image based on specified parameters, then compressed or not before transmission.

```APIDOC
## addImage

### Description
Adds a raster image print command to the command buffer. A specified area of image graphics is binarized according to the mode, halftone, and brightness parameters and converted into a raster image. The converted image is compressed or not compressed before transmission according to the compress parameter value. One pixel of an image corresponds to one dot of the printer.

### Parameters
#### params
- **params** (AddImageParams) - Required - An object conforming to the AddImageParams interface, specifying image properties and printing options.

### Returns
`Promise<void>` - This function does not return a value upon successful execution.

### Errors
- **ERR_PARAM**: An invalid parameter was passed.
- **ERR_TIMEOUT**: Failed to communicate with the devices within the specified time.
- **ERR_MEMORY**: Necessary memory could not be allocated.

### Supplementary explanation
- The "compress" parameter is effective when the printer is connected via Bluetooth. For other printers, specify `PrinterConstants.COMPRESS_AUTO.`
- Printing may get slower if a transparent image is printed.
- Set an image size appropriate for the printer. If you set to print a large image, the API commands will be succeeded, but the printer may print nothing.
- Even if the size of an image is printable, the ERR_MEMORY error may occur depending on the Android device specification. In such case, reduce the image size.
```

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

### addPulse

Source: https://github.com/tr3v3r/react-native-esc-pos-printer/blob/main/docs/printer/addPulse.md

Adds a drawer kick command to the command buffer. This method is used to trigger a physical drawer kick operation on a connected printer.

```APIDOC
## addPulse

### Description
Adds a drawer kick command to the command buffer. Sets the drawer kick.

### Parameters

#### params
- **params** (AddPulseParams) - Required - An object conforming to the AddPulseParams interface, specifying the parameters for the drawer kick.

### Returns
`Promise<void>` - A promise that resolves when the command has been added to the buffer, or rejects if an error occurs.

### Errors

#### Error status
- **ERR_PARAM** - An invalid parameter was passed.
- **ERR_TIMEOUT** - Failed to communicate with the devices within the specified time.
- **ERR_MEMORY** - Necessary memory could not be allocated.

### Supplementary explanation

- The drawer and optional external buzzer cannot be connected simultaneously.
- Do not open the drawer repeatedly for a short time. The drawer may be damaged due to too much load.
- For built-in buzzer equipped models of the following printers, sounding the buzzer is possible using the pulse output commands for drawer kick connectors. For details on controlling the built-in buzzer, refer to the Technical Reference Guide of the printer. TM-T70 / TM-T70II / TM-T82II / TM-T82III / TM-T88IV / TM-T88V / TM-T88VI / TM-T88VII / TM-T82II-i / TM- T83II-i / TM-T88VI-iHUB / TM-L90 / TM-L100
```