Step Start
Steps are used to organize your Light Guide Work Instructions.
Add a new step.
When a new work instruction is created, the first step is automatically inserted.
- Select the line you would like to insert the step beneath.
- Navigate to the New Step button in the Insert tab of the ribbon, or hit Ctrl + N.
- Adding a new step will create three lines, a Step Start, a Clear Canvas, and a Confirmation
- Best practice is to add a descriptive step comment. In run mode, only the step comments will be visible as the work instructions is running.
Steps and Step Times.
Steps are not necessary to run Light Guide work instructions. They are used only for three purposes:
- Allow the database to record step-by-step data rather than just the total time of the work instructions.
- Make it easy to see immediately where the work instruction is by looking at the HMI.
- Provide a way for confirmations to jump to a specific step.
The Step Start command will start a step and allow the designer to name that step. These step names are seen on the HMI screen when the work instruction is running, along with their respective step times.
Steps end whenever the next Step Start is found or the work instructions ends.
Once the work instructions end, the step information is saved in the Database.
Clear Canvas
The Clear Canvas function is a tool that automatically clears everything (except Clear Proof graphics) that are currently on the canvas so that you start with a fresh clean canvas for your new step. A Clear Canvas will automatically appear when you insert a new step.
If you do not want to clear the canvas in a new step and you want to leave all your text or draw objects from your last step to your new step, simply delete the Clear Canvas line from your work instructions. Anything that is placed above the Clear Canvas line in a step will not appear in that step unless it is moved below the Clear Canvas line.
There is also a Clear Canvas button at the bottom of the work instructions window. If you Click this button, it will just clear the step for you to see your blank canvas. It will not delete anything in the work instruction. This will also clear items that are Clear Proof.
VDF Text
After selecting the insert text VDF button, you will be automatically directed to the format tab and presented with:
- VDF Text
The text you want to display on the canvas.
- Multiline
Allows more than one line. Use Alt+Enter to automatically enter this mode.
- Rich Text
Changes the type of text to allow rich formatting options like individually colored/styled/sized characters. It also allows for images to be pasted within the textbox.
- Anchor
This 3x3 grid allows selection of an anchor point, where text will grow from and rotate around.
Font Settings
- Font
Includes any font installed on the PC. We recommend Microsoft Sans Serif (the default font) or Arial Black
- Font Size
In points, the font size of your text object. - You can use Shift+Up and Shift+Down or the mouse wheel to change this.
- Bold
BOLDS the text - you can use Ctrl+B to toggle.
- Italic
ITALICIZES the text - you can use Ctrl+I to toggle.
- Underline
UNDERLINES the text - you can use Ctrl+U to toggle.
- Strikethrough
STRIKES out the text.
- Font Color
Changes the COLOR of the text - you can use the ‘C’ key to cycle through common colors.
- Mirror
ƚxɘƚ ɘʜƚ ƧЯOЯЯIM
- Alignment/Justification
There are three options for alignment. Left, center, and right.
VDF Draw - Creating a Drawing
The VDF Draw tool can be used in multiple ways. To start open a work instruction in design mode. You cannot use the draw tool in run mode. To start a draw tool, click on the Insert tab at the top then click the Draw Button, the drawing will appear in your step.
The canvas will show “Click on canvas to draw first point”. Move your mouse to the canvas and click on where you want to start drawing. Keep clicking to add more points. Press backspace to remove the last point you added if it did not end up in the right spot. You may also hold shift to draw straight lines in 15-degree increments. When finished right-click or press enter to finish the drawing.
Formatting a Drawing
In the Format tab you can change the thickness, the color, and close the object up so that it can have a solid fill color instead of being an open-ended polyline.
You can also close a draw image by first right clicking once to stop the draw tool then right click again and a tab will appear. Press the Close button and it will connect and close up the drawing.
Your draw object can also be dragged to a different location on the canvas. It also can be copied and pasted to other steps in your work instructions or even copied to other work instructions.
Inserting, Editing, and Deleting Points
Extra points can be added to a Draw image to change its shape. To do this you must right click the outline of the drawing where you want to add a point and then click the button Insert Point. This can be done anywhere on the outline of the drawing.
Then to delete a point simply just right click on the point you no longer want and press Delete Point.
You can also edit points of a object and move them in different directions to change its shape. You do this buy do this by clicking on a corner where a point is then it will appear as a yellow or red dot. You can drag and drop the point where you want it or you can use the arrow keys on a keyboard.
VDF Graphic
Insert a VDF Graphic
Light Guide is able to use .jpeg, .gif, .bmp, and .png formats.
- In the Insert menu, select Graphic.
- Select from the available options.
From File
You can select any common picture file from your computer or from a networked drive. It is usually a good idea to copy images to the VDFGraphics folder in the Light Guide Systems folder first, so that all dependent files can be backed up from this folder.
From Webcam
This will pop up with a live image from a webcam on the computer. You can select the webcam from a drop-down list, then click the Save button to automatically save the image to your computer and insert it into your Light Guide work instructions.
Common Graphics
These common graphics are place prominently for convenience. They can be modified by going into the RecentActivity.xml file and looking for <VDFGraphicsMenu> tags.
Formatting VDF Graphics
Replace
This allows the current graphic to be replaced with a different picture file, but stretched if necessary, to fit in the exact same area as the old graphic, with same color filter, etc.
Dynamic Graphic
It is possible to change the textbox containing the name to an expression which resolves into a string file name. The expression syntax is the same as variable logic. When the graphic is loaded onto the canvas, this expression will be evaluated, and the resulting image file will be loaded.
Rename
This will make a copy of the original picture file with a new name and link the current VDF Graphic to the new, copied file.
Mirror
Mirrors the file image but does not move it.
Color
Subtractive color filter. The color that you select will work on any white portions of the image, but black portions will stay black regardless of what color you choose here.
Transparency
0% is a fully opaque graphic and 100% is a completely invisible graphic. This only matters when layering graphics on top of each other.
Dynamic Color
You can change the color of text, images, or drawing using the color filter selection.
Moving VDF Graphics
Once inserted, VDF Graphics can be manipulated using the mouse and/or keyboard.
VDF Video
When and How to Use a Video
Short, looping videos are a great way to show an operator how to perform a complex task. The best videos are:
- about 3 to 8 seconds long,
- low resolution (so they load faster),
- cropped so that they only show the relevant task as it is performed,
- life size or larger than life size, and
- sometimes overlay the work itself, so that it almost looks like the work is being done in real life.
Videos are very distracting and should only be used when they are consistently needed. If someone is inspecting parts, for example, then the video will draw their attention away from the inspection. This is human nature.
Videos are great for training applications, where it is okay for the operator to be watching the video as they are trying to work.
For production applications, we recommend that videos are available on request, but not running automatically. The operator can then press a button to call up the video for their reference.
Insert a VDF Video
Light Guide uses .wmv and .avi, but it ultimately depends on the installed codecs in Windows.
- In the Insert menu, select Video.
- Choose a video file from the dialog window.
From File
You can select any common video file from your computer or from a networked drive. It is usually a good idea to copy video files to the VDFVideos folder in the Light Guide Systems folder first, so that all dependent files can be backed up from this folder.
Formatting VDF Videos
Comment
This helps explain what the video is about in case it is not clear based on the file name alone. Like all commands, click in the comment column to modify it.
Replace
This allows the current video to be replaced with a different video file, fitting the new video inside the bounds of the old one, with same color filter, etc.
Open in Video Editor
Opens the video in the Simple Video Editor. You can perform actions on the video such as trim, crop, and rotate. When the video is saved, it is saved as a new video in the default videos folder. To have the formatted video in your Light Guide program, it must be replaced.
Loop Video
This will cause the video to repeat indefinitely until it is cleared with a clear canvas command or the work instructions exits. If this is not checked, the video will end and the area where the video was will go blank.
Video Controls
You can play and stop the video while in design mode. Video playback is also automatically triggered every time the video is moved using the mouse.
Moving VDF Videos
Once inserted, VDF Videos can be manipulated using the mouse and/or keyboard.
Check out the Location/Animation Tab
Troubleshooting
Sometimes a video will not play. This is caused by missing drivers/codecs in Windows and is usually fixed by saving the video as a .wmv file (although other file types will usually work).
Large video files can take a long time to load. It is strongly recommended to reduce the resolution of any video file to the pixel dimensions that will be used in Light Guide. For example, a 240x180 pixel video is usually a good size to use within a projection area of 1280x800 pixels, taking up 20% of the overall projection area. Reducing video resolution can be done using Windows Movie Maker.
The best way to resolve any video playback issues is to edit and save the video using the Simple Video Editor.
Hardware
When using an NVS 510 GPU, the monitor should still be plugged in to the built-in video card in the computer that you are using. Sometimes the NVS 510 will not allow the videos to be displayed correctly in Light Guide when that is how the monitor is connected; however, projectors work when plugged into the NVS ports.
VDF Audio
Inserting Audio
1. In the Insert menu, select Audio.
2. In the LGS Audio Browser select the audio file you want to play.
The speaker field is who is speaking in the audio clip, not the device to play from, to configure that you will need to use the default Windows audio mixer.
Format
Replace
Replaces the current audio file with a different one but retains all formatting.
Play If
Link the audio to a Boolean variable so that it will play if this variable is true when this command is executed and again every time the variable changes from false to true.
Audio Control
Play and Stop.
Plays and Stops the audio in design mode.
Loop Audio
The Audio plays on repeat until the step ends when this option is checked.
Usage
An example is the right bin wrong bin, where a ding is played when the intended bin is picked from and a buzz is played if any other bin is reached into.
Using a short audio clip is a good way to get the attention of the operator when introducing something new to a process, whether that is an alert to an inspector to keep an eye out for a certain problem or to an assembly operator to remember that on this trim type they don't use the typical adhesive.
It is recommended to keep audio samples short for most work instructions, but you may want to provide some audio guidance for a non-production critical training application. You will need to pace the program so that the whole audio file plays within the span of its intended step or it will get cut off.
Most production workplaces have a lot of machine noise, so it is recommended to have a set of speakers that are attached to the station if you are looking to utilize audio in your work instructions.
VDF Timer
After choosing a Timer from the Insert menu, you have a number of formatting options.
VDF Countdown Settings
- Format
Select the time format of the timer. The options include:
* sss - Total seconds left.
* sss.x - Total seconds left, including fractional seconds.
* mmm:ss - Minutes with remaining seconds
* mmm:ss.x - Minutes with remaining seconds, including fractional seconds.
* hhh:mm:ss - Hours, minutes, and seconds
* hhh:mm:ss.x - Hours, minutes, and seconds, including fractional seconds.
Note that the timer looks very different when showing fractional seconds. A non-fractional (just whole numbers) timer will auto advance on the instant that the timer transitions from 1 to 0. A 3 second timer will show 3 for a second, then 2, then 1, then advance. A fractional timer will advance when transitioning from 0.1 to 0. A 3 second time will therefore start at 3.0 and spend the first second showing 2.x, then 1.x, then 0.x and advance on 0.0.
sss sss.x
3 3.0
3 2.8
3 2.6
3 2.4
3 2.2
2 2.0
2 1.8
2 1.6
2 1.4
2 1.2
1 1.0
- Comment
Comment for the Timer
- Reset If:
Variable that will automatically reset the timer to its initial value when that variable transitions from False to True.
- Initial Time
Specifies the starting time on the countdown.
- Initial Color
Specifies the color of the countdown before it reaches zero.
- Warning Time
Specifies the time at which the countdown enters "warning mode."
- Warning Color
Specifies the color of the timer when it is in "warning mode."
- Warning Blink
Toggles blinking action on the timer when it is in "warning mode."
- Advance When Exceeded
Sets a variable equal to true when the timer exceeds the countdown, to allow the work instructions to move to the next step. Disables exceeded color and exceeded blink when selected.
- Exceeded Color
Specifies the color of the timer when the timer has exceeded the countdown. This is disabled if the timer is set to advance when exceeded.
- Exceeded Blink
Toggles blinking action on the timer when the timer has exceeded the countdown. This is disabled if the timer is set to advance when exceeded.
Font Settings
Refer to the font settings of VDF Text
Call Program
Call Program elements allow you to enter another instruction. This is helpful in situations where you might be using the same routine in multiple different work instructions.
To use a Call Program, navigate to the Insert Tab and select Call Program. Navigate to the xml document of the work instructions you would like to call and Open it.
Adding a Call Program effectively inserts the lines of the work instructions being called into the current work instructions where the Call Program element is located.
Format
Comment
Description of the call program
Call Program
File name of the work instructions
Run if True.
Variable that will cause the Call Program to execute if it is true when this line is executing. In other words, if the variable is true when the step starts that contains this Call Program, then it will run. After the step has already started, setting this variable true will have no effect anymore.
Uses
- Just Graphics
A call Program can have only graphics in it, without any Step Start commands. This effectively makes a group of graphics or other commands that can be reused as needed.
- Steps
A more complete subroutine can be made using multiple steps. When entering this kind of Call Program, the same rules about advance step by step apply. Once this reaches the end of its execution, execution will reenter the main work instructions.
- Rework Routine
One or more steps can exist in the work instructions, but at the end of the work instructions, the last confirmation steps backwards into the main work instructions. This will cause the step that called the Call Program in the first place to be reentered, instead of going on to the next step. In fact, a Call Program can step backwards back to the main work instructions as far as it wants to, including to the first step of the main work instructions.
Open File/URL
The Open File/URL Element allows you to launch a work instruction, file, or even script from within your Light Guide work instructions. The possibilities of this are endless:
- Run a script or small work instructions that sends you an e-mail.
- Open a PDF of the old work instructions or drawings.
- Open a URL for logging defect data when reaching an inspection failed step.
- Run a small work instruction that communicates to a home-grown MES system.
- Start a video recording work instruction on the PC.
- Print something on a networked printer.
- Go to a website where more parts can be ordered.
Add an Open File/URL Element by navigating to the Insert tab, then selecting Open File/URL.
In the Format tab, specify the file to open. You can Browse the file system to locate it, and test that the file is valid by using Open Now.
NOTE: Light Guide will close this file or URL when done with the work instructions.
The argument container evaluates as an expression.
Variables
Variables are set in the Variables Tab of the System Settings menu. They can be used to control programs, make VDFs appear, store data in the database, activate IO devices, etc. Some variables may be controlled using Variable Commands
Variable Formats
- Boolean Variables- Are TRUEor FALSE
- Integer Variables- Are whole numbers like -1, 0, 1, 99.
- Float Variables- Are any real number like 0.1, -5.75,
- Text Variables- Are any text/characters that can be shown on a computer.
- Trigger Variables- Are Boolean variables that can start work instructions when they become
Variable Types
- IO Device Variables- Interact with external devices or software.
- Built-In System Variables- Get their values automatically from Light Guide.
- Get their values based on the values of other variables.
- Constant Variables- Can only change values from commands within work instructions.
Snapshot
Snapshot is a feature in Light Guide that can take a picture through one of many live webcams. This can be used as a confirmation for a step or simply just for reference. Some applications that this feature can be used for are:
- Assembly- for a final part, or to do stop motion animation of the entire assembly process.
- Part Kitting- to make sure parts are placed in the correct spot and that all parts are accounted for.
Format Tab
- Directoryis the file path to where you want this snapshot to save.
- Filenameis where you name the snapshot. A lot of creativity can be used here. Variables, expressions, and strings are allowed. Each one can be concatenated together using a +. The example in the picture above shows the filename being Snapshot_19991231_150000. It concatenates a string and the current date and time. If this picture should be overwritten each time, then make sure to not add in a variable here that changes.
- Cameradropdown box specifies which webcam to use for this snapshot.
- Resolutiondropdown box specifies the resolution that snapshot will be saved in. Bigger resolution = bigger file size.
Confirmation
You must confirm on a Boolean variable.
Multiple Confirmation lines can be combined in a step by inserting more than one into the same step. Consecutive confirmations will work in parallel (acting as an OR statement) so that any one confirmation can advance the work instructions. The top confirmation takes precedence if more than one trigger at the same time.
Manual Confirmation
Selecting Manual Confirmation in the Confirm On box will cause a window to pop up on the HMI scren when the work instructions is running that displays a custom message and waits for a user to press a button. the Message can be typed in in the Message box.
Variable Confirmations
Any other variable selected in the Confirm On box will not cause this popup to appear. The work instructions will wait for that variable to have the particular value condition that is selected. Confirmations can take place in the following conditions:
- Variable = TRUE
- Variable = FALSE
- Variable changes from FALSE to TRUE (Rising edge)
- Variable changes from TRUE to FALSE (Falling edge)
- Any change (Rising or Falling edge)
Options
Time (sec)
This is the minimum amount of time that is required before the confirmation is enabled to work. This can prevent operators from quickly jumping through steps or allow a vision camera to send updated vision results after a new step is entered before trying to use the camera outputs to confirm.
Auto Advance
If this is checked, then the minimum time will instead be an automatic confirmation time. After the set number of seconds, the confirmation will automatically execute without the need of any variable or other action. This is a simpler alternative to using a Timer that will set the $TIMER_ADVANCE variable.
Confirmations Options
- Step forward one or more steps.
- Step backward one or more steps.
- Go to a specific step number.
- Branch into another work instructions (Call Work Instructions).
- Terminate the work instructions.