no.nordicsemi.android.dfu.internal

Class HexInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

no.nordicsemi.android.dfu.internal.HexInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class HexInputStream
extends FilterInputStream

Reads the binary content from the HEX file using IntelHex standard: http://www.interlog.com/~speff/usefulinfo/Hexfrmt.pdf. Truncates the HEX file from all meta data and returns only the BIN content.

In nRF51 chips memory a SoftDevice starts at address 0x1000. From 0x0000 to 0x1000 there is MBR sector (since SoftDevice 7.0.0) which should not be transmitted using DFU. Therefore this class skips all data from addresses below 0x1000.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
HexInputStream(byte[] data, int mbrSize) Creates the HEX Input Stream.
HexInputStream(InputStream in, int mbrSize) Creates the HEX Input Stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	mark(int readlimit)
int	read()
int	read(byte[] buffer)
int	read(byte[] buffer, int offset, int count)
int	readPacket(byte[] buffer) Fills the buffer with next bytes from the stream.
void	reset()
int	sizeInBytes() Returns the total number of bytes.
int	sizeInPackets(int packetSize) Returns the total number of packets with given size that are needed to get all available data.

Methods inherited from class java.io.FilterInputStream

close, markSupported, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HexInputStream

public HexInputStream(InputStream in,
                      int mbrSize)
               throws HexFileValidationException,
                      IOException

Creates the HEX Input Stream. The constructor calculates the size of the BIN content which is available through sizeInBytes(). If HEX file is invalid then the bin size is 0.

Parameters:

in - the input stream to read from.

mbrSize - the MBR (Master Boot Record) size in bytes. Data with addresses below than number will be trimmed and not transferred to DFU target.

Throws:

HexFileValidationException - if HEX file is invalid, e.g. there is no semicolon (':') on the beginning of each line.

IOException - if the stream is closed or another IOException occurs.

HexInputStream

public HexInputStream(byte[] data,
                      int mbrSize)
               throws HexFileValidationException,
                      IOException

Creates the HEX Input Stream. The constructor calculates the size of the BIN content which is available through sizeInBytes(). If HEX file is invalid then the bin size is 0.

Parameters:

data - the input stream to read from.

mbrSize - the MBR (Master Boot Record) size in bytes. Data with addresses below than * number will be trimmed and not transferred to DFU target.

Throws:

HexFileValidationException - if HEX file is invalid, e.g. there is no semicolon (':') on the beginning of each line.

IOException - if the stream is closed or another IOException occurs.

Method Detail

available

public int available()

Overrides:

available in class FilterInputStream

readPacket

public int readPacket(byte[] buffer)
               throws IOException

Fills the buffer with next bytes from the stream.

Parameters:

buffer - buffer to be filled

Returns:

the size of the buffer

Throws:

IOException

read

public int read()

Overrides:

read in class FilterInputStream

read

public int read(byte[] buffer)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] buffer,
                int offset,
                int count)

Overrides:

read in class FilterInputStream

sizeInBytes

public int sizeInBytes()

Returns the total number of bytes.

Returns:

total number of bytes available

sizeInPackets

public int sizeInPackets(int packetSize)

Returns the total number of packets with given size that are needed to get all available data.

Parameters:

packetSize - the maximum packet size

Returns:

the number of packets needed to get all the content

mark

public void mark(int readlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException