GUIDE
B2BSerialPort API
To use Samsung B2B API,
<script type="text/javascript" src="$B2BAPIS/b2bapis/b2bapis.js"></script>Should be loaded in index.html
'B2BSerialPort::SerialPortManagerObject' interface
Public Attributes
Public Attributes
readonly attribute SerialPortManager serialport
Details in English
Namespace for SerialPort API.
Returns
SerialPort API
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
Attributes
B2bApi implements SerialPortManagerObject
The interface defines what is instantiated by the B2bApi object of Tizen Samsung TV Product API. There will be a b2bapis.serialport object that allows access to the functionality of the SerialPort API.
The interface defines what is instantiated by the B2bApi object of Tizen Samsung TV Product API. There will be a b2bapis.serialport object that allows access to the functionality of the SerialPort API.
Enumerations
StopBits
| Enumerator |
|---|
Details in English
Available Serial port stop bits on KIOSK Set
Enumvalues
- 1
- bits of stop
- 1.5
- bits of stop
- 2
- bits of stop
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
SerialPortNum
| Enumerator | |
|---|---|
| PORT0 | zero port number |
| PORT1 | first port number |
| PORT2 | second port number |
Details in English
Available Serial port on KIOSK Set
Enumvalues
- PORT0
- zero port number
- PORT1
- first port number
- PORT2
- second port number
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
Parity
| Enumerator | |
|---|---|
| NONE | option of None Parity |
| ODD | option of Odd Parity |
| EVEN | option of Even Parity |
Details in English
Available Serial port parity of KIOSK Set
Enumvalues
- NONE
- option of None Parity
- ODD
- option of Odd Parity
- EVEN
- option of Even Parity
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
DataBits
| Enumerator | |
|---|---|
| BITS5 | 5 bytes |
| BITS6 | |
| BITS7 | |
| BITS8 | |
Details in English
Available Serial port data bits on KIOSK Set
Enumvalues
- BITS5
- 5 bytes
- BITS5
- 6 bytes
- BITS5
- 7 bytes
- BITS5
- 8 bytes
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
'B2BSerialPort::SerialPortManager' interface
Public Methods
Boolean open ( SerialPortNum serialport, serialOption option, B2BSerialPortListener onlistener )
Interface to open serial port of device.
Interface to open serial port of device.
long writeData ( SerialPortNum serialport, DOMString data, long size )
Interface to write Data of device.
Interface to write Data of device.
Public Methods
DOMString getVersion()
This interface provides methods to get serialport module version.
Details in English
get serialport module version.
Returns
serialport plug-in's version.
Exceptions
- B2bAPIException
- with error type SecurityError, if the application does not have the privilege to call this method.
- B2bAPIException
- with error type UnknownError in any other error case.
var Version = null;
try {
Version = b2bapis.serialport.getVersion();
} catch (e) {
console.log("[getVersion] call syncFunction exception [" + e.code + "] name: " + e.name + " message: " + e.message);
}
if(null !== Version){
console.log("[getVersion] call syncFunction type: " + Version);
}
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Product
B2B_LFD
Version
1.0
Since
4.0
SDK Support
N
Boolean open(SerialPortNum serialport, serialOption option, B2BSerialPortListener onlistener)
Interface to open serial port of device.
Details in English
This interface provides methods toopen serial port of device
Parameters
- serialport
- number of device serial port
- option
- options to open serial port
- onlistener
- Cllback function to listen the serial data
Returns
Boolean true is returned when serial port open successfully or false is retured when Unable to open serial port
Exceptions
- B2bAPIException
- with error type SecurityError, if the application does not have the privilege to call this method
- B2bAPIException
- with error type TypeMismatchError, Invalid parameter type passed for input parameter
var option = NULL;
var serialport = "PORT1";
option = {
baudRate : 9600,
parity : "NONE",
dataBits : "BITS8",
stopBits : "1"
}
console.log("[open] function call");
var result = false;
function onlistener(serialData)
{
console.log("serial data is " + serialData.data +", serial Port is === " + serialData.result);
}
try
{
result = b2bapis.serialport.open(serialport,option,onlistener);
if(result == true)
{
console.log("Success to open serial port");
}
else
{
console.log("Fail to open serial port" + result);
}
}
catch(e)
{
console.log("[open] call syncFunction exception " + e.code + " " + e.errorName + " " + e.errorMessage);
}
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
Boolean close(SerialPortNum serialport)
Interface to close serial port of device.
Details in English
This interface provides methods toclose serial port of device
Parameters
- serialport
- number of device serial port
Returns
true is returned when serial port close successfully or false is retured when Unable to close serial port.
Exceptions
- B2bAPIException
- with error type SecurityError, if the application does not have the privilege to call this method.
- B2bAPIException
- with error type TypeMismatchError, Invalid parameter type passed for input parameter.
var result = false;
var serialport = "PORT1";
try
{
result = b2bapis.serialport.close(serialport);
if(result == false)
{
console.log("Fail to close serial port");
}
}
catch(e)
{
console.log("[close] call syncFunction exception " + e.code + " " + e.errorName + " " + e.errorMessage);
}
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
long writeData(SerialPortNum serialport, DOMString data, long size)
Interface to write Data of device.
Details in English
This interface provides methods to write Data of device
Parameters
- serialport
- number of device serial port
- data
- data to write
- size
- size of data
Returns
Long the size of the written data and if data has not been written, 0 is returned.
Exceptions
- B2bAPIException
- with error type SecurityError, if the application does not have the privilege to call this method.
- B2bAPIException
- with error type TypeMismatchError, Invalid parameter type passed for input parameter.
Note :
Data should be UTF-8. UTF-8 format is only supported with the API and its specification.
var result = false;
var serialport = "PORT1";
var data = "A0FF0145";
try
{
result = b2bapis.serialport.writeData(serialport, data, data.length);
console.log("[writeData_0] writeData size is " + result);
}
catch(e)
{
console.log("[writeData] call syncFunction exception " + e.code + " " + e.errorName + " " + e.errorMessage);
}
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Version
1.0
Since
4.0
Product
B2B_LFD
SDK Support
N
'B2BSerialPort::B2BSerialPortListener' interface
Public Methods
Public Methods
void onlistener( resultValue data)
Interface to set callback for reading Serial data.
Details in English
This method is callback parameter
Parameters
- data
- save the data of callback result
Returns
N/A
Exceptions
- B2bAPIException
- with error type SecurityError, if the application does not have the privilege to call this method.
- B2bAPIException
- with error type UnknownError in any other error case.
var option = NULL;
var serialport = "PORT1";
option = {
baudRate : 9600,
parity : "NONE",
dataBits : "BITS8",
stopBits : "1"
}
console.log("[open] function call");
var result = false;
function onlistener(serialData)
{
console.log("serial data is " + serialData.data +", serial Port is === " + serialData.result);
}
try
{
result = serialport.open(serialport,option,onlistener);
if(result == true)
{
console.log("Success to open serial port");
}
else
{
console.log("Fail to open serial port" + result);
}
}
catch(e)
{
console.log("[open] call syncFunction exception " + e.code + " " + e.errorName + " " + e.errorMessage);
}
Version
1.0
Since
4.0
Privilege Level
Public
Privilege
http://developer.samsung.com/privilege/serialport
Product
B2B_LFD
SDK Support
N
