mpiSynqNetPacketConfigSet

Declaration

long  mpiSynqNetPacketConfigSet(MPISynqNet           synqNet,
                                MPISynqNetPacketCfg  *config);

Required Header: stdmpi.h

Description

mpiSynqNetPacketConfigSet sets the network packet configuration to the configuration defined in the location pointed to by config.

WARNING: mpiSynqNetPacketConfigSet(...) is a low-level network routine that will clear other controller object configurations and reset the SynqNet network. This method should be executed in your application before configuring any other MPI objects. However, any control object configurations that force a network re-initialization must be performed before this routine is executed – please see mpiControlConfigSet(...) routine for more information.

This method is useful for optimizing network traffic (bandwith).

Only configurable packet data fields are configured by this method. Fixed packet fields are not application configurable.

Note: The Node Digital Inputs and Node Digital Outputs packet configuration changes are not presently supported. These are reserved for implementation with future devices. Node Analog Inputs and Node Analog Outputs packet configuration changes are not supported for the SQID and SLICE nodes.

synqNet a handle to a SynqNet object
*config pointer to configuration structure defined by MPISynqNetPacketCfg.
Return Values
MPIMessageOK
MPIMessageARG_INVALID
MPISynqNetMessageINCOMPLETE_MOTOR
MPISynqNetMessageINVALID_DIGITAL_IN_COUNT
MPISynqNetMessageINVALID_DIGITAL_OUT_COUNT
MPISynqNetMessageINVALID_ANALOG_OUT_COUNT
MPISynqNetMessageINVALID_ANALOG_IN_COUNT
MPISynqNetMessageINVALID_AUX_ENC_COUNT
MPISynqNetMessageINVALID_MOTOR_COUNT
MPISynqNetMessageINVALID_COMMAND_CFG
MPISynqNetMessageINVALID_ENCODER_COUNT
MPISynqNetMessageINVALID_CAPTURE_COUNT
MPISynqNetMessageINVALID_COMPARE_COUNT
MPISynqNetMessageINVALID_INPUT_COUNT
MPISynqNetMessageINVALID_OUTPUT_COUNT
MPISynqNetMessageINVALID_MONITOR_CFG
MPIMessageUNSUPPORTED

See Also

mpiSynqNetPacketConfigGet | MPISynqNetPacketCfgNode | MPISynqNetPacketCfg | mpiControlConfigSet