Star webPRNT User's Manual

StarWebPRNT Display Request Element


NameDescriptionWebPRNT
Browser
Star Printer
with Star webPRNT
<root>Root Element-✓ *1
<extmanager>StarWebPRNTExtManager Element-✓ *1
<backspace>Backspace Element-✓ *1
<horizontal_tab>Horizontal tab Element-✓ *1
<return>Return Element-✓ *1
<bitimage>Bit image Element-✓ *1
<text>Text Element-✓ *1
<clear>Clear screen Element-✓ *1
<cursor>Cursor Element-✓ *1
<tone>Tone Element-✓ *1
<turnon>Backlight Element-✓ *1
<rawdata>*2Raw data Element-✓ *1

*1 Only IFBD-HI01X/02X are supported.

*2 Usage of this method, to send device specific commands, is discouraged in order to maintain compatibility across all supported displays.
Developers are encouraged to use the general Star API wherever possible in order to utilize display functions.
In the case that the Star API does not offer a feature necessary for your software, please let us know so that we can consider inclusion in a future software update.

<root>

Root Element

Attribute

NameDescriptionOmission
---

Value

Description
List of StarWebPRNTExtManager Request Element
Example
<root >
  <extmanager request_type="write"></extmangater>
</root>

<extmanager>

StarWebPRNTExtManager Element

Attribute

NameDescriptionOmission
request_typeRequests for StarWebPRNTExtManager
  • 'claim' … Connection start request
  • 'read' … Receive request
  • 'write' … Send request
  • 'release' … Disconnection request
Can't be omitted
polling_timeoutpolling timeout[ms]10000
claimidclaimid control IDCan't be omitted *1

*1 Can be omitted only when request_type is ‘claim’ or ‘write’.

Value

Description
List of StarWebPRNT Display Request Element
<root >
  <extmanager request_type="write">
        <text codepage="cp437" international="usa">Star Micronics</text>
</extmangater>
</root>

<backspace>

Backspace Element

Attribute

NameDescriptionOmission
---

Value

Description
Ignore
Example
<root >
  <extmanager request_type="write">
        <backspace/>
    </extmangater>
</root>

<horizontal_tab>

Horizontal Tab Element

Attribute

NameDescriptionOmission
---

Value

Description
Ignore
Example
<root >
  <extmanager request_type="write">
        <horizontal_tab/>
    </extmangater>
</root>

<return>

Return Element

Attribute

NameDescriptionOmission
typeSpecifies return type
  • 'crlf' … CR+LF (Carriage return + Line feed)
  • 'cr' … CR (Carriage return only)
  • 'lf' … LF(Line feed only)
'crlf'

Value

Description
Ignore
Example
<root >
  <extmanager request_type="write">
        <return type="crlf"/>
    </extmangater>
</root>

<bitimage>

Bitimage Element

Attribute

NameDescriptionOmission
contextHTML5 Canvas 2D contextCan't be omitted
xDrawing area horizontal direction starting point (unit of dot)0
yDrawing area vertical direction starting point (unit of dot)0
widthDrawing width (unit of dot)Can't be omitted
heightDrawing height (unit of dot)Can't be omitted

Value

Description
Raster graphic image data
Note. Base64 encoding
Example
<root >
  <extmanager request_type="write">
        <bitimage width="160" height="40">///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////gcD/////////////////z/////+BwP////////////////8P/////4HA/////////////////k//////gcD////////////////83/////+BwP////////////////Ef/////4HA////////////////xn//AAADgcAAf/4AA//4Hg+AAP+M//gAAAOBwAB/4AAAf/geDAAA/jH/8AAAA4HAAH+AAAAP+B4AB/78x//Af////////AAfgAP4HgB/4P3P/4H////////4A//8APgeB/HA4Mf/gYAAA4HAAHAPgB8AeB4fAAKAc/+DgAADgcAAYDgAA8A4HngAYh/4/4GAAAOBwABAcAAA4Dge4AB6YD7/gfA//4HA/8DgDwBwOB/Af/uOAD/AfgP/gcD/gcB/4HgYH4H/+j/4P/APgH+BwP+BwP/wOBgfA//4/////ADgH4HA/4PB//A8GB4H//n/////AHwPgcD/gcD/8DwYHg//+//////wDwOBwP+BwH/wPBgeD/////////wHAYHAf4DgHzA8GB4P//////+AAAGBgcAAwPAAMDwYHg///////4AAAYGBwADgOAAwPBgeD///////gAADgYDwAPAeADA8GB4P//////////8BgD//8AP/8DwYHg///////////APAB//4AH/wPBgeD///////gAAAD/AAAP8AADA8GB4P//////+AAAA//gAA/8AAMDwYHg///////4AAAf//wAD/+ABwPBgeD//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////8=</bitimage>
    </extmangater>
</root>

<text>

Text Element

Attribute

NameDescriptionOmission
codepageCodePage
  • 'cp437' … CodePage437
  • 'katakana' … Katakana
  • 'cp850' … CodePage850
  • 'cp852' … CodePage852
  • 'cp858' … CodePage858
  • 'cp860' … CodePage860
  • 'cp863' … CodePage863
  • 'cp865' … CodePage865
  • 'cp866' … CadePage866
  • 'cp1252' … CodePage1252
  • 'shift_jis' … Shift_JIS
  • 'gb2312' … GB2312
  • 'big5' … Big5
  • 'korea' … korea
Unchanged
internationalSpecifies international characters
  • 'usa' … USA
  • 'france' … France
  • 'germany' … Germany
  • 'uk' … UK
  • 'denmark' … Denmark
  • 'sweden' … Sweden
  • 'italy' … Italy
  • 'spain' … Spain
  • 'japan' … Japan
  • 'norway' … Norway
  • 'denmark2' … DenmarkII
  • 'spain2' … SpainII
  • 'latin_america' … Latin America
  • 'korea' … Korea
Unchanged

Value

Description
Specifies text data
Example
<root >
  <extmanager request_type="write">
        <text codepage="cp437" international="usa">Star Micronics</text>
    </extmangater>
</root>

<clear>

Display clear Element

Attribute

NameDescriptionOmission
typeSpecifies clear type
  • 'all' … All clear
  • 'delete_to_end_of_line' … Clear current row.
'all'

Value

Description
Ignore
Example
<root >
  <extmanager request_type="write">
        <clear type="all"/>
    </extmangater>
</root>

<cursor>

Cursor Element

Attribute

NameDescriptionOmission
positionSpecify cursor position.
  • 'home' … Move to home position.
  • 'specified' … Move to specified position.
Unchanged
xCursor horizontal axis position
* Enabled only when ‘specified’ is selected for the position.
0
yCursor vertical axis position
* Enabled only when ‘specified’ is selected for the position.
0
modeSpecify cursor display pattern.
  • 'off' … Cursor is hidden.
  • 'blink' … Cursor blinks.
  • 'on' … Cursor is displayed (solid).
Unchanged

Value

DescriptionObject type
Generated element stringString
Example
<root >
  <extmanager request_type="write">
        <cursor position="home" mode="blink"/>
    </extmangater>
</root>

<tone>

Tone Element

Attribute

NameDescriptionOmission
contrastSpecifies contrast
  • 'minus3' … Contrast -3
  • 'minus2' … Contrast -2
  • 'minus1' … Contrast -1
  • 'default' … Default
  • 'plus1' … Contrast +1
  • 'plus2' … Contrast +2
  • 'plus3' … Contrast +3
'default'

Value

Description
Ignore
Example
<root >
  <extmanager request_type="write">
        <tone contrast="default"/>
    </extmangater>
</root>

<turnon>

Backlight Element

Attribute

NameDescriptionOmission
typeSelect backlight ON/OFF.
  • 'on' … Backlight ON
  • 'off' … Backlight OFF
'on'

Value

Description
Ignore
Example
<root >
  <extmanager request_type="write">
        <turnon type="on"/>
    </extmangater>
</root>

<rawdata>

Raw data Element

Attribute

NameDescriptionOmission
---

Value

Description
Specifies raw data
Note. Base64 encoding
<root >
  <extmanager request_type="write">
        <rawdata>MTIzNDU=</rawdata>
    </extmangater>
</root>
  • Usage of this method, to send device specific commands, is discouraged in order to maintain compatibility across all supported displays.
  • Developers are encouraged to use the general Star API wherever possible in order to utilize display functions.
  • In the case that the Star API does not offer a feature necessary for your software, please let us know so that we can consider inclusion in a future software update.