Event Notification Methods

Introduction | mpiObjectEventNotifyGet(...) | mpiObjectEventNotifySet(...)
mpiObjectEventNotifyReset(...) | Notification Process

Introduction

The MPI EventMgr is responsible for the collection and distribution of host notifications of firmware events. An application often needs to be notified of events that take place on the motion controller. Events include normal motion completion, motion limits being reached, hardware failure, etc. The EventNotify methods enable your application to request host notification of certain types of events, while ignoring other types of events. Some events are latched, in which case your application must reset the event before the event can be triggered again.

mpiObjectEventNotifyGet(...)

Use EventNotifyGet to return an MPIEventMask, which has a bit set for each type of event that host notification has been requested for, by the object.

mpiObjectEventNotifySet(...)

Use EventNotifySet to request host notification for each type of event specified in the MPIEventMask argument.

mpiObjectEventNotifyReset(...)

Use EventNotifyReset to reset each type of event specified in the MPIEventMask argument.

Notification Process

Events [that are requested by mpiObjectEventNotifySet(...)] move up through the firmware to the EventMgr.

To collect events, the EventMgr either polls the firmware (using mpiEventMgrService(...)) or is interrupted by the firmware. The EventMgr passes each event to its list of Notify objects, who further qualify events based on the event type and the source of the event, and generate signals and otherwise notify the host application of event occurrences.