Sym3
Documentation
Simulation Script
sym3.js
Macro API
Release Notes
Support
Training Videos
Simulation Script
Manual
Getting Started
Introduction
Global Events
API
Simulation
OnSimulationStart
OnSimulationStop
OnSimulationStopping
GetTimeSinceStart
GetSecondsSinceMidnight
GetSimulationDateTime
GetSym3Version
PauseSimulation
ResumeSimulation
Getting Equipment
GetComponents
GetComponentByNameAndType
GetComponentByID
GetProductFromID
Subscribe to Events
SubscribeToEvent
UnSubscribeToEvent
SubscribeAll
UnSubscribeAll
Logging
LogDebug
LogInfo
LogWarning
LogError
Timers
SetTimerEx
KillTimer
System Properties
GetSystemProperty
SetSystemProperty
SubscribeToSystemPropertyChange
UnSubscribeToSystemPropertyChange
User Properties
GetUserProperty
SetUserProperty
SubscribeToUserPropertyByType
UnSubscribeToUserPropertyByType
SubscribeToAllUserProperty
UnSubscribeToAllUserProperty
Global Types
Connection
Equipment Collections
SetComponentKey
GetComponentByKey
Layers
GetLayers
File Handling
OpenFileForReading
OpenFileForWriting
ReadLine
WriteLine
CloseFile
Seek
GetProjectDirectory
SQL
Database Object
GetDatabases
GetDatabaseById
GetDatabaseByName
SetSQLCmdEx
Product Tracking
UpdateProductPosition
Physics
DeleteAllProductsOnPhysicsFloor
GetProductsOnPhysicsFloor
Camera
ZoomAndFollowEquipment
StopZoomAndFollowEquipment
Communication
DataSources
DataSource Object
GetDataSources
ConnectDataSource
Tags
SubscribeToTag
UnSubscribeToTag
SetTagValue
GetTagValue
Devices
Device Object
GetDevices
GetDeviceByName
GetDeviceById
ConnectDevice
DisconnectDevice
OnDeviceConnectionChanged
Device IOs
DeviceIO Object
GetDeviceIOs
Callback
Messaging
Header Object
Message Object
Messaging Callback
CreateMessage
CreateHeader
SendMessage
SendMessage (Custom)
SetOutputDeviceIO
Custom messages
Networking
Ping
WebSocket
Equipment
Barcode Scanner
Properties
StartRead
OnReadStarted
OnReadComplete
Basic Shape
Properties
GoToPosition
StopMovement
GetPosition
Rotate
StopRotation
GetRotation
OnArrivePosition
OnCompleteRotation
Cam Pusher
Properties
OnDeployStateChange
Chute
Properties
CreateBlockage
RemoveBlockage
OnProductAdded
OnProductRemoved
OnChuteProductAdded
OnChuteProductRemoved
OnChuteIsFullStateChange
Conveyor
Properties
GetProductInArea
GetCurrentSpeed
SetPreviousConnection
SetNextConnection
CreateBlockage
CreateRangeBlockage
RemoveBlockage
OnConveyorSpeedChange
OnConveyorRunningStateChange
OnConveyorReverseStateChange
OnProductAdded
OnProductRemoved
OnTargetSpeedReached
OnEncoderReached
Conveyor Controller
Properties
SetControlZoneAccumulate
SetControlZoneRunning
SetControlZoneReversed
SetControlZoneSpeedPercent
SetControlZoneAcceleration
SetControlZoneDeceleration
Cross Belt Sorter
Properties
SetSorterPosition
GetCurrentSpeed
InductProduct
GetProductOnBelt
SubscribeOnBeltBlocking
SubscribeOnBeltUnblocking
UnsubscribeOnBeltBlocking
UnsubscribeOnBeltUnblocking
RemoveProduct
ReInstateProduct
RemoveAllProduct
OnSorterRunningStateChange
OnCurrentBeltChange
OnProductAdded
OnProductRemoved
OnProductReachExit
OnProductFailToExit
OnEncoderReached
Diverge
Properties
Diverter
Properties
OnDeployLeftStateChange
OnDeployRightStateChange
Divert Rule
Properties
OnEvaluate
EStop
Properties
Free Roller Conveyor
Properties
GetProductInArea
SetPreviousConnection
CreateBlockage
RemoveBlockage
OnProductAdded
OnProductRemoved
Grid
Properties
Handler Group
Properties
High Speed Diverter
Properties
OnDeployStateChange
Label
Properties
Path
Properties
MoveAlongSection
MoveAlongSectionWithDistance
MoveAlongSectionsWithDistances
GetSectionLength
OnObjectAtSectionEnd
PE Sensor
Properties
OnProductBlocking
OnProductUnblocking
OnProductsOverlap
OnProductsDetected
Physics Basic Shape
Properties
GoToPosition
GetPosition
StopMovement
Rotate
GetRotation
StopRotation
OnArrivePosition
OnCompleteRotation
OnPhysicsBasicShapeBlocked
Physics Chute
Properties
OnProductAdded
OnProductRemoved
Physics Conveyor
Properties
GetCurrentSpeed
GetProductInArea
OnProductAdded
OnProductRemoved
OnTargetSpeedReached
OnConveyorSpeedChange
OnConveyorRunningStateChange
OnConveyorReverseStateChange
OnEncoderReached
Physics PE Sensor
Properties
OnProductBlocking
OnProductUnblocking
OnProductsOverlap
OnProductDetected
Polyline
Properties
Product
Properties
DeleteProduct
DeleteAllProducts
CreateProduct
MoveProduct
GetChildren
SetDestination
SetMaxDestinationData
ClearDestination
SetScreeningResult
SetMaxScreeningResults
ClearScreeningResults
GetProductPosition
SetShape
GetLateralOffset
SetLateralOffset
OnIdentifiedStateChange
OnProductCreate
OnProductDelete
OnScreeningDataChange
OnDestinationDataChange
Product Generator
Properties
CreateProductFrom
OnProductCreate
Product Schedule
Properties
GetQueueSize
GetRates
SetRates
OnMaxProductsReached
Rack
Properties
GetProductsFromCell
GetCell
Shoe Sorter
Properties
DivertShoes
GetCurrentSpeed
DiverterProxStatus
OnProductAdded
OnProductRemoved
OnShoeDiverterProxStateChange
OnEncoderReached
Tilt Tray Sorter
Properties
SetSorterPosition
InductProduct
GetProductOnTray
RemoveProduct
ReInstateProduct
RemoveAllProduct
OnSorterRunningStateChange
OnCurrentTrayChange
OnProductAdded
OnProductRemoved
OnProductReachExit
OnProductFailToExit
TransferUnit
Properties
VerticalSorter
Properties
OnDeployStateChange
X-Ray Machine
Properties
OnScreeningStarted
OnScreeningComplete
Simulation Script
API
Equipment Collections
Equipment Collections
SetComponentKey
GetComponentByKey