Antylogic
DemoApp login

399 operational guides

Docs sections
DocsTPV setup
Device

Manage TPV output devices

Configure the output devices Harbor Soho uses for receipts, kitchen printing, control printing and KDS-related routing. This guide explains how managers review the list, start a new device, edit driver and access settings, and save changes safely.

In this article

Output devices define where Antylogic sends receipt, kitchen, control and KDS-related output for the active location.

In the GB demo runtime, the documented operator works in Harbor Demo Group at Harbor Soho and can edit an existing ESC/POS network device without creating extra data.

Before you start

  • Harbor Demo Group is selected with the Harbor Soho location active.
  • The user has `tpv:manage` to create or save output devices. Users with `tpv:view` can review the list and detail screens only.
  • Use `TPV_OUTPUT_DEVICE_ID=0113dc07-05ff-4691-926e-bd84d9f12ee6` for the existing Harbor Soho demo device.
  • To restrict output access to named staff, the user also needs `users:view` or `users:manage`; otherwise the user selector is disabled.

Instructions

  1. 1.

    Open the printers tab

    Open TPV settings at `${APP_DEEPLINK_BASE}${ORG_ID}/${LOCATION_ID}/location/tpv?tab=printers`. The Printers and outputs table shows each configured output device, its driver and transport, allowed users and active state.

  2. 2.

    Choose create or edit

    Select New device to review the default create form, or open the existing Harbor Soho device with `${APP_DEEPLINK_BASE}${ORG_ID}/${LOCATION_ID}/location/tpv/output-devices/item?id=${TPV_OUTPUT_DEVICE_ID}`. New devices start active, with the ESC/POS driver and no user restriction.

  3. 3.

    Set general details

    Enter a clear name and code, choose the driver and confirm whether the device is active. Transport is calculated from the driver, so the operator reviews it rather than editing it directly.

  4. 4.

    Limit staff access when needed

    Leave Users with access empty when every accepted Harbor Soho user can use the output. Select individual staff only when the output should be limited to specific accepted users such as Olivia Hart.

  5. 5.

    Configure the connection

    For network drivers such as ESC/POS, ESC/POS matrix, Star and ZPL, enter the host or IP address in the Connection section. USB, Android USB and KDS drivers do not show this network section because their transport is calculated without a network host.

  6. 6.

    Save and refresh settings

    Select Create or Save only after the required fields are complete. A successful save refreshes output devices and TPV settings so dependent TPV and KDS selectors use the current configuration.

Validations and limits

  • `name` is required before saving.
  • `code` is normalised and must be unique within the Harbor Soho location.
  • `driver_kind` must be one of the supported output drivers, and Antylogic derives `transport_kind` from the selected driver.
  • The UI requires `networkHost` for network drivers, even though a direct API client can omit the host if the rest of the payload is valid.
  • When `driverKind=zpl`, label width, label height and left margin must be valid numbers.
  • Empty `allowed_user_ids` means the device is available to all accepted users at the location; selected IDs must belong to accepted users in the same location.
  • The current UI does not expose `device_kind`, `terminal_id`, `connectionConfigExtras` or `driverConfigExtras` editors, even though the API and model support those fields.
  • Do not document UI creation of a full `device_kind=kds` output setup until that path is verified in the product/runtime.

Expected result

The location keeps an updated `tpv_output_devices` record, and Antylogic refreshes the related TPV settings so receipt, kitchen, control and KDS-dependent selectors can use the current output configuration.

Related articles