MIP C API

This module contains all of the C submodules. More...

Collaboration diagram for MIP C API:

Modules
	Mip Command Queue [C]
	Functions for handling command responses.
	Mip Dispatch [C]
	System for issuing callbacks from MIP packets or fields.
	Mip Fields [C]
	Functions for processing received MIP fields.
	Mip Interface [C]
	High-level C functions for controlling a MIP device.
	Mip Logging [C]
	High-level C functions for logging information from within the MIP SDK.
	Mip Packet [C]
	Functions for handling MIP packets.
	mip_parser [C]
	Functions for parsing MIP packets.

Typedefs
typedef enum mip_cmd_result	mip_cmd_result
	Represents the status of a MIP command. More...

Enumerations
enum	mip_cmd_result {   MIP_STATUS_USER_START = -10, MIP_STATUS_ERROR = -6, MIP_STATUS_CANCELLED = -5, MIP_STATUS_TIMEDOUT = -4,   MIP_STATUS_WAITING = -3, MIP_STATUS_PENDING = -2, MIP_STATUS_NONE = -1, MIP_ACK_OK = 0x00,   MIP_NACK_COMMAND_UNKNOWN = 0x01, MIP_NACK_INVALID_CHECKSUM = 0x02, MIP_NACK_INVALID_PARAM = 0x03, MIP_NACK_COMMAND_FAILED = 0x04,   MIP_NACK_COMMAND_TIMEOUT = 0x05 }
	Represents the status of a MIP command. More...

Functions
bool	mip_cmd_result_is_ack (enum mip_cmd_result result)
	Determines if the result is an ack (successful response from the device) More...
bool	mip_cmd_result_is_finished (enum mip_cmd_result result)
	Determines if the command has completed, timed out, been cancelled, or otherwise is no longer waiting for a response. More...
bool	mip_cmd_result_is_reply (enum mip_cmd_result result)
	Determines if the result is a reply from the device (i.e. More...
bool	mip_cmd_result_is_status (enum mip_cmd_result result)
	Determines if the result code was generated by this lib (i.e. More...
bool	mip_cmd_result_is_user (enum mip_cmd_result result)
	Determines if the result code was generated by user software. More...
const char *	mip_cmd_result_to_string (enum mip_cmd_result result)
	Converts the command result to a string for debugging. More...

Detailed Description

This module contains all of the C submodules.

Typedef Documentation

mip_cmd_result

typedef enum mip_cmd_result mip_cmd_result

Represents the status of a MIP command.

Values that start with MIP_STATUS are status codes from this library. Values that start with MIP_(N)ACK represent replies from the device. Values at or below MIP_STATUS_USER_START (negative values) are reserved for status codes from user code.

Enumeration Type Documentation

mip_cmd_result

enum mip_cmd_result

Represents the status of a MIP command.

Values that start with MIP_STATUS are status codes from this library. Values that start with MIP_(N)ACK represent replies from the device. Values at or below MIP_STATUS_USER_START (negative values) are reserved for status codes from user code.

Enumerator
MIP_STATUS_USER_START	Values defined by user code must be less than or equal to this value.
MIP_STATUS_ERROR	Command could not be executed (error sending/receiving)
MIP_STATUS_CANCELLED	Command was canceled in software.
MIP_STATUS_TIMEDOUT	Reply was not received before timeout expired.
MIP_STATUS_WAITING	Waiting for command reply (timeout timer has started).
MIP_STATUS_PENDING	Command has been queued but the I/O update hasn't run yet.
MIP_STATUS_NONE	Command has been initialized but not queued yet.
MIP_ACK_OK	Command completed successfully.
MIP_NACK_COMMAND_UNKNOWN	Command not supported.
MIP_NACK_INVALID_CHECKSUM	Reserved.
MIP_NACK_INVALID_PARAM	A parameter was not a supported value.
MIP_NACK_COMMAND_FAILED	The device could not complete the command.
MIP_NACK_COMMAND_TIMEOUT	Internal device timeout. Use MIP_STATUS_TIMEDOUT for command timeouts.

Definition at line 25 of file mip_result.h.

Function Documentation

mip_cmd_result_is_ack()

bool mip_cmd_result_is_ack

(

enum mip_cmd_result

result

)

Determines if the result is an ack (successful response from the device)

Definition at line 77 of file mip_result.c.

mip_cmd_result_is_finished()

bool mip_cmd_result_is_finished

(

enum mip_cmd_result

result

)

Determines if the command has completed, timed out, been cancelled, or otherwise is no longer waiting for a response.

Definition at line 45 of file mip_result.c.

mip_cmd_result_is_reply()

bool mip_cmd_result_is_reply

(

enum mip_cmd_result

result

)

Determines if the result is a reply from the device (i.e.

mip_ack).

Definition at line 53 of file mip_result.c.

mip_cmd_result_is_status()

bool mip_cmd_result_is_status

(

enum mip_cmd_result

result

)

Determines if the result code was generated by this lib (i.e.

mip_cmd_status).

Definition at line 61 of file mip_result.c.

mip_cmd_result_is_user()

bool mip_cmd_result_is_user

(

enum mip_cmd_result

result

)

Determines if the result code was generated by user software.

Definition at line 69 of file mip_result.c.

mip_cmd_result_to_string()

const char* mip_cmd_result_to_string

(

enum mip_cmd_result

result

)

Converts the command result to a string for debugging.

Parameters

result

Any value.

Returns

A constant string.

Definition at line 16 of file mip_result.c.