NXT.API.SystemCommand Class Reference

System commands. More...

Inheritance diagram for NXT.API.SystemCommand:

Public Member Functions
	SystemCommand (Robot _robot)
	The constructor.
void	OpenRead (string name, ref int file_handle, ref int file_size)
	Open file for reading.
void	OpenWrite (string name, ref int file_handle, int file_size)
	Open file for writing.
void	Read (int file_handle, int bytes_to_read, out byte[] data)
	Read data from file.
void	Write (int file_handle, byte[] data)
	Write data to the specified file.
void	Close (int file_handle)
	Close the specified file.
void	Delete (string name)
	Delete file.
void	FindFirst (string name, ref string file_name, ref int file_handle, ref int file_size)
	Search for file
void	FindNext (int file_handle, out byte[] response)
	Search for the next file with file_handle obtained from FindFirst or Open commands.
void	GetFirmwareVersion (out byte[] response)
	Get minor and major versions of firmware and protocol.
void	OpenWriteLinear (string name, ref int file_handle, int file_size)
	Open file for writing (linear mode).
void	OpenReadLinear (string name, ref int memory_pointer)
	Open file for writing (linear mode).
void	OpenWriteData (string name, ref int file_handle, int file_size)
	Open file for writing data.
void	OpenAppendData (string name, ref int file_handle, ref int file_size)
	Open file for appending data.
void	Boot ()
	Boot the brick. USB command only.
void	SetBrickName (string name)
	Set brick name.
void	GetDeviceInfo (out byte[] response)
	Get device information in a raw format.
void	DeleteUserFlash ()
	Delete user flash memory.
void	PollLength (int buffer_type, ref int buffer_size)
	Number of bytes for the command ready in the buffer.
void	Poll (int buffer_type, int command_length, out byte[] response)
	Poll the command.
void	BluetoothFactoryReset ()
	Reset Bluetooth. USB command only.
Public Member Functions inherited from NXT.Component
	Component (Robot _robot)
	The constructor.

Public Attributes
bool	RequestResponse = false
	CheckResponse will require a confirmation from NXT. It might be slower and return exceptions.
Public Attributes inherited from NXT.Component
bool	AutoUpdate = true
	Automatic update option for methods requesting more than one piece of information.

Additional Inherited Members
Protected Attributes inherited from NXT.Component
Robot	robot
	The robot class, accessible by all dervied classes.

Detailed Description

System commands.

Constructor & Destructor Documentation

NXT.API.SystemCommand.SystemCommand

(

Robot

_robot

)

The constructor.

Member Function Documentation

void NXT.API.SystemCommand.BluetoothFactoryReset

(

)

Reset Bluetooth. USB command only.

void NXT.API.SystemCommand.Boot

(

)

Boot the brick. USB command only.

void NXT.API.SystemCommand.Close

(

int

file_handle

)

Close the specified file.

void NXT.API.SystemCommand.Delete

(

string

name

)

Delete file.

void NXT.API.SystemCommand.DeleteUserFlash

(

)

Delete user flash memory.

void NXT.API.SystemCommand.FindFirst	(	string	name,
		ref string	file_name,
		ref int	file_handle,
		ref int	file_size
	)

Search for file

void NXT.API.SystemCommand.FindNext	(	int	file_handle,
		out byte[]	response
	)

Search for the next file with file_handle obtained from FindFirst or Open commands.

Parameters

file_handle
response

void NXT.API.SystemCommand.GetDeviceInfo

(

out byte[]

response

)

Get device information in a raw format.

void NXT.API.SystemCommand.GetFirmwareVersion

(

out byte[]

response

)

Get minor and major versions of firmware and protocol.

void NXT.API.SystemCommand.OpenAppendData	(	string	name,
		ref int	file_handle,
		ref int	file_size
	)

Open file for appending data.

void NXT.API.SystemCommand.OpenRead	(	string	name,
		ref int	file_handle,
		ref int	file_size
	)

Open file for reading.

Call Close when the file is not needed anymore.

void NXT.API.SystemCommand.OpenReadLinear	(	string	name,
		ref int	memory_pointer
	)

Open file for writing (linear mode).

void NXT.API.SystemCommand.OpenWrite	(	string	name,
		ref int	file_handle,
		int	file_size
	)

Open file for writing.

Call Close when the file is not needed anymore.

void NXT.API.SystemCommand.OpenWriteData	(	string	name,
		ref int	file_handle,
		int	file_size
	)

Open file for writing data.

void NXT.API.SystemCommand.OpenWriteLinear	(	string	name,
		ref int	file_handle,
		int	file_size
	)

Open file for writing (linear mode).

void NXT.API.SystemCommand.Poll	(	int	buffer_type,
		int	command_length,
		out byte[]	response
	)

Poll the command.

void NXT.API.SystemCommand.PollLength	(	int	buffer_type,
		ref int	buffer_size
	)

Number of bytes for the command ready in the buffer.

void NXT.API.SystemCommand.Read	(	int	file_handle,
		int	bytes_to_read,
		out byte[]	data
	)

Read data from file.

void NXT.API.SystemCommand.SetBrickName

(

string

name

)

Set brick name.

void NXT.API.SystemCommand.Write	(	int	file_handle,
		byte[]	data
	)

Write data to the specified file.

Member Data Documentation

bool NXT.API.SystemCommand.RequestResponse = false

CheckResponse will require a confirmation from NXT. It might be slower and return exceptions.

---

The documentation for this class was generated from the following file:

• C:/Users/Greg/Documents/GitHub/RoboLib/src/NXT.cs