Solutions
Hardware
Software
Services
Support and Downloads
About Zebra
ZPL II, ZBI 2, Set-Get-Do, Mirror, WML Programming Guide
SGD Command Reference
ZPL II, ZBI 2, Set-Get-Do, Mirror, WML Programming Guide
ZPL II, ZBI 2, Set-Get-Do, Mirror, WML Programming Guide
Introduction
Firmware
Who Should Use This Document
ZPL Commands
How Commands Are Documented
Basic ZPL Exercises and Examples
Exercise 1: Specify a Location for an Entered Name
Font instruction
Rotation Commands
Reverse Printing a Field
Label Reverse Print
Mirror Image of Label
Print Orientation
Exercise 2: Boxes and Lines
Exercise 3: Bar Codes — ^B3 Code 39 Barcode
Exercise 4: ^SN — Serial Number Command
Exercise 5: Saving a template to memory. ^IS and image save and image load.
Exercise 6: ^DF and ^XF — Download Format and Recall Format
Exercise 7: Asian and Unicode Encodings
Allowed Characters in File Names
^A
^A@
^B0
^B1
^B2
^B3
^B4
^B5
^B7
^B8
^B9
^BA
^BB
^BC
^BD
^BE
^BF
^BI
^BJ
^BK
^BL
^BM
^BO
^BP
^BQ
^BR
^BS
^BT
^BU
^BX
^BY
^BZ
^CC ~CC
^CD ~CD
^CF
^CI
^CM
^CN
^CO
^CP
^CT ~CT
^CV
^CW
~DB
~DE
^DF
~DG
~DN
~DS
~DT
~DU
~DY
~EG
^FB
^FC
^FD
^FE
^FH
^FL
^FM
^FN
^FO
^FP
^FR
^FS
^FT
^FV
^FW
^FX
^GB
^GC
^GD
^GE
^GF
^GS
~HB
~HD
^HF
^HG
^HH
~HI
~HM
~HQ
~HS
^HT
~HU
^HV
^HW
^HY
^HZ
^ID
^IL
^IM
^IS
~JA
^JB
~JB
~JC
~JD
~JE
~JF
~JG
^JH
^JI
~JI
^JJ
~JL
^JM
~JN
~JO
~JP
~JQ
~JR
^JS
~JS
^JT
^JU
^JW
~JX
^JZ
~KB
^KD
^KL
^KN
^KP
^KV
^LF
^LH
^LL
^LR
^LS
^LT
^MA
^MC
^MD
^MF
^MI
^ML
^MM
^MN
^MP
^MT
^MU
^MW
^NC
~NC
^ND
^NI
~NR
^NS
~NT
^PA
^PF
^PH ~PH
~PL
^PM
~PM
^PN
^PO
^PP ~PP
^PQ
~PR
^PR
~PS
^PW
~RO
^SC
~SD
^SE
^SF
^SI
^SL
^SN
^SO
^SP
^SQ
^SR
^SS
^ST
^SX
^SZ
~TA
^TB
^TO
~WC
^WD
~WQ
^XA
^XB
^XF
^XG
^XS
^XZ
^ZZ
ZPL RFID Commands
^HL or ~HL
^HR
^RB
^RF
^RL
^RS
^RU
^RW
ZPL Wireless Commands
^KC
^NB
^NN
^NP
^NT
^NW
^WA
^WE
^WL - Set Leap
~WL - Print Network
^WP
^WR - Set Transmit
~WR - Reset Wireless
^WS
^WX
ZBI Commands
Introduction to Zebra Basic Interpreter (ZBI)
Printers, ZBI Keys, & ZBI Versions
Command and Function Reference Format
Function Rules
Command/Function NAME
Section Organization
Writing ZBI Programs
Editing Commands
NEW
REM
! (EXCLAMATION MARK)
LIST
AUTONUM
RENUM
ECHO
Running and Debugging Commands
RUN
CTRL-C
RESTART
STEP
DEBUG
TRACE
BREAK
ADDBREAK
DELBREAK
ZPL
Base Types and Expressions
Variable Names
Variable Declarations
Constants
Arrays
Assignment
LET
Numeric Expressions
Order of Precedence
String Concatenation (&)
Sub-strings
Boolean Expressions
Combined Boolean Expressions
Order of Precedence
Control and Flow
IF Statements
DO Loops
FOR Loops
GOTO/GOSUB
SUB
EXIT
END
Input and Output
OPEN
CLOSE
DATAREADY
SERVERSOCKET
SERVERCLOSE
CLIENTSOCKET
ACCEPT
Reading and Writing
INPUT
PRINT
OUTBYTE
INBYTE
READ
WRITE
SEARCHTO$
Port Usage Examples
Physical Ports (Serial, Parallel, USB, Bluetooth®)
ZPL Parser
TCP Client
TCP Server
UDP Client
UDP Server
E-mail
File System
Runtime Access
STORE
LOAD
DIR
DELETE
Comma Separated Values (CSV)
CSVLOAD
CSV File Information
CSVSTORE
TXTLOAD
TXTSTORE
Events
ZBI Key Names
REGISTEREVENT
UNREGISTEREVENT
HANDLEEVENT
TRIGGEREVENT
Systems
ISERROR
ISWARNING
SLEEP
SETERR
CLRERR
ON ERROR
Applicator Functions
AUXPORT_STEALPIN
AUXPORT_SETPIN
AUXPORT_GETPIN
AUXPORT_RELEASEPIN
String Functions
LCASE$
CHR$
LTRIM$
REPEAT$
RTRIM$
SPLIT
SPLITCOUNT
UCASE$
EXTRACT$
ORD
POS
LEN
Math Functions
STR$
MAX
MIN
MAXNUM
MOD
VAL
INTTOHEX$
HEXTOINT
Array Functions
REDIM
INSERTROW
DELROW
ROWSIZE
COLUMNSIZE
FIND
Time and Date Functions
DATE$
TIME$
DATE
TIME
Set/Get/Do Interactions
SETVAR
GETVAR$
Example Programs
Array Program
CSV Program
DPI Conversion Program
Email Program
Extraction 1 Program
Extraction 2 Program
Front Panel Control
Recall Program
Scale Program
About SGD Printer Commands
Overview
setvar Command
getvar Command
do Command
Command Structure
How to Send Multiple SGD Commands
JSON (JavaScript Object Notation)
Configuring JSON Usage for Communications
Getvar using JSON
Setvar using JSON
Get an SGD Branch
Get an allvalues Report
Get an allconfig Report
SGD Command Reference
alerts.add
alerts.conditions
alerts.configured
alerts.destinations
alerts.http.authentication.add
alerts.http.authentication.entries
alerts.http.authentication.remove
alerts.http.logging.clear
alerts.http.logging.entries
alerts.http.logging.max_entries
alerts.http.proxy
alerts.send_current_status_alerts
alerts.tracked_settings.clear_log
alerts.tracked_settings.log_tracked
alerts.tracked_settings.max_log_entries
alerts.tracked_sgds.log
alerts.tracked_sgds.max_log_entries
alerts.tracked_sgds.zbi_notified
apl.enable
apl.framework_version
apl.settings
apl.version
appl.link_os_version
appl.option_board_version
appl.bootblock
appl.date
appl.name
capture.channel1.count
capture.channel1.data.mime
capture.channel1.data.raw
capture.channel1.delimiter
capture.channel1.max_length
capture.channel1.port
CISDFCRC16 Download Files
comm.baud
comm.halt
comm.mode
comm.pnp_option
comm.type
comm.parity
comm.stop_bits
cradle.comm.baud
cradle.comm.handshake
cutter.clean_cutter
device.allow_firmware_downloads
device.applicator.data_ready
device.applicator.end_print
device.applicator.feed
device.applicator.media_out
device.applicator.pause
device.applicator.reprint
device.applicator.rfid_void
device.applicator.ribbon_low
device.applicator.ribbon_out
device.applicator.service_required
device.applicator.start_print
device.bluetooth_installed
device.command_override.active
device.command_override.add
device.command_override.clear
device.command_override.list
device.company_contact
device.configuration_number
device.cpcl_synchronous_mode
device.cutter_installed
device.download_connection_timeout
device.download_interactive_mode
device.epl_legacy_mode
device.feature.bluetooth_le
device.feature.mcr
device.feature.nfc
device.feature.ribbon_cartridge
device.feature.802_11ac
device.feature.802_11ax
device.feature.head_element_test
device.friendly_name
device.frontpanel.feedenabled
device.frontpanel.key_press
device.frontpanel.line1
device.frontpanel.line2
device.frontpanel.xml
device.host_identification
device.host_status
device.idle_display_format
device.idle_display_value
device.internal_wired_setting_location
device.jobs_print
device.job_log.total_jobs_logged
device.languages
device.light.cover_open_brightness
device.light.head_open_brightness
device.location
device.loader_version
device.ltu_installed
device.mcu_communication.revision
device.mcu_cutter.revision
device.mcu_cutter.desired_revision
device.mcu_io_expand_rev
device.mcu_io_expand.desired_rev
device.orientation
device.pause
device.pnp_option
device.pmcu.revision
device.position.accuracy
device.position.altitude
device.position.latitude
device.position.longitude
device.print_2key
device.print_reprogram_2key
device.printhead.test.summary
device.printhead.odometer
device.printhead.test.detail
device.product_name_submodel
device.prompted_network_reset
device.prompted_default_network
device.prompted_reset
device.protected_mode
device.protected_mode_allowed
device.reset
device.reset_button_enable
device.restore_defaults
device.rewinder_installed
device.save_2key
device.sensor_select
device.sensor_profile
device.serial_number.option_board_date
device.serial_numbers.control_panel_date
device.serial_numbers.mlb_date
device.serial_numbers.processor
device.serial_numbers.applicator_option_board_date
device.serial_numbers.wired_ethernet_option_board
device.serial_numbers.wired_ethernet_option_board_date
device.serial_numbers.applicator_option_board
device.serial_numbers.cutter
device.serial_numbers.cutter_date
device.serial_numbers.printhead
device.serial_numbers.printhead_date
device.serial_numbers.usb_host_option_board_date
device.serial_numbers.usb_host_option_board
device.serial_numbers.parallel_option_board
device.serial_numbers.parallel_option_board_date
device.set_clock_to_build_date
device.slot_1
device.slot_2
device.super_host_status
device.syslog.clear_log
device.syslog.configuration
device.syslog.enable
device.syslog.entries
device.syslog.log_max_file_size
device.syslog.save_local_file
device.applicator.data_ready_activation
device.applicator.error_on_pause
device.applicator.start_print_mode
device.applicator.voltage
device.unique_id
device.unpause
device.uptime
device.user_p1
device.user_p2
device.user_vars.set_range
device.user_vars.create
device.xml.enable
device.feature.lighted_arrows
device.light.ribbon_path_brightness
device.light.media_path_brightness
device.zuid
display.backlight
display.backlight_on_time
display.batch_counter
display.bluetooth.mac
display.calibrate
display.language
display.load_card
display.password.level
display.root_wml
display.text
file.capture_response.destination
head.resolution.in_dpi
ezpl.head_close_action
ezpl.label_length_max
ezpl.label_sensor
ezpl.manual_calibration
ezpl.media_type
ezpl.power_up_action
ezpl.print_method
ezpl.print_width
ezpl.reprint_mode
ezpl.take_label
ezpl.tear_off
file.cert.expiration
file.cert.supported_curves
file.delete
file.dir
file.dir_format
file.type
file.run
formats.cancel_all
head.authenticated
head.darkness_switch_enable
head.darkness_switch
head.element_test
head.latch
input.capture
interface.network.active.arp_interval
interface.network.active.cable_type
interface.network.active.dhcp_received_host_name
interface.network.active.gateway
interface.network.active.ip_addr
interface.network.active.mac_addr
interface.network.active.mac_raw
interface.network.active.netmask
interface.network.active.protocol
interface.network.active.protocol_error
interface.network.active.rx_errors
interface.network.active.rx_packets
interface.network.active.server_address
interface.network.active.speed
interface.network.active.tx_errors
interface.network.active.tx_packets
interface.network.active.wins_addr
interface.network.settings_require_reset
ip.firewall.authentication.add
ip.firewall.authentication.entries
ip.firewall.authentication.remove
ip.firewall.proxy
ip.firewall.whitelist_in
ip.https.enable
ip.https.port
ip.ping_gateway_interval
ip.pop3.print_body
ip.pop3.print_headers
ip.pop3.save_attachments
ip.pop3.verbose_headers
ip.tls.enable
ip.tls.port
ip.tls.port_json_config
log.reboot.code
log.reboot.codes
log.reboot.reason
log.reboot.report
mcr.crypt.enabled
mcr.cancel
mcr.crypt.key_mgmt
mcr.crypt.algorithm
mcr.out
mcr.revision
media.bar_location
media.cartridge.darkness
media.cartridge.labels_remaining
media.cartridge.width
media.cartridge.total_label_cnt
media.cartridge.speed
media.cartridge.length
media.cartridge.inserted
media.cartridge.part_number
media.cut_now
media.darkness_mode
media.draft_mode
media.dynamic_length_calibration
media.feed_skip
media.media_low.external
media.media_low.warning
media.part_number
media.present.cut_amount
media.present.eject
media.present.length_addition
media.present.loop_length
media.present.loop_length_max
media.present.cut_margin
media.present.present_timeout
media.present.present_type
media.printmode
media.speed
media.serial_number
media.tof
memory.flash_free
memory.flash_size
memory.ram_free
memory.ram_size
mqtt.enable
mqtt.logging.clear
mqtt.logging.entries
mqtt.logging.max_entries
mqtt.restore_defaults
mqtt.conn[1|2].clean_session_flag
mqtt.conn[1|2].password
mqtt.conn[1|2].ping_interval
mqtt.conn[1|2].reset_now
mqtt.conn[1|2].reset_required
mqtt.conn[1|2].retry_interval_random_max
mqtt.conn[1|2].server_address
mqtt.conn[1|2].tenant_id
mqtt.conn[1|2].username
netmanage.avalanche.agent_addr
netmanage.avalanche.available_agent
netmanage.avalanche.available_port
netmanage.avalanche.encryption_type
netmanage.avalanche.interval
netmanage.avalanche.interval_update
netmanage.avalanche.model_name
netmanage.avalanche.set_property
netmanage.avalanche.startup_update
netmanage.avalanche.tcp_connection_timeout
netmanage.avalanche.terminal_id
netmanage.avalanche.text_msg.beep
netmanage.avalanche.text_msg.display
netmanage.avalanche.text_msg.print
netmanage.avalanche.udp_timeout
netmanage.error_code
netmanage.state_code
netmanage.status_code
odometer.cut_marker_count
odometer.headclean
odometer.headnew
odometer.label_dot_length
odometer.media_marker_count
odometer.media_marker_count1
odometer.media_marker_count2
odometer.net_media_length
odometer.net_ribbon_length
odometer.retracts_count
odometer.rfid.valid_resettable
odometer.rfid.void_resettable
odometer.total_cuts
odometer.total_print_length
odometer.total_label_count
odometer.user_label_count
odometer.user_total_cuts
odometer.user_label_count[1|2]
odometer.latch_open_count
parallel_port.mode
parallel_port.present
power.average_current
power.battery_led_blink_rate
power.battery_led_enable
power.battery_led_off_duration
power.battery_led_on_duration
power.battery_type
power.dtr_power_off
power.energy_star.enable
power.energy_star.timeout
power.label_queue.shutdown
power.power_on_mode
power.shutdown
power.voltage
power.wake.radio
power.current
power.temperature
power.percent_health
power.part_number
power.sleep.cradle
power.remaining_capacity
power.cycle_count
print.legacy_compatibility
print.tone
print.troubleshooting_label_print
ribbon.serial_number
ribbon.part_number
ribbon.cartridge.part_number
ribbon.cartridge.length_remaining
ribbon.cartridge.length
ribbon.cartridge.authenticated
ribbon.cartridge.inserted
ribbon.coating
ribbon.tension
rtc.exists
rtc.date
rtc.time
rtc.timezone
rtc.unix_timestamp
sensor.air_pressure.current_reading
sensor.ambient_light.current_reading
sensor.battery.in_volts
sensor.back_bar.brightness
sensor.back_bar.ppr_out_thold
sensor.back_bar.cur
sensor.cover_open
sensor.front_bar.ppr_out_thold
sensor.front_bar.cur
sensor.front_bar.thold
sensor.front_bar.gain
sensor.front_bar.brightness
sensor.front_bar.offset
sensor.back_bar.offset
sensor.gap.thold
sensor.gap.offset
sensor.gap.gain
sensor.gap.brightness
sensor.head.temp_avg
sensor.head.temp_celsius
sensor.head.temp
sensor.magnetometer.current_reading
sensor.object_temperature.current_reading
sensor.peel.thold
sensor.peel.gain
sensor.paper_supply
sensor.peeler
sensor.peel.brightness
sensor.proximity.current_reading
sensor.width.in_dots
sensor.width.cur
sensor.self_adjusting_enable
usb.device.device_id_string
usb.device.device_unique_id
usb.device.device_version
usb.device.manufacturer_string
usb.device.product_id
usb.device.product_string
usb.device.serial_string
usb.device.vendor_id
usb.halt
usb.host.config_info_to_usb
usb.host.fn_field_data
usb.host.fn_last_field
usb.host.hid_count
usb.host.keyboard_input
usb.host.lock_out
usb.host.mass_storage_count
usb.host.read_list
usb.host.read_list_print_delay
usb.host.template_list
usb.host.template_print_amount
usb.host.write_list
usb.mirror.appl_path
usb.mirror.auto
usb.mirror.enable
usb.mirror.enabled
usb.mirror.error_retry
usb.mirror.feedback.auto
usb.mirror.feedback.odometer
usb.mirror.feedback.path
usb.mirror.fetch
usb.mirror.last_error
usb.mirror.last_time
usb.mirror.path
usb.mirror.reset_delay
usb.mirror.success
usb.mirror.success_time
zbi.control.add_breakpoint
zbi.control.break
zbi.control.clear_breakpoints
zbi.control.delete_breakpoint
zbi.control.line_number
zbi.control.restart
zbi.control.run
zbi.control.step
zbi.control.terminate
zbi.control.variable_name
zbi.control.variable_value
zbi.enable
zbi.key
zbi.last_error
zbi.program_list
zbi.reseller_key
zbi.revision
zbi.running_program_name
zbi.start_info.execute
zbi.start_info.file_name
zbi.start_info.memory_alloc
zbi.state
zpl.calibrate
zpl.format_prefix
zpl.caret
zpl.control_character
zpl.delimiter
zpl.label_length
zpl.label_length_always
zpl.left_position
zpl.system_error
zpl.system_status
zpl.zpl_mode
zpl.zpl_override
zpl.relative_darkness
SGD RFID Commands
rfid.adaptive_antenna
rfid.antenna_sweep
rfid.country_code
rfid.enable
rfid.error.response
rfid.hop_table_version
rfid.position.program
rfid.reader_1.antenna_port
rfid.reader_1.power.read
rfid.reader_1.power.write
rfid.reader_1.power.single_power
rfid.reader_1.firmware_version
rfid.reader_1.hardware_version
rfid.reader_1.model
rfid.recipe_version
rfid.region_code
rfid.tag.calibrate
rfid.tag.data
rfid.tag.read.content
rfid.tag.read.execute
rfid.tag.read.result_line1
rfid.tag.read.result_line2
rfid.tag.read.result_line1_alternate
rfid.tag.read.result_line2_alternate
rfid.tag.test
rfid.tag.test.content
rfid.tag.test.execute
rfid.tag.test.result_line1
rfid.tag.test.result_line2
rfid.tag.type
rfid.log.enabled
rfid.log.entries
rfid.log.clear
SGD Wired Commands
external_wired.check
external_wired.ip.addr
external_wired.ip.arp_interval
external_wired.ip.default_addr_enable
external_wired.ip.dhcp.cid_all
external_wired.ip.dhcp.cid_enable
external_wired.ip.dhcp.cid_prefix
external_wired.ip.dhcp.cid_suffix
external_wired.ip.dhcp.cid_type
external_wired.ip.gateway
external_wired.ip.netmask
external_wired.ip.port
external_wired.ip.protocol
external_wired.ip.timeout.enable
external_wired.ip.timeout.value
external_wired.ip.v6.addr
external_wired.ip.v6.gateway
external_wired.ip.v6.prefix_length
external_wired.mac_addr
external_wired.mac_raw
internal_wired.8021x.password
internal_wired.8021x.peap.validate_server_certificate
internal_wired.8021x.peap.anonymous_identity
internal_wired.8021x.private_key_password
internal_wired.8021x.security
internal_wired.8021x.ttls_anonymous_identity
internal_wired.8021x.ttls_tunnel
internal_wired.8021x.username
internal_wired.activity_led
internal_wired.auto_switchover
internal_wired.enable
internal_wired.installed
internal_wired.ip.addr
internal_wired.ip.arp_interval
internal_wired.ip.default_addr_enable
internal_wired.ip.dhcp.arp_verify
internal_wired.ip.dhcp.cache_ip
internal_wired.ip.dhcp.cid_all
internal_wired.ip.dhcp.cid_enable
internal_wired.ip.dhcp.cid_prefix
internal_wired.ip.dhcp.cid_suffix
internal_wired.ip.dhcp.cid_type
internal_wired.ip.dhcp.lease.last_attempt
internal_wired.ip.dhcp.lease.length
internal_wired.ip.dhcp.lease.server
internal_wired.ip.dhcp.lease.time_left
internal_wired.ip.dhcp.option12
internal_wired.ip.dhcp.option12_format
internal_wired.ip.dhcp.option12_value
internal_wired.ip.dhcp.requests_per_session
internal_wired.ip.dns.domain
internal_wired.ip.dns.servers
internal_wired.ip.gateway
internal_wired.ip.netmask
internal_wired.ip.port
internal_wired.ip.port_alternate
internal_wired.ip.port_json_config
internal_wired.ip.protocol
internal_wired.ip.timeout.enable
internal_wired.ip.timeout.value
internal_wired.ip.wins.addr
internal_wired.ip.wins.permanent_source
internal_wired.mac_addr
internal_wired.mac_raw
SGD Wireless Commands
bluetooth.address
bluetooth.afh_map
bluetooth.afh_map_curr
bluetooth.afh_mode
bluetooth.allow_non_display_numeric_comparison
bluetooth.authentication
bluetooth.bluetooth_pin
bluetooth.clear_bonding_cache
bluetooth.date
bluetooth.discoverable
bluetooth.enable
bluetooth.enable_reconnect
bluetooth.friendly_name
bluetooth.json_config_channel_enable
bluetooth.power_class
bluetooth.le.controller_mode
bluetooth.le.power_class
bluetooth.le.minimum_security
bluetooth.page_scan_window
bluetooth.local_name
bluetooth.minimum_security_mode
bluetooth.radio_auto_baud
bluetooth.radio_version
bluetooth.short_address
bluetooth.version
card.mac_addr
card.inserted
ip.active_network
ip.addr
ip.arp_interval
ip.bootp.enable
ip.dhcp.arp_verify
ip.dhcp.auto_provision_enable
ip.dhcp.cache_ip
ip.dhcp.cid_all
ip.dhcp.cid_enable
ip.dhcp.cid_prefix
ip.dhcp.cid_suffix
ip.dhcp.cid_type
ip.dhcp.cid_value
ip.dhcp.enable
ip.dhcp.lease.last_attempt
ip.dhcp.lease.server
ip.dhcp.lease.time_left
ip.dhcp.ntp.enable
ip.dhcp.ntp.received_servers
ip.dhcp.option12
ip.dhcp.option12_format
ip.dhcp.option12_value
ip.dhcp.request_timeout
ip.dhcp.requests_per_session
ip.dhcp.session_interval
ip.dhcp.user_class_id
ip.dhcp.vendor_class_id
ip.dns.domain
ip.dns.servers
ip.ftp.enable
ip.ftp.execute_file
ip.ftp.request_password
ip.gateway
ip.http.admin_name
ip.http.admin_password
ip.http.custom_link_name
ip.http.custom_link_url
ip.http.enable
ip.http.faq_url
ip.http.port
ip.lpd.enable
ip.mac_raw
ip.mirror.appl_path
ip.mirror.auto
ip.mirror.error_retry
ip.mirror.feedback.auto
ip.mirror.feedback.freq
ip.mirror.feedback.odometer
ip.mirror.feedback.path
ip.mirror.fetch
ip.mirror.freq
ip.mirror.freq_hours
ip.mirror.interface
ip.mirror.last_error
ip.mirror.last_time
ip.mirror.mode
ip.mirror.password
ip.mirror.path
ip.mirror.reset_delay
ip.mirror.server
ip.mirror.success
ip.mirror.success_time
ip.mirror.username
ip.mirror.version
ip.netmask
ip.ntp.enable
ip.ntp.log
ip.ntp.servers
ip.pop3.enable
ip.pop3.password
ip.pop3.poll
ip.pop3.server_addr
ip.pop3.username
ip.port
ip.port_alternate
ip.port_json_config
ip.port_single_conn
ip.port_single_conn_idle_timeout
ip.primary_network
ip.smtp.domain
ip.smtp.enable
ip.smtp.server_addr
ip.snmp.get_community_name
ip.snmp.set_community_name
ip.snmp.trap_community_name
ip.snmp.enable
ip.tcp.enable
ip.telnet.enable
ip.tcp.nagle_algorithm
ip.udp.enable
weblink.cloud_connect.enable
weblink.enable
weblink.ip.conn[1|2].authentication.add
weblink.ip.conn[1|2].authentication.entries
weblink.ip.conn[1|2].authentication.remove
weblink.ip.conn[1|2].location
weblink.ip.conn[1|2].num_connections
weblink.ip.conn[1|2].maximum_simultaneous_connections
weblink.ip.conn[1|2].proxy
weblink.ip.conn[1|2].retry_interval
weblink.ip.conn1.test.location
weblink.ip.conn[1|2].test.retry_interval
weblink.ip.conn1.retry_interval_random_max
weblink.ip.conn1.test.test_on
weblink.logging.clear
weblink.logging.entries
weblink.logging.max_entries
weblink.printer_reset_required
weblink.restore_defaults
weblink.zebra_connector.authentication.add
weblink.zebra_connector.authentication.entries
weblink.zebra_connector.authentication.remove
weblink.zebra_connector.enable
weblink.zebra_connector.proxy
weblink.zebra_connector.version
wlan.11ac.80mhz_enable
wlan.11d.enable
wlan.11n.20mhz_only
wlan.11n.aggregation
wlan.11n.greenfield
wlan.11n.rifs
wlan.11n.short_gi_40mhz
wlan.11n.short_gi_20mhz
wlan.8021x.enable
wlan.8021x.validate_peap_server_certificate
wlan.8021x.peap.anonymous_identity
wlan.8021x.authentication
wlan.8021x.eap.password
wlan.8021x.eap.username
wlan.8021x.eap.privkey_password
wlan.8021x.peap.peap_password
wlan.8021x.peap.privkey_password
wlan.8021x.peap.peap_username
wlan.8021x.ttls_anonymous_identity
wlan.active_channels
wlan.adhoc_last_channel
wlan.authenticated
wlan.authentication_error
wlan.available
wlan.allowed_band
wlan.adhocautomode
wlan.adhocchannel
wlan.associated
wlan.auth_type
wlan.band_preference
wlan.bssid
wlan.channel
wlan.channel_mask
wlan.country_code
wlan.current_tx_rate
wlan.enable
wlan.encryption_index
wlan.encryption_key
wlan.encryption_mode
wlan.essid
wlan.firmware_version
wlan.ip.addr
wlan.ip.arp_interval
wlan.ip.default_addr_enable
wlan.ip.dhcp.arp_verify
wlan.ip.dhcp.cache_ip
wlan.ip.dhcp.cid_all
wlan.ip.dhcp.cid_enable
wlan.ip.dhcp.cid_prefix
wlan.ip.dhcp.cid_suffix
wlan.ip.dhcp.cid_type
wlan.ip.dhcp.lease.last_attempt
wlan.ip.dhcp.lease.length
wlan.ip.dhcp.lease.server
wlan.ip.dhcp.lease.time_left
wlan.ip.dhcp.option12
wlan.ip.dhcp.option12_format
wlan.ip.dhcp.option12_value
wlan.ip.dhcp.request_timeout
wlan.ip.dhcp.requests_per_session
wlan.ip.dhcp.session_interval
wlan.ip.dns.servers
wlan.ip.gateway
wlan.ip.netmask
wlan.ip.port
wlan.ip.port_alternate
wlan.ip.port_json_config
wlan.ip.protocol
wlan.ip.timeout.enable
wlan.ip.timeout.value
wlan.ip.wins.addr
wlan.ip.wins.permanent_source
wlan.keep_alive.enable
wlan.keep_alive.timeout
wlan.kerberos.kdc
wlan.kerberos.mode
wlan.kerberos.password
wlan.kerberos.realm
wlan.kerberos.username
wlan.leap_mode
wlan.leap_password
wlan.leap_username
wlan.mac_addr
wlan.mac_raw
wlan.operating_mode
wlan.password
wlan.permitted_channels
wlan.pmf
wlan.poor_signal_threshold
wlan.preamble
wlan.private_key_password
wlan.region_code
wlan.roam.interchannel_delay
wlan.roam.interval
wlan.roam.max_chan_scan_time
wlan.roam.max_fail
wlan.roam.monitor
wlan.roam.neighbor_assist
wlan.roam.rssi
wlan.roam.signal
wlan.rts_cts_enabled
wlan.security
Supporting SGDs for Different Security Types
wlan.signal_noise
wlan.signal_quality
wlan.signal_strength
wlan.station_name
wlan.translation_disable_clear
wlan.tx_power
wlan.tx_rate
wlan.user_channel_list
wlan.username
wlan.waveagent.enable
wlan.waveagent.udp_port
wlan.wep.auth_type
wlan.wep.index
wlan.wep.key1
wlan.wep.key2
wlan.wep.key3
wlan.wep.key4
wlan.wpa.psk
wlan.wep.key_format
wlan.wpa.groupkey_ciphersuite
wlan.wpa.pairwise_ciphersuite
wlan.wpa.timecheck
wlan.wpa.wpa_version
Zebra Code Pages
Zebra Code Page 850 — Latin Character Set
Zebra Code Page 1250 — Central and Eastern European Latin Character Set
Zebra Code Page 1252— Latin Character Set
Zebra Code Page 1253 — Modern Greek Character Set
Zebra Code Page 1254 — Turkish Character Set
Zebra Code Page 1255 — Hebrew Character Set
ASCII
Fonts and Barcodes
Standard Printer Fonts
Proportional and Fixed Spacing
Scalable Versus Bitmapped Fonts
Font Matrices
Barcodes
Basic Format for Bar Codes
Barcode Field Instructions
Bar Code Command Groups
Mod 10 and Mod 43 Check Digits
Mod 10 Check Digit
Mod 43 Check Digit
Error Detection Protocol
Introduction
What is a Protocol?
How Protocols Work
Request Packet Formats from the Host Computer
Header Block Fields
Data Block Fields
Response From the Zebra Printer
Zebra Packet Response
Header Block Fields
Data Block Fields
Disguising Control Code Characters
Rules for Transactions
Error Detection Protocol Application
Error Conditions and System Faults
Time-Out Error Conditions and Responses
How the Zebra Printer Processes a Request Packet
Exceptions
How the Zebra Printer Responds to Host Status
ZB64 Encoding and Compression
Introduction to B64 and Z64
B64 and Z64 Encoding
Field Interactions
Real Time Clock
Control Panel Programming
Real Time Clock Parameters
Idle Display
RTC Date
RTC Time
RTC General Information
First Day of the Week Affects Calendar Week
Time and Date Precision
ZPL II Samples
ZBI Character Set
SGD Command Support
SGDs Supported for Industrial Printers
SGDs Supported for Desktop Printers
SGDs Supported for Mobile Printers
Mirror
Mirror Overview
Benefits
Professional Services for Mirror Configuration
Requirements
Supported Printers and Print Server Types
How Mirror Works
Mirror Process Summary
Mirror Process Details
Creating ZPL Files for Use in the <update-root>/files Directory
Wireless Markup Language (WML)
WML Overview
WML Details
Supported Printers
Professional Services for WML Content Creation
WML Tags
Using WML
Create a Sample index.wml File
Prepare the Printer to Receive WML Content via FTP
Send WML Content to the Printer via FTP
Resetting the ip.ftp.execute_file Setting
Sending WML Content to the Printer via the CISDFCRC16 Command
Retrieving WML Content from the Printer using the file.type Command
Using .nrd Files from WML Menus
Removing WML or .nrd Files from the Printer using the file.delete Command
WML Examples
Example 1
Example 2
Example 3
Example 4
Example 5
Troubleshooting Scenarios
Using Weblink
When Should Weblink be Used?
Configuring Weblink
Basic Configuration
When a Proxy Server is Part of the Network Configuration
When HTTP Authentication is Necessary
Additional Firewall Configuration
Difference Between Conn1 and Conn2
Enable Logging
Navigating the Log Output
SSL/TLS Certificate Errors
Other Typical Errors
Troubleshooting
HTTP Messages
HTTP POST Alerts
Configuring Alerts Where the Alert Destination is HTTP POST
How to Parse via PHP
Basic Configuration
When a Proxy Server is Part of the Network Configuration
When HTTP Authentication is Necessary
Enabling Logging
Navigating the Log Output
Understanding Errors in the Alerts HTTP Log
Troubleshooting
HTTP Messages
Advanced Techniques
Special Effects for Print Fields
Serialized Data
Variable Data
Stored Formats
Initialize/Erase Stored Formats
Download Format Command
Field Number Command
Recall Stored Format Command
Control Commands
Test and Setup Commands
Calibration and Media Feed Commands
Cancel/Clear Commands
Printer Control Commands
Set Dots/Millimeter
Host Status Commands
Changing Delimiters and Command Prefixes
Communication Diagnostics Commands
Graphic Commands
Image Move
Working with Label Formats as Graphics
Working with Hex Graphic Images
Alternative Data Compression Scheme for ~DG and ~DB Commands
Recalling a Hexadecimal Graphic Image
Reducing Download Time of Graphic Images
Transferring Object Between Storage Devices
Deleting Graphics from Memory
Defining and Using the AUTOEXEC.ZPL Function
Memory, Flash Cards, and Font Cards
Shortcuts and Alternate Schemes for Writing ZPL II Scripts
Font Shortcuts
PDFium License
SGD Command Reference
SGD Command Reference
The SGD commands are described in this section of the programming guide.
alerts.add
alerts.conditions
alerts.configured
alerts.destinations
alerts.http.authentication.add
alerts.http.authentication.entries
alerts.http.authentication.remove
alerts.http.logging.clear
alerts.http.logging.entries
alerts.http.logging.max_entries
alerts.http.proxy
alerts.send_current_status_alerts
alerts.tracked_settings.clear_log
alerts.tracked_settings.log_tracked
alerts.tracked_settings.max_log_entries
alerts.tracked_sgds.log
alerts.tracked_sgds.max_log_entries
alerts.tracked_sgds.zbi_notified
apl.enable
apl.framework_version
apl.settings
apl.version
appl.link_os_version
appl.option_board_version
appl.bootblock
appl.date
appl.name
capture.channel1.count
capture.channel1.data.mime
capture.channel1.data.raw
capture.channel1.delimiter
capture.channel1.max_length
capture.channel1.port
CISDFCRC16 Download Files
comm.baud
comm.halt
comm.mode
comm.pnp_option
comm.type
comm.parity
comm.stop_bits
cradle.comm.baud
cradle.comm.handshake
cutter.clean_cutter
device.allow_firmware_downloads
device.applicator.data_ready
device.applicator.end_print
device.applicator.feed
device.applicator.media_out
device.applicator.pause
device.applicator.reprint
device.applicator.rfid_void
device.applicator.ribbon_low
device.applicator.ribbon_out
device.applicator.service_required
device.applicator.start_print
device.bluetooth_installed
device.command_override.active
device.command_override.add
device.command_override.clear
device.command_override.list
device.company_contact
device.configuration_number
device.cpcl_synchronous_mode
device.cutter_installed
device.download_connection_timeout
device.download_interactive_mode
device.epl_legacy_mode
device.feature.bluetooth_le
device.feature.mcr
device.feature.nfc
device.feature.ribbon_cartridge
device.feature.802_11ac
device.feature.802_11ax
device.feature.head_element_test
device.friendly_name
device.frontpanel.feedenabled
device.frontpanel.key_press
device.frontpanel.line1
device.frontpanel.line2
device.frontpanel.xml
device.host_identification
device.host_status
device.idle_display_format
device.idle_display_value
device.internal_wired_setting_location
device.jobs_print
device.job_log.total_jobs_logged
device.languages
device.light.cover_open_brightness
device.light.head_open_brightness
device.location
device.loader_version
device.ltu_installed
device.mcu_communication.revision
device.mcu_cutter.revision
device.mcu_cutter.desired_revision
device.mcu_io_expand_rev
device.mcu_io_expand.desired_rev
device.orientation
device.pause
device.pnp_option
device.pmcu.revision
device.position.accuracy
device.position.altitude
device.position.latitude
device.position.longitude
device.print_2key
device.print_reprogram_2key
device.printhead.test.summary
device.printhead.odometer
device.printhead.test.detail
device.product_name_submodel
device.prompted_network_reset
device.prompted_default_network
device.prompted_reset
device.protected_mode
device.protected_mode_allowed
device.reset
device.reset_button_enable
device.restore_defaults
device.rewinder_installed
device.save_2key
device.sensor_select
device.sensor_profile
device.serial_number.option_board_date
device.serial_numbers.control_panel_date
device.serial_numbers.mlb_date
device.serial_numbers.processor
device.serial_numbers.applicator_option_board_date
device.serial_numbers.wired_ethernet_option_board
device.serial_numbers.wired_ethernet_option_board_date
device.serial_numbers.applicator_option_board
device.serial_numbers.cutter
device.serial_numbers.cutter_date
device.serial_numbers.printhead
device.serial_numbers.printhead_date
device.serial_numbers.usb_host_option_board_date
device.serial_numbers.usb_host_option_board
device.serial_numbers.parallel_option_board
device.serial_numbers.parallel_option_board_date
device.set_clock_to_build_date
device.slot_1
device.slot_2
device.super_host_status
device.syslog.clear_log
device.syslog.configuration
device.syslog.enable
device.syslog.entries
device.syslog.log_max_file_size
device.syslog.save_local_file
device.applicator.data_ready_activation
device.applicator.error_on_pause
device.applicator.start_print_mode
device.applicator.voltage
device.unique_id
device.unpause
device.uptime
device.user_p1
device.user_p2
device.user_vars.set_range
device.user_vars.create
device.xml.enable
device.feature.lighted_arrows
device.light.ribbon_path_brightness
device.light.media_path_brightness
device.zuid
display.backlight
display.backlight_on_time
display.batch_counter
display.bluetooth.mac
display.calibrate
display.language
display.load_card
display.password.level
display.root_wml
display.text
file.capture_response.destination
head.resolution.in_dpi
ezpl.head_close_action
ezpl.label_length_max
ezpl.label_sensor
ezpl.manual_calibration
ezpl.media_type
ezpl.power_up_action
ezpl.print_method
ezpl.print_width
ezpl.reprint_mode
ezpl.take_label
ezpl.tear_off
file.cert.expiration
file.cert.supported_curves
file.delete
file.dir
file.dir_format
file.type
file.run
formats.cancel_all
head.authenticated
head.darkness_switch_enable
head.darkness_switch
head.element_test
head.latch
input.capture
interface.network.active.arp_interval
interface.network.active.cable_type
interface.network.active.dhcp_received_host_name
interface.network.active.gateway
interface.network.active.ip_addr
interface.network.active.mac_addr
interface.network.active.mac_raw
interface.network.active.netmask
interface.network.active.protocol
interface.network.active.protocol_error
interface.network.active.rx_errors
interface.network.active.rx_packets
interface.network.active.server_address
interface.network.active.speed
interface.network.active.tx_errors
interface.network.active.tx_packets
interface.network.active.wins_addr
interface.network.settings_require_reset
ip.firewall.authentication.add
ip.firewall.authentication.entries
ip.firewall.authentication.remove
ip.firewall.proxy
ip.firewall.whitelist_in
ip.https.enable
ip.https.port
ip.ping_gateway_interval
ip.pop3.print_body
ip.pop3.print_headers
ip.pop3.save_attachments
ip.pop3.verbose_headers
ip.tls.enable
ip.tls.port
ip.tls.port_json_config
log.reboot.code
log.reboot.codes
log.reboot.reason
log.reboot.report
mcr.crypt.enabled
mcr.cancel
mcr.crypt.key_mgmt
mcr.crypt.algorithm
mcr.out
mcr.revision
media.bar_location
media.cartridge.darkness
media.cartridge.labels_remaining
media.cartridge.width
media.cartridge.total_label_cnt
media.cartridge.speed
media.cartridge.length
media.cartridge.inserted
media.cartridge.part_number
media.cut_now
media.darkness_mode
media.draft_mode
media.dynamic_length_calibration
media.feed_skip
media.media_low.external
media.media_low.warning
media.part_number
media.present.cut_amount
media.present.eject
media.present.length_addition
media.present.loop_length
media.present.loop_length_max
media.present.cut_margin
media.present.present_timeout
media.present.present_type
media.printmode
media.speed
media.serial_number
media.tof
memory.flash_free
memory.flash_size
memory.ram_free
memory.ram_size
mqtt.enable
mqtt.logging.clear
mqtt.logging.entries
mqtt.logging.max_entries
mqtt.restore_defaults
mqtt.conn[1|2].clean_session_flag
mqtt.conn[1|2].password
mqtt.conn[1|2].ping_interval
mqtt.conn[1|2].reset_now
mqtt.conn[1|2].reset_required
mqtt.conn[1|2].retry_interval_random_max
mqtt.conn[1|2].server_address
mqtt.conn[1|2].tenant_id
mqtt.conn[1|2].username
netmanage.avalanche.agent_addr
netmanage.avalanche.available_agent
netmanage.avalanche.available_port
netmanage.avalanche.encryption_type
netmanage.avalanche.interval
netmanage.avalanche.interval_update
netmanage.avalanche.model_name
netmanage.avalanche.set_property
netmanage.avalanche.startup_update
netmanage.avalanche.tcp_connection_timeout
netmanage.avalanche.terminal_id
netmanage.avalanche.text_msg.beep
netmanage.avalanche.text_msg.display
netmanage.avalanche.text_msg.print
netmanage.avalanche.udp_timeout
netmanage.error_code
netmanage.state_code
netmanage.status_code
odometer.cut_marker_count
odometer.headclean
odometer.headnew
odometer.label_dot_length
odometer.media_marker_count
odometer.media_marker_count1
odometer.media_marker_count2
odometer.net_media_length
odometer.net_ribbon_length
odometer.retracts_count
odometer.rfid.valid_resettable
odometer.rfid.void_resettable
odometer.total_cuts
odometer.total_print_length
odometer.total_label_count
odometer.user_label_count
odometer.user_total_cuts
odometer.user_label_count[1|2]
odometer.latch_open_count
parallel_port.mode
parallel_port.present
power.average_current
power.battery_led_blink_rate
power.battery_led_enable
power.battery_led_off_duration
power.battery_led_on_duration
power.battery_type
power.dtr_power_off
power.energy_star.enable
power.energy_star.timeout
power.label_queue.shutdown
power.power_on_mode
power.shutdown
power.voltage
power.wake.radio
power.current
power.temperature
power.percent_health
power.part_number
power.sleep.cradle
power.remaining_capacity
power.cycle_count
print.legacy_compatibility
print.tone
print.troubleshooting_label_print
ribbon.serial_number
ribbon.part_number
ribbon.cartridge.part_number
ribbon.cartridge.length_remaining
ribbon.cartridge.length
ribbon.cartridge.authenticated
ribbon.cartridge.inserted
ribbon.coating
ribbon.tension
rtc.exists
rtc.date
rtc.time
rtc.timezone
rtc.unix_timestamp
sensor.air_pressure.current_reading
sensor.ambient_light.current_reading
sensor.battery.in_volts
sensor.back_bar.brightness
sensor.back_bar.ppr_out_thold
sensor.back_bar.cur
sensor.cover_open
sensor.front_bar.ppr_out_thold
sensor.front_bar.cur
sensor.front_bar.thold
sensor.front_bar.gain
sensor.front_bar.brightness
sensor.front_bar.offset
sensor.back_bar.offset
sensor.gap.thold
sensor.gap.offset
sensor.gap.gain
sensor.gap.brightness
sensor.head.temp_avg
sensor.head.temp_celsius
sensor.head.temp
sensor.magnetometer.current_reading
sensor.object_temperature.current_reading
sensor.peel.thold
sensor.peel.gain
sensor.paper_supply
sensor.peeler
sensor.peel.brightness
sensor.proximity.current_reading
sensor.width.in_dots
sensor.width.cur
sensor.self_adjusting_enable
usb.device.device_id_string
usb.device.device_unique_id
usb.device.device_version
usb.device.manufacturer_string
usb.device.product_id
usb.device.product_string
usb.device.serial_string
usb.device.vendor_id
usb.halt
usb.host.config_info_to_usb
usb.host.fn_field_data
usb.host.fn_last_field
usb.host.hid_count
usb.host.keyboard_input
usb.host.lock_out
usb.host.mass_storage_count
usb.host.read_list
usb.host.read_list_print_delay
usb.host.template_list
usb.host.template_print_amount
usb.host.write_list
usb.mirror.appl_path
usb.mirror.auto
usb.mirror.enable
usb.mirror.enabled
usb.mirror.error_retry
usb.mirror.feedback.auto
usb.mirror.feedback.odometer
usb.mirror.feedback.path
usb.mirror.fetch
usb.mirror.last_error
usb.mirror.last_time
usb.mirror.path
usb.mirror.reset_delay
usb.mirror.success
usb.mirror.success_time
zbi.control.add_breakpoint
zbi.control.break
zbi.control.clear_breakpoints
zbi.control.delete_breakpoint
zbi.control.line_number
zbi.control.restart
zbi.control.run
zbi.control.step
zbi.control.terminate
zbi.control.variable_name
zbi.control.variable_value
zbi.enable
zbi.key
zbi.last_error
zbi.program_list
zbi.reseller_key
zbi.revision
zbi.running_program_name
zbi.start_info.execute
zbi.start_info.file_name
zbi.start_info.memory_alloc
zbi.state
zpl.calibrate
zpl.format_prefix
zpl.caret
zpl.control_character
zpl.delimiter
zpl.label_length
zpl.label_length_always
zpl.left_position
zpl.system_error
zpl.system_status
zpl.zpl_mode
zpl.zpl_override
zpl.relative_darkness
