V2020.1.56.3_ Rotary Encoder



Overview

The Rotary Encoder is a component that simulates a physical encoder.

It consists of two components; Physical and Logic. Both are needed to control the motor through a logic adapter (connecting the Rotary Encoder to an external controller through a https://unit040.atlassian.net/wiki/spaces/PUD/pages/280987237 ). Adding a Control Panel gives you the option to control the encoder from the Unity scene.


Where to find

The Rotary Encoder can be found under Standard Components > Rotary Encoder

 

It will automatically be attached to a selected GameObject or otherwise it will create a new GameObject to attach to.

A https://unit040.atlassian.net/wiki/spaces/PUD/pages/281673729 will be created automatically as part of the component.


Feature overview - Physical Component

Live Data

 

Live Data

 

Value

Current value of the Rotary Encoder

Important: The Rotary Encoder only functions in play mode and thus only shows data in play mode

Properties

 

Properties

 

Wheel Joint

Assign the Wheel Joint you wish to use for the Rotary Encoder

Value Per Rotation

The value difference for a full rotation on the Wheel Joint

Base Value

The minimum value at zero position

Enable Rounding

Enables rounding the output to certain intervals

Cap Value

Enables the use of a minimum and maximum value

Minimum Value

The minimum value of the output value

Maximum Value

The maximum value of the output value

On Value Changed ()

UnityEvent that is fired as soon as the output value changes

In the Control Panel tab you can generate a Control Panel for the Rotary Encoder.


How to use - Physical Component

  1. Create a Rotary Encoder and setup its Wheel Joint

     

  2. Add a Kinematics Controller, this can be found under Mechanics > Add Kinematics > Kinematics Controller to a separate GameObject

     

  3. Make sure the Rotary Encoder is parented under the Kinematic Controller in the Hierarchy

     

  4. Set the desired settings for the Rotary Encoder

     

  5. Enter PlayMode and test whether the Rotary Encoder works

     


Feature overview - Logic Component

 

Properties

 

Properties

 

Rotary Encoder

Select a Rotary Encoder Component to connect to the PLC

PLC I/O

 

PLC I/O

 

Property

Input and Output from connected PLC

Value

The corresponding value from the connected PLC

PLC Settings & Debugging

These settings are general Logic Component settings. Look at the Logic Component Documentation for more details.


How to use - Logic Component

Look at the https://unit040.atlassian.net/wiki/spaces/PUD/pages/280988469 for an example of how to connect a Rotary Encoder to an external controller.