Component: Coupling (Mechatronics)

Author	Matrix TSL
Version	1.0
Category	Mechatronics

Coupling component

A simple component to couple together two rotating shafts. An essential component when working with motors, gearboxes, encoders and other rotational systems.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	Rotate
Simulation macro called behind the scenes by motor components when rotating.
[[File:]] -	Angle
- VOID	Return

	FT_SetTimeouts
This function sets the read and write timeouts for the device.
[[File:]] -	Handle
Handle of the device.
[[File:]] -	ReadTimeout
Read timeout in milliseconds.
[[File:]] -	WriteTimeout
Write timeout in milliseconds.
- BYTE	Return

	FT_SetBitMode
Enables different chip modes.
[[File:]] -	Handle
Handle of the device.
- BYTE	Mask
Required value for bit mode mask. This sets up which bits are inputs and outputs. A bit value of 0 sets the corresponding pin to an input, a bit value of 1 sets the corresponding pin to an output.
- BYTE	Mode
0=Reset / 1=AsyncBB / 2=MPSSE / 4=SyncBB / 8=MCUHost / 16=FastOpto / 32=CBUS / 64=SyncFIFO
- BYTE	Return

	FT_SetRts
This function sets the Request To Send (RTS) control signal.
[[File:]] -	Handle
Handle of the device.
- BYTE	Return

	FT_GetDeviceInfoDetail
This function returns an entry from the device information list.
- ULONG	Index
Index of the entry in the device info list.
- ULONG	Flags
Pointer to unsigned long to store the flag value.
- ULONG	Type
Pointer to unsigned long to store device type.
- ULONG	ID
Pointer to unsigned long to store device ID.
- ULONG	LocID
Pointer to unsigned long to store the device location ID.
- BYTE	SerNum
Pointer to buffer to store device serial number as a null terminated string
- BYTE	Descript
Pointer to buffer to store device description as a null-terminated string
[[File:]] -	TempHandle
Pointer to a variable of type FT_HANDLE where the handle will be stored
- BYTE	Return

	FT_Close
Close an open device.
[[File:]] -	Handle
Handle of the device.
- BYTE	Return

	FT_ClrDtr
This function clears the Data Terminal Ready (DTR) control signal.
[[File:]] -	Handle
Handle of the device.
- BYTE	Return

	FT_Purge
This function purges receive and transmit buffers in the device.
[[File:]] -	Handle
Handle of the device.
[[File:]] -	Mask
Used to determine which buffer to purge, 1=Rx / 2=Tx / 3=Both
- BYTE	Return

	FT_GetQueueStatus
Gets the number of bytes in the receive queue.
[[File:]] -	Handle
Handle of the device.
[[File:]] -	RxQueueLength
Pointer to a variable of type DWORD which receives the number of bytes in the receive queue.
- BYTE	Return

	FT_SetDataCharacteristics
This function sets the data characteristics for the device.
[[File:]] -	Handle
Handle of the device.
- BYTE	WordLength
Number of bits per word - Must be 7 or 8
- BYTE	StopBits
Number of stop bits - Must be 1 or 2
- BYTE	Parity
Parity 0=None / 1=Odd / 2=Even / 3=Mark / 4=Space
- BYTE	Return

	FT_SetBreakOff
Resets the BREAK condition for the device.
[[File:]] -	Handle
Handle of the device.
- BYTE	Return

	FT_SetDivisor
This function sets the baud rate for the device. It is used to set non-standard baud rates.
[[File:]] -	Handle
Handle of the device.
- UINT	Divisor
Divisor.
- BYTE	Return

	FT_SetBaudRate
This function sets the baud rate for the device.
[[File:]] -	Handle
Handle of the device.
- ULONG	BaudRate
Baud rate.
- BYTE	Return

	FT_SetDtr
This function sets the Data Terminal Ready (DTR) control signal.
[[File:]] -	Handle
Handle of the device.
- BYTE	Return

	FT_Open
Open the device and return a handle which will be used for subsequent accesses.
[[File:]] -	Device
Index of the device to open. Indices are 0 based.
[[File:]] -	ft_Handle
Pointer to a variable of type FT_HANDLE where the handle will be stored. This handle must be used to access the device.
- BYTE	Return

	ScanFor232
Scans for a FTDI D2XX device, returnes true if at least one device was found.
[[File:]] -	Return

	FT_ResetDevice
This function sends a reset command to the device.
[[File:]] -	Handle
Handle of the device.
- BYTE	Return

	FT_SetChars
This function sets the special characters for the device.
[[File:]] -	Handle
Handle of the device.
- BYTE	EventCh
Event character.
- BYTE	EventChEn
0 if event character disabled, non-zero otherwise.
- BYTE	ErrorCh
Error character.
- BYTE	ErrorChEn
0 if error character disabled, non-zero otherwise.
- BYTE	Return

	DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2.
- UINT	X1
- UINT	Y1
- UINT	X2
- UINT	Y2
- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.
- BYTE	PixelColour
0=White, 1=Black
- VOID	Return

	DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
- UINT	X1
- UINT	Y1
- UINT	X2
- UINT	Y2
- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

	MODPMSHAPE
Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
- BYTE	Shape
Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
- VOID	Return

	ARB4
Loads the binary-data to an existing arbitrary waveform memory location ARB4.
- BYTE	Waveform
- VOID	Return

	CLKSRRet
Returns the clock source <INT> or <EXT>.
[[File:]] -	Return

	MODPMDEV
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°).
[[File:]] -	Degrees
Sets PM waveform deviation in degrees (-360 - 360).
- VOID	Return

	MSTLOCK
Sends signal to SLAVE generator to get synchronised
- VOID	Return

	HILVL
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V).
[[File:]] -	HighLevel
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V).
- VOID	Return

	ARB3
Loads the binary-data to an existing arbitrary waveform memory location ARB3.
- UINT	Waveform
- VOID	Return

	WAVE
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB
- BYTE	WaveType
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB.
- VOID	Return

	CALADJ
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100).
[[File:]] -	Calibrate
Adjust the selected calibration value (-100 - 100).
- VOID	Return

	STBRet
Returns the value of the Status Byte Register in <nr1> numeric format.
- BYTE	Return

	ARB2
Loads the binary-data to an existing arbitrary waveform memory location ARB2.
- UINT	Waveform
- VOID	Return

	EERRet
Query and clear execution error number register.
- STRING	Return

	MODFMSRC
Sets FM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets FM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODAMFREQ
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
[[File:]] -	Frequency
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
- VOID	Return

	ESE
Sets the Standard Event Status Enable Register to the value of <nrf>.
- BYTE	Value
Value of register 0-255
- VOID	Return

	ARB1
Loads the binary-data to an existing arbitrary waveform memory location ARB1.
- UINT	Waveform
16 Bit binary number for arbitrary waveform.
- VOID	Return

	ARB4DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4.
- STRING	Return

	CLS
Clears status byte register of the interface.
- VOID	Return

	MSTRELOCK
Resynchronises the two generators in MASTER-SLAVE mode.
- VOID	Return

	NOISLVL
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%)
- BYTE	Percent
Sets the output noise level in percent. (0 - 50)
- VOID	Return

	LOCKMODE
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP.
- BYTE	Mode
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP).
- VOID	Return

	ADDRESSRet
Returns the instruments address
[[File:]] -	Return

	MODPMSRC
Sets PM waveform source to; 0 INT, 1 = EXT.
[[File:]] -	Source
Sets PM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MODPWMSRC
Sets PWM waveform source to; 0 = INT, 1 = EXT.
[[File:]] -	Source
Sets PWM waveform source (0 = INT, 1 = EXT).
- VOID	Return

	MOD
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM.
- BYTE	Modulation
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM).
- VOID	Return

	ISTRet
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true.
[[File:]] -	Return

	LRNRet
Returns the complete setup of the instrument as a binary data block
[[File:]] -	Return

	OPCRet
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential.
[[File:]] -	Return

	SWPTYPE
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP.
- BYTE	Type
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP).
- VOID	Return

	PULSRANGE
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3.
- BYTE	Range
Sets the pulse rise and fall range. (1, 2 or 3)
- VOID	Return

	TSTRet
The generator has no self test capability and the response is always 0 <rmt>.
[[File:]] -	Return

	BSTTRGPOL
Sets the burst trigger slope to; 0 = POS, 1 = NEG.
[[File:]] -	Slope
Set the burst trigger slope (0 = POS, 1 = NEG).
- VOID	Return

	ARB3Ret
Returns the binary-data from an existing abbitrary wavefrom memory location.
- UINT	Return

	BSTPHASE
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360)
[[File:]] -	Degrees
Sets the burst phase in degrees (-360 - 360)
- VOID	Return

	IDNRet
Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned.
- STRING	ReturnIDN
- STRING	Return

	SWPTRGPER
Sets the sweep trigger period to <nrf> seconds
[[File:]] -	Seconds
Set the sweep trigger period in seconds.
- VOID	Return

	PULSDLY
Sets the waveform delay to <nrf> sec
[[File:]] -	Sec
- VOID	Return

	Initialise
Opens the COM port ready for communications.
- VOID	Return

Property reference

	Properties
	Width
	Height
	Depth
	Connections
	Input
Input connection for example a motor or other active component or primitive.
	Output
Output connection for example a primitive or a component such as a linear slide or gearbox.
	Input Offset
Distance along the shaft from the center of the input object to the center of the coupling.
	Output Offset
Distance along the shaft from the center of the coupling to the center of the output object.
	Output Translation X
Distance along the X axis from the center of the coupling to the center of the output object.
	Output Translation Y
Distance along the Y axis from the center of the coupling to the center of the output object.
	Simulations