APIs for the Milli Manufacturing Tools

The RF Test APIs (RMAlib.dll) are a set of .NET classes with a common Commands class. The following combination of methods and events perform RF Test.

Methods

• Connect – Connects and enables access to the COM Ports to which Milli modules are connected
• Disconnect – Disconnects the Milli modules from their associated COM Ports
• StartRftest – Starts the RF test

Command Class Events

• OnError – Registers a callback method when there is an error 
• OnStepComplete – Indicates there has been a successful step completion
• RestartMilli – Prompts the user to restart the Milli
• RFTestProgress –  Monitors the RF Test Progress

ResponseAnalyzer Class Events

• OnRfTestComplete – Raises an event when the RF Test Completes
• OnErrorWhileParsingResponse – Captures the error encountered while parsing the response

Connect

The Connect method connects and starts access to the ComPort to which Milli modules are connected.

Signature: public bool Connect (string portName, int baud rate, PortType portType)

The input parameters are as follows:

• portName as string
• baud rate as int
• portType as PortType

This is an enumeration parameter. Types include: UUT(Unit under test) and KGM(Known Good Milli Unit)

The Connect method returns a Boolean value which states whether the connection was a success or failure.

Disconnect

The Disconnect method disconnects the Milli modules from their associated COM Port.

Signature: public void Disconnect (PortType portType)

The input parameters are as follows:

• portType as PortType
  • This is an enumeration parameter. Types include: UUT(Unit under test) and KGM(Known Good Milli Unit)

StartRfTest

The public void StartRfTest method starts the RF test. The command starts the RF server on the Known Good Milli Unit. It then starts the actual RF test on the UUT.

Signature: public virtual void StartRfTest (ResponseAnalyzer resp)

Before performing the RF Test, ensure that both the Milli Units are connected.

The input parameters are as follows:

• The object of ResponseAnalyzer class processes the response from Milli Unit and raises the appropriate events.

OnError

This is an event raised if there is an error occurred on any command execution, register a callback method with OnError of commands class.

Create an object of Commands class to access OnError event and register the call back method.

_commands.OnError += Commands_OnError;

Implement the call back method and access the error as e.Error where ErrorEventArgs is a class.

public string Error { get; set; }

public void Commands_OnError(EventsHandler.ErrorEventArgs e)

        {

            Error = e.Error;

 }

OnStepComplete

When there is a step complete to be raised on successful step completion ex:, “UUT Connected” message on successful connection of UUT, register a callback method.

Create an object of Commands class to access OnStepComplete event and register the call back method.

 _commands.OnStepComplete += Commands_OnStepComplete;

Implement the call back method and we will now access the Result as e.Result where StepCompleteEventArgs is a Class.

public string Message { get; set; }

private void Commands_OnStepComplete( EventsHandler.StepCompleteEventArgs e)

{

            Message = e.Result;

}

RestartMilli

When an event needs to be raised to prompt user to restart the Milli.

Create object of Commands class to access RestartMilli event and register the call back method

 _commands.RestartMilli += Commands_RestartMilli;

Implement the call back method and access the Message as e.Message where RestartMilliForSetBootEventArgs is a class.

public string Message { get; set; }

  private void Commands_RestartMilli( EventsHandler.RestartMilliForSetBootEventArgs e)

        {

            Message = e.Message;

}

RFTestProgress

This event  monitors RF Test Progress.

Create an object of Commands class to access the RFTestProgress event and register the call back method.

 _commands.RFTestProgress += MonitorRFTestProgress;

Implement the call back method and access the status as e.status where RFTestProgressEventArgs is a class.

public string RFProgressBarStatus { get; set; }

  private void MonitorRFTestProgress(EventsHandler.RFTestProgressEventArgs e)

        {

            RFProgressBarStatus = e.status;

}

OnRfTestComplete

This is an event raised when the RF Test is Completed. Register a callback method in the way described below.

Create an object of the ResponseAnalyzer class to access OnRfTestComplete event and register the following callback method:

 _responseAnalyzer.OnRfTestComplete += ResponseAnalyzer_OnRfTestComplete

Implement the callback method and access ResponseData as e.ResponseData, where RFTestReadResultEventArgs is a class:

private RFTestResponseData _rfTestResponseData;

private void ResponseAnalyzer_OnRfTestComplete( EventsHandler.RFTestReadResultEventArgs e)

        {

            _rfTestResponseData = e.ResponseData;

}

OnErrorWhileParsingResponse

To capture the error encountered while parsing the response, a callback method must be registered in the way described below. 

Create object of ResponseAnalyzer class to access OnErrorWhileParsingResponse event and register the following callback method:

_responseAnalyzer.OnErrorWhileParsingResponse += _responseAnalyzer_OnErrorWhileParsingResponse;

Implement the callback method and access the data as e.data where RFTestErrorEventArgs is a class.

private RFTestResponseData _rfTestResponseData;

private void _responseAnalyzer_OnErrorWhileParsingResponse( EventsHandler.RFTestErrorEventArgs e)

        {

            _rfTestResponseData = e.data;

}

OnErrorWhileParsingCfgResponse

To capture the error encountered while parsing the configuration response to fetch the MAC Address of the UUT, a callback method must be registered in the way described below. 

Create an object of the ResponseAnalyzer class to access OnErrorWhileParsingCfgResponse event and register the following callback method:

_responseAnalyzer.OnErrorWhileParsingCfgResponse += _responseAnalyzer_OnErrorWhileParsingCfgResponse;

Implement the callback method and access the data as e.data, where EventsHandler.ErrorEventArgs is a class.

String _cfgError = string.Empty;

private void _responseAnalyzer_OnErrorWhileParsingResponse( EventsHandler.ErrorEventArgs e)

        {

            _ cfgError = e.data;

}