Component: Solenoid Template (Mechatronics)

Author	Matrix Ltd
Version	1.1
Category	Mechatronics

Solenoid Template component

Base component for constructing solenoids. These take a single input pin and move an actuator between two positions depending on the pin state.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_solenoid_base.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_solenoid_base.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	SetTarget
Choose an extermal object to move along with the solenoid's actuator
- HANDLE	Object
An object to be moved by the solenoid
- VOID	Return

	TurnOn
Activate the solenoid
- VOID	Return

	SetState
Trun the solenoid on or off using a boolean value.
- BOOL	State
The new state for the solenoid to take.
- VOID	Return

	TurnOff
De-activate the solenoid
- VOID	Return

Property reference

	Properties
	Connection
	Pin
Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.
	Simulation
	Moving part
A panel object to be moved back and forth when the solenoid is activated.
	Pivot object
A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids.
	Type
The type of motion of the solenoid actuator.
	Axis
For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate.
	Distance
For linear solenoids, the distance between the 'off and 'on' states in model units. For rotary solenoids, the rotation in degrees.
	Time (ms)
The time taken for the solenoid to move between the on and off positions. Used only for the purpose of System Panel animations on screen.

==Macro reference==

	SetTarget
Choose an extermal object to move along with the solenoid's actuator
- HANDLE	Object
An object to be moved by the solenoid
- VOID	Return

	TurnOn
Activate the solenoid
- VOID	Return

	SetState
Trun the solenoid on or off using a boolean value.
- BOOL	State
The new state for the solenoid to take.
- VOID	Return

	TurnOff
De-activate the solenoid
- VOID	Return

Property reference

	Properties
	Connection
	Pin
Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.
	Simulation
	Moving part
A panel object to be moved back and forth when the solenoid is activated.
	Pivot object
A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids.
	Type
The type of motion of the solenoid actuator.
	Axis
For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate.
	Distance
For linear solenoids, the distance between the 'off and 'on' states in model units. For rotary solenoids, the rotation in degrees.
	Time (ms)
The time taken for the solenoid to move between the on and off positions. Used only for the purpose of System Panel animations on screen.

==Macro reference==

	SetTarget
Choose an extermal object to move along with the solenoid's actuator
- HANDLE	Object
An object to be moved by the solenoid
- VOID	Return

	TurnOn
Activate the solenoid
- VOID	Return

	SetState
Trun the solenoid on or off using a boolean value.
- BOOL	State
The new state for the solenoid to take.
- VOID	Return

	TurnOff
De-activate the solenoid
- VOID	Return

Property reference

	Properties
	Connection
	Pin
Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.
	Simulation
	Moving part
A panel object to be moved back and forth when the solenoid is activated.
	Pivot object
A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids.
	Type
The type of motion of the solenoid actuator.
	Axis
For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate.
	Distance
For linear solenoids, the distance between the 'off and 'on' states in model units. For rotary solenoids, the rotation in degrees.
	Time (ms)
The time taken for the solenoid to move between the on and off positions. Used only for the purpose of System Panel animations on screen.

==Macro reference==

	SetTarget
Choose an extermal object to move along with the solenoid's actuator
- HANDLE	Object
An object to be moved by the solenoid
- VOID	Return

	TurnOn
Activate the solenoid
- VOID	Return

	SetState
Trun the solenoid on or off using a boolean value.
- BOOL	State
The new state for the solenoid to take.
- VOID	Return

	TurnOff
De-activate the solenoid
- VOID	Return

Property reference

	Properties
	Connection
	Pin
Chip pin to connect the solenoid circuit to. NB) Solenoid cannot be moved unless there is a valid connection.
	Simulation
	Moving part
A panel object to be moved back and forth when the solenoid is activated.
	Pivot object
A position to rotate around when the solenoid type is set to 'Rotate' Not required for linear solenoids.
	Type
The type of motion of the solenoid actuator.
	Axis
For linear solenoids, the axis along which the actuator will move. For rotary solenoids, the axis around which it will rotate.
	Distance
For linear solenoids, the distance between the 'off and 'on' states in model units. For rotary solenoids, the rotation in degrees.
	Time (ms)
The time taken for the solenoid to move between the on and off positions. Used only for the purpose of System Panel animations on screen.