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

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