SerialComUtil (serial communication manager 1.0.4 API)

java.lang.Object
- com.embeddedunveiled.serial.SerialComUtil

```
public final class SerialComUtil
extends Object
```
Provides common utility functions for serial port communication related projects.

Author:

Rishi Gupta

Constructor Summary

Constructors
Constructor and Description

SerialComUtil()
Allocates a new SerialComUtil object.

Constructors
Constructor and Description
`SerialComUtil()` Allocates a new SerialComUtil object.

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`byteArrayToHexString(byte[] data, String separator)` This method creates hex string from byte array.
`static String`	`byteToHexString(byte num)` Converts the given byte value to hex string.
`static int`	`byteToUnsignedInt(byte data)` Converts the given byte's value to an unsigned integer number.
`static long`	`byteToUnsignedLong(byte data)` Converts the given byte's value to an unsigned long number.
`static byte[]`	`concat(byte[] dataA, byte[] dataB)` Appends given byte array to another given byte array and return newly constructed byte array.
`static String`	`decodeBCD(short bcd)` Converts a binary-coded decimal number into decimal number string.
`static byte[]`	`hexStringToByteArray(String hexStringData)` Converts given string in hexa-decimal representation to equivalent byte array.
`static long`	`hexStrToLongNumber(String hexNumStr)` This converts a number represented in hex string to decimal number.
`static byte`	`highBytefromShort(short data)` Extract and returns the high byte from the short type number passed.
`static byte[]`	`intToByteArray(int data)` Converts the given integer value to a byte type array in Little endian order.
`static String`	`intToHexString(int num)` Converts the given integer value to hex string.
`static long`	`intToUnsignedLong(int data)` Converts the given integer value to an unsigned long number.
`static String`	`longToHexString(long num)` Converts the given long value to hex string.
`static byte`	`lowByteFromShort(short data)` Extract and returns the low byte from the short type number passed.
`static byte[]`	`shortToByteArray(short data)` Converts the given short value to a byte type array in Little endian order.
`static String`	`shortToHexString(short num)` Converts the given short value to hex string.
`static int`	`shortToUnsignedInt(short data)` Converts the given short's value to an unsigned integer number.
`static long`	`shortToUnsignedLong(short data)` Converts the given short's value to an unsigned long number.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SerialComUtil
```
public SerialComUtil()
```
    Allocates a new SerialComUtil object.
- Method Detail
  - byteArrayToHexString
```
public static String byteArrayToHexString(byte[] data,
                          String separator)
```
    This method creates hex string from byte array. This is useful in bluetooth low energy applications where characteristics returned are to be interpreted or for example Internet of things applications where sensor data is getting exchanged.
    
    Parameters:
    data - byte array to be converted into string.
    separator - to be inserted after each hex value.
    
    Returns:
    constructed hex string if data.length > 0 otherwise empty string.
    
    Throws:
    
    IllegalArgumentException - if data is null.
  - hexStringToByteArray
```
public static byte[] hexStringToByteArray(String hexStringData)
```
    Converts given string in hexa-decimal representation to equivalent byte array.
    
    Parameters:
    hexStringData - string in hexa-decimal format to be converted into equivalent byte array.
    
    Returns:
    constructed byte array from given hex string.
    
    Throws:
    
    IllegalArgumentException - if hexStringData is null.
  - decodeBCD
```
public static String decodeBCD(short bcd)
```
    Converts a binary-coded decimal number into decimal number string. The decimal point will be placed between 2nd and third digit of the result returned. This can be used for example to decode USB specification release number which is encoded in BCD format.
    
    Parameters:
    bcd - binary-coded decimal to decode.
    
    Returns:
    decoded binary-coded decimal.
  - byteToUnsignedInt
```
public static int byteToUnsignedInt(byte data)
```
    Converts the given byte's value to an unsigned integer number. The least significant byte (8 bits) of the integer number will be identical to the byte (8 bits) provided, and the most significant 3 bytes (24 bits) of the integer will be zero.
    
    Parameters:
    data - the byte to convert.
    
    Returns:
    An unsigned integer number representing the given byte.
  - byteToUnsignedLong
```
public static long byteToUnsignedLong(byte data)
```
    Converts the given byte's value to an unsigned long number. The least significant byte (8 bits) of the long number will be identical to the byte (8 bits) provided, and the most significant 7 bytes (56 bits) of the long will be zero.
    
    Parameters:
    data - the byte to convert.
    
    Returns:
    An unsigned long number representing the given byte.
  - lowByteFromShort
```
public static byte lowByteFromShort(short data)
```
    Extract and returns the low byte from the short type number passed.
    
    Parameters:
    data - the short value from whom low byte is to be extracted.
    
    Returns:
    the low byte of the short value passed.
  - highBytefromShort
```
public static byte highBytefromShort(short data)
```
    Extract and returns the high byte from the short type number passed.
    
    Parameters:
    data - the short value from whom high byte is to be extracted.
    
    Returns:
    the high byte of the short value passed.
  - shortToUnsignedInt
```
public static int shortToUnsignedInt(short data)
```
    Converts the given short's value to an unsigned integer number. The least significant 2 byte (16 bits) of the integer number will be identical to the least significant 2 byte (16 bits) of the short number and the most significant 2 bytes (16 bits) of the integer will be zero.
    
    Parameters:
    data - the short type value to convert.
    
    Returns:
    An unsigned integer number representing the given short number.
  - shortToUnsignedLong
```
public static long shortToUnsignedLong(short data)
```
    Converts the given short's value to an unsigned long number. The least significant 2 byte (16 bits) of the long number will be identical to the least significant 2 byte (16 bits) of the short number and the most significant 6 bytes (48 bits) of the long number will be zero.
    
    Parameters:
    data - the short type value to convert.
    
    Returns:
    An unsigned long number representing the given short number.
  - shortToByteArray
```
public static byte[] shortToByteArray(short data)
```
    Converts the given short value to a byte type array in Little endian order.
    
    Parameters:
    data - the short type value to convert.
    
    Returns:
    a byte array representing given short number.
  - intToUnsignedLong
```
public static long intToUnsignedLong(int data)
```
    Converts the given integer value to an unsigned long number. The least significant 4 bytes (32 bits) of the long number will be identical to the least significant 4 bytes (32 bits) of the integer number and the most significant 4 bytes (32 bits) of the long number will be zero.
    
    Parameters:
    data - the int type value to convert.
    
    Returns:
    An unsigned long number representing the given int number.
  - intToByteArray
```
public static byte[] intToByteArray(int data)
```
    Converts the given integer value to a byte type array in Little endian order.
    
    Parameters:
    data - the short type value to convert.
    
    Returns:
    a byte array representing given short number.
  - hexStrToLongNumber
```
public static long hexStrToLongNumber(String hexNumStr)
```
    This converts a number represented in hex string to decimal number. It parses the string argument as a signed long with radix as 16.
    
    Parameters:
    hexNumStr - hex-string to be converted.
    
    Returns:
    a long type number repressing given hex string.
    
    Throws:
    
    NumberFormatException - if the given hex string can not be converted into numerical representation.
  - longToHexString
```
public static String longToHexString(long num)
```
    Converts the given long value to hex string.
    
    Parameters:
    num - the long type value to convert.
    
    Returns:
    a string representing given long number in hexadecimal format.
  - intToHexString
```
public static String intToHexString(int num)
```
    Converts the given integer value to hex string.
    
    Parameters:
    num - the integer type value to convert.
    
    Returns:
    a string representing given int number in hexadecimal format.
  - shortToHexString
```
public static String shortToHexString(short num)
```
    Converts the given short value to hex string.
    
    Parameters:
    num - the short type value to convert.
    
    Returns:
    a string representing given short number in hexadecimal format.
  - byteToHexString
```
public static String byteToHexString(byte num)
```
    Converts the given byte value to hex string.
    
    Parameters:
    num - the byte type value to convert.
    
    Returns:
    a string representing given byte value in hexadecimal format.
  - concat
```
public static byte[] concat(byte[] dataA,
            byte[] dataB)
```
    Appends given byte array to another given byte array and return newly constructed byte array.
    
    Parameters:
    dataA - one of the array that need to be added first.
    dataB - array that will be appended to array represented by dataA.
    
    Returns:
    a byte array constructed out of appending dataB array to dataA array.

Class SerialComUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SerialComUtil

Method Detail

byteArrayToHexString

hexStringToByteArray

decodeBCD

byteToUnsignedInt

byteToUnsignedLong

lowByteFromShort

highBytefromShort

shortToUnsignedInt

shortToUnsignedLong

shortToByteArray

intToUnsignedLong

intToByteArray

hexStrToLongNumber

longToHexString

intToHexString

shortToHexString

byteToHexString

concat