Skip to main content

CLI for controlling Brother VC-500W label printers over TCP/IP

Project description

Brother VC-500W Label Printer CLI

This repository contains a command-line tool for controlling a Brother VC-500W label printer over TCP/IP.

This project is a fork of https://gitlab.com/lenchan139/labelprinter-vc500w, which itself was forked from https://m7i.org/projects/labelprinter-linux-python-for-vc-500w/.

Licensed under AGPL-3.0-or-later. See LICENSE for details.

Disclaimer

This is an unofficial, community-maintained tool. It is not affiliated with or supported by Brother. You are responsible for how you use it, and it may behave unexpectedly or interact poorly with your printer.

Installation

On Debian/Ubuntu

You can install labelprinter-vc500w via deb-get:

sudo deb-get install labelprinter-vc500w

Alternatively, download the latest .deb package from the Releases page for this repository and install it with apt:

sudo apt install ./labelprinter-vc500w_<version>_all.deb

From PyPI

pipx install labelprinter-vc500w

Finding your printer

You must pass the printer's IP address with --host.

If you do not know the printer IP, you can find it with the official Brother app or by scanning your local network. On Debian and Ubuntu, one option is nbtscan:

sudo apt install nbtscan
nbtscan -v -s : 192.168.1.1/24 | grep "VC-500W"

Usage

You can either install this script (see above) or run it from a checkout of this repository.

Minimum request to print an image:

# if installed
bclprinter --host 192.168.5.5 --print-image /home/user/my_screenshot.jpeg

# from a checkout
./labelprinter.sh --host 192.168.5.5 --print-image /home/user/my_screenshot.jpeg

Print with additional options:

# if installed
bclprinter --host 192.168.5.5 --print-mode vivid --print-cut full --print-image /home/user/my_screenshot.jpeg

# from a checkout
./labelprinter.sh --host 192.168.5.5 --print-mode vivid --print-cut full --print-image /home/user/my_screenshot.jpeg

If a print job is done or jammed but the printer still appears locked, release the stale job lock with:

# if installed
bclprinter --host 192.168.5.5 --release JOB_ID

# from a checkout
./labelprinter.sh --host 192.168.5.5 --release JOB_ID

Command reference

The module can be started with the included labelprinter.sh helper script or via python3 -m labelprinter.

For the full CLI reference, please refer to the built-in help or the man page:

# if installed
bclprinter --help
man bclprinter

# from a checkout
./labelprinter.sh --help

Technical details

Read the original post, thank you. https://m7i.org/projects/labelprinter-linux-python-for-vc-500w/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

labelprinter_vc500w-1.1.tar.gz (21.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

labelprinter_vc500w-1.1-py3-none-any.whl (24.0 kB view details)

Uploaded Python 3

File details

Details for the file labelprinter_vc500w-1.1.tar.gz.

File metadata

  • Download URL: labelprinter_vc500w-1.1.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for labelprinter_vc500w-1.1.tar.gz
Algorithm Hash digest
SHA256 983e4bf991a10d27634e406db861fc561f6c105979ccabfdb6ece4283aa01a28
MD5 0dd7968fe1aff9f86f1311ca00e73921
BLAKE2b-256 185d7591323c0065504e06e61cc27c0d99999e0f52d602f4b59e91d819a6c990

See more details on using hashes here.

File details

Details for the file labelprinter_vc500w-1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for labelprinter_vc500w-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2e87723d937caed75e6e4a6ebf290bb7f9cd849073139884107627855715cfa6
MD5 8f4f501ce2772967a7215de0b5eb776e
BLAKE2b-256 03e2d490372394f79cbe8c43884053b51baaec6be8363b99af1fa000f352c4ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page