WORKSWELL BB200 SDK User manual

WORKSWELL
BB200 SDK
USER MANUAL
FW Version: 1.4.20 or higher
Release date: 7th June, 2021
Revision : 1.6.2 EN

Contents
1. Legal Disclaimer 2
1.1 Copyright .............................................. 2
2. Warning and Cauons 3
2.1 Warnings .............................................. 3
3. Help and FAQ 4
3.1 GeneralInstrucons......................................... 4
4. General Device Informaon 5
4.1 CommunicaonInterface...................................... 5
4.1.1 RS485Communicaon ................................... 5
4.1.2 USBCommunicaon .................................... 6
4.1.3 Commandprotocol..................................... 6
5. BB200 SDK Control GUI Applicaon 7
5.1 Setup ................................................ 7
5.2 MainWindow............................................ 7
5.2.1 Connectbuon....................................... 8
5.2.1.1 Port selecon window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5.2.1.2 Refreshbuon.................................. 8
5.2.1.3 Acvaonwindow................................ 9
5.2.2 UploadFirmwarebuon.................................. 9
5.2.3 BB200informaon ..................................... 10
5.2.4 Controlpanel........................................ 11
5.2.5 Temperatureunitswitch .................................. 11
5.2.6 Lock............................................. 11
5.2.7 Buzzer............................................ 11
5.2.8 Log ............................................. 12
1

1. LEGAL DISCLAIMER
1 Legal Disclaimer
All products (soware, hardware or firmware) manufactured by Workswell s.r.o. are warranted against defecve
materials and workmanship for a period of twelve (12) months, provided such products have been under normal
storage and use in accordance with herein instrucons.
The warranty extends only to the original purchaser and is not transferable. It is not applicable to any product
which has been subjected to misuse, neglect, accident or abnormal condions of operaon.
In the case of a defect in a product covered by this warranty the product must not be further used in order to
prevent addional damage. The purchaser shall promptly report any defect to Workswell s.r.o. or its authorized
distributor or this warranty will not apply.
Workswell s.r.o. will, at its opon, repair or replace any such defecve product free of charge if, upon inspecon,
it proves to be defecve in material or workmanship and provided that it is returned to Workswell within the
said twelve-month period.
Nobody but Workswell s.r.o. is allowed to open or modify such product.
Workswell s.r.o. has no other obligaon or liability for defects than those set forth above. No other warranty
is expressed or implied. Workswell s.r.o. shall not be liable for any direct, indirect, special, incidental or conse-
quenal loss or damage, whether based on contract, tort or any other legal theory.
1.1 Copyright
© Workswell s.r.o. All rights reserved worldwide. No parts of the soware including source code may be re-
produced, transmied, transcribed or translated into any language or computer language in any form or by any
means, electronic, magnec, opcal, manual or otherwise, without the prior wrien permission of Workswell
s.r.o.
Names and marks appearing on the products herein are either registered trademarks or trademarks of Workswell
s.r.o. All other trademarks, trade names or company names referenced herein are used for idenficaon only
and are the property of their respecve owners.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
2

2. WARNING AND CAUTIONS
2 Warning and Cauons
2.1 Warnings
Before using the Workswell BB200, please read the whole User Manual. Before powering up the product, please
check that there is no visible damage or malfuncon; the cables are connected properly and also verify that the
polarity of the cables is correct.
If there are any visible signs of damage or other defects on the device, or you are not sure with the connecon,
then on no account should it be installed or put into operaon.
Any interference and non-cerfied service operaons on the product leads to an automac loss of warranty.
Warning: The device generates a large amount of heat and its parts can be very hot. Touching the device
at a heang element temperature higher than 50 °C (122 °F) is only possible when using protecve aids,
especially protecve gloves for high temperatures.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
3

3. HELP AND FAQ
3 Help and FAQ
3.1 General Instrucons
Before connuing, please make sure that you have the latest user manual for your BB200 device and the latest
BB200 SDK user manual.
Most of the soluons needed for any of the technical difficules that you may encounter can be found within
this manual. In case you have further quesons either:
Contact your authorized dealer;
or
Contact our technical support at support.workswell.eu
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
4

4. GENERAL DEVICE INFORMATION
4 General Device Informaon
4.1 Communicaon Interface
For communicaon you can use a nine-pin cable or an USB-C (communicaon through USB-C is available from
versions 1.4.17 and above).
4.1.1 RS485 Communicaon
The RS485 full duplex protocol is available for all 1.x.x versions. For half-duplex communicaon it is necessary to
connect AB4_485rs+ with YZ_rs485+ and AB_485rs- with YZ_rs48
Figure 4.1 – Scheme for 1.x.x version - full duplex
For 2.x.x versions, the pin AB_485rs+ is connected to YZ_rs485+ and AB_485rs- to YZ_rs485-.
Figure 4.2 – Scheme for 2.x.x version - half duplex
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
5

4. GENERAL DEVICE INFORMATION
In both versions, there is an RS485 bus connector. You can use the same commands as on USB 4.1.2. BAUDRATE
is 9600.
4.1.2 USB Communicaon
A USB-C cable can be used to set the parameters of the Workswell BB200 on versions 1.4.17 and above. Connect
the device to the computer with a USB-C cable. The device must be connected to the power supply at all mes,
connecng only to the USB-C without supplying power to the device will not suffice and you will not be able to
communicate with the device. Aer connecng to the PC and installing the driver, the device will show up as a
virtual COM port named USB-SERIAL CH340. Set this port in Puy, CMD or other. Set BAUDRATE to 115200. In
the serial line sengs, set 8 data bits, 1 stop bit, and no parity bit (8N1).
4.1.3 Command protocol
Communicaon using ASCII characters.
List of commands for communicaon with the device:
SET C/F <NNN.N> set setpoint to <NNN.N> °C/°F temperature
SET C/F ? shows current setpoint
GET C/F ? shows current temperature
GET IN C/F ? shows current temperature of the electronics
DISP C/F switches the temperature shown on the display to °C or °F
LOCK ? locks the temperature
UNLOCK ? unlocks the temperature
ARTICLE ? shows arcle number
SERIAL ? shows serial number
VERSION ? shows FW version number
BUZZER ON turns on the buzzer
BUZZER OFF turns of the buzzer
LED <NNN> sets the LED intensity as a percentage of 0 -100 %, where 0 does
not light up the LED at all
LED ? shows current LED intensity
Note: Commands listed above can be used with °C or °F. For each C/F command choose one of the opons.
Example: SET C ? shows current temperature in °C, SET F ? shows current temperature in °F.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
6

5. BB200 SDK CONTROL GUI APPLICATION
5 BB200 SDK Control GUI Applicaon
This chapter contains informaon about the Workswell BB200 SDK Control GUI applicaon, which was developed
to demonstrate the possible usage of this SDK. This applicaon enables full control of the black body from a
desktop computer and allows the user to update the firmware on the device.
5.1 Setup
Install the applicaon using aached installer. Aer the installaon, you may need to install CH320 driver using
provided file ”CH34xInstall_Windows_v3_4”. You may also need to install Microso Visual C++ Redistributables,
if it was not installed on Your computer previously. You can also use provided installer ”vc_redist.x64”.
5.2 Main Window
Figure 5.1 – Main window
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
7

5. BB200 SDK CONTROL GUI APPLICATION
5.2.1 Connect buon
The connect buon is used to connect the Workswell BB200 to your control applicaon. You cannot control more
than one BB200 device at the same me. Aer clicking the connect buon the port selecon window appears.
If you have your BB200 already connected you can disconnect it by clicking the Disconnect buon.
5.2.1.1 Port selecon window
In the port selecon window there is a list of available ports (both USB-C and RS485). Aer choosing and con-
firming the corresponding port, the program will aempt the connecon to the BB200 device.
Figure 5.2 – Port selecon window
5.2.1.2 Refresh buon
With the Refresh buon the list of available ports is updated. This buon should be used in case when a port is
not present on the available ports list.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
8

5. BB200 SDK CONTROL GUI APPLICATION
5.2.1.3 Acvaon window
This window will open aer connecng to BB200 without acvated SDK. Aer entering correct licence key BB200
SDK will be acvated permanently.
Figure 5.3 – Acvaon window
5.2.2 Upload Firmware buon
This funcon is working only on Windows!
If you wish to update your firmware contact our support at [e-mail].
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
9

5. BB200 SDK CONTROL GUI APPLICATION
5.2.3 BB200 informaon
Figure 5.4 – Informaon
This panel shows basic info about the product.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
10

5. BB200 SDK CONTROL GUI APPLICATION
5.2.4 Control panel
The setpoint temperature can be changed here.
Figure 5.5 – Control panel
5.2.5 Temperature unit switch
The temperature units can be switched between Celsius and Fahrenheit using a switch.
5.2.6 Lock
The BB200 can be locked or unlocked using a switch. When the BB200 is locked the setpoint temperature change
is not allowed.
5.2.7 Buzzer
The Buzzer can be enabled or disabled using a switch.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
11

5. BB200 SDK CONTROL GUI APPLICATION
5.2.8 Log
The log switch shows or hides text field with logs of current communicaon with the BB200. Last 10 commands
and answers are shown in a log.
E-mail and Web
[e-mail]
www.workswell.eu
Mobile:
[phone]
ID:
Reg. No.: 29048575
VAT No.: CZ29048575
Headquarters
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Revision 1.6.2 EN, 7th Jun, 2021
All pictures are only for illustraon.
Real values may vary.
12

Contacts
Sales Department
Mobile: [phone]
E-mail: [e-mail]
Headquarters
Workswell s.r.o.
U Albrechtova vrchu 12
155 00, Prague 13
Czech Republic
Partners Worldwide
Visit our partner list online
Company contact details
Mobile: [phone]
E-mail: [e-mail]
Web: www.workswell.eu