Language - LiveCode

LiveCode is a high level programming language, developed by [RunRev] that draws on English-like syntax for rapid application development.

Introduction

If this is your first time working with a Phidget, we suggest starting with the Getting Started page for your specific device. This can be found in the user guide for your device. That page will walk you through installing drivers and libraries for your operating system, and will then bring you back here to use LiveCode specifically.

LiveCode is capable of using the complete Phidget API, including events. We also provide example code in LiveCode for all Phidget devices.

LiveCode can be developed with Windows and Mac OS X..{{{5}}}

You can compare LiveCode with our other supported languages.

Quick Downloads

Just need the LiveCode drivers, libraries, and examples? Here they are:

C# API Documentation:

• LiveCode# API Manual Download
• General API (more help on functions common to all Phidgets)
• Device Specific APIs (more help on functions specific to your Phidget)

LiveCode Example Code:

• LiveCode Example Code

Libraries and Drivers:

• Phidgets LiveCode Library for Mac OS X
• Phidgets LiveCode Library for Windows
• 32 bit Windows (drivers, with libraries)
• 64 bit Windows (drivers, with libraries)
• General Mac OSX Libraries ( Mac OS X Library Setup Instructions)

Getting started with LiveCode

If you are new to writing code for Phidgets, we recommend starting by running, then modifying existing examples. This will allow you to:

• Make sure your libraries are properly linked
• Go from source code to a test application as quickly as possible
• Ensure your Phidget is hooked up properly

Instructions are divided up by operating system. Choose:

• Windows 2000 / XP / Vista / 7
• Mac OS X

Windows(2000/XP/Vista/7)

Libraries

• Phidgets LiveCode Library

Description

LiveCode on Windows depend on the following files, which the installers above put onto your system:

• phidget21.dll contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in C:\Windows\System32. It can be manually installed - check our Manual Installation instructions.
• phidgets_livecode.dll is the Phidgets library for LiveCode. It should be placed in the LiveCode User Extensions folder. More information will be provided in the Use Our Examples
• Externals.txt lets LiveCode know the name of the Phidgets LiveCode library as well as the name of its corresponding .dll. More information will be provided in the Use Our Examples

Use Our Examples

Please start by downloading the LiveCode Examples. These examples were written in LiveCode 4.5, but will also work with other versions.

• LiveCode Examples

Open up the LiveCode environment.

Go to Edit | Preferences

In the Files & Memory tab, locate the User Extensions field. This is the path where the Phidgets LiveCode Library go.

Traverse to this directory in Windows Explorer. In the folder, create a folder named Externals, if it isn't already created. Place Externals.txt and phidgets_livecode.dll inside the Externals folder.

‎

To run the examples, you first download them from above and unpack them into a folder. Traverse to the LiveCode/InterfaceKit Example folder, and open InterfaceKit-full.rev in LiveCode

After a few moments, the example will be running in Pointer Tool mode.

‎

Switch to the Browser Tool if you want to control GUI elements such as buttons, and scroll bars.

‎

Once you have the LiveCode example running, we have a teaching section below to help you follow them.

Write Your Own Code

When you are building a project from scratch, or adding Phidget function calls to an existing project, you'll need to configure your compiler / development environment to properly link the Phidget C# libraries. To begin:

• Generate a new Visual C# Windows Applications project with a descriptive name such as PhidgetTest.

• Add a reference to the .NET Phidgets library.

• Under the .NET tab, select Phidget21.NET.dll.

If you used our installer, these files are installed in C:\Program Files\Phidgets, by default. If it does not appear in this list, then you can browse to the Phidget Framework installation directory and add the file.

Then, in your the script of the mainstack, you will need to include the Phidget library:

  on preOpenStack
    if the short name of the owner of the target is the short name of me and "phidgets_livecodeExternalWrapper" is not among the lines of the stacksInUse then
      set the visible of the templateStack to false
      set the name of the templateStack to "phidgets_livecodeExternalWrapper"
      set the externals of the templateStack to $EXTERNAL_LIBRARY
      create stack
      start using stack "phidgets_livecodeExternalWrapper"
    end if
  end preOpenStack

The project now has access to the Phidget21 function calls and you are ready to begin coding.

The same teaching section which describes the examples also has further resources for programming your Phidget.

Mac OS X

LiveCode has excellent support on Mac OS X.

The first step in using LiveCode on Mac is to install the Phidget libraries. Compile and install them as explained on the getting started guide for your device. Then, the OS - Mac OS X page also describes the different Phidget files, their installed locations, and their roles....

Libraries

• Phidgets LiveCode Library

Description

LiveCode on Windows depend on the following files, which the installers above put onto your system:

• phidget21.dll contains the actual Phidgets library, which is used at run-time. If you used our installer, it's already correctly placed in C:\Windows\System32. It can be manually installed - check our Manual Installation instructions.
• phidgets_livecode.bundle is the Phidgets library for LiveCode Your environment has to know where this file is. By default, our installer puts this file into C:\Program Files\Phidgets. So, you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. For more information, please see the section for your specific compiler/environment. If you do not want to use our installer, you can get the file here.
• Externals.txt is the Phidgets library for LiveCode. Your compiler has to know where this file is. By default, our installer puts this file into C:\Program Files\Phidgets. So, you can either point your compiler to that location, or copy and link to it in a directory for your project workspace. For more information, please see the section for your specific compiler/environment. If you do not want to use our installer, you can get the file here.

Follow The Examples

By following the instructions for your operating system and compiler above, you probably now have a working example and want to understand it better so you can change it to do what you want. This teaching section has resources for you to learn from the examples and write your own.

Next, comes our API information. These resources outline the LiveCode Phidget methods:

• LiveCode API (This is the complete set of functions you have available for all Phidgets)
• Device Specific APIs - The one for your Phidget can be found in its user guide.

To learn the details behind opening, configuring, using, and closing your Phidget, try the General Phidget Programming page. That page also describes using the Phidget in an event-driven manner and in a traditional manner, both of which are available in LiveCode.

Example Flow

The Hello World example has this general structure so you can follow along. We also have an in-depth general introduction to writing Phidget code (like open, read data, etc), as well as the C# API for specific syntax:

// ----- Event and Other Functions ----- Create any Language-Specific Functions (exception handling) Create General Attach, Detach, and Error Handling Functions: On attach: Print Hello Message On detach: Print Goodbye Message		In LiveCode, you can name these event functions whatever you like. You will then pass them as function pointers to the Phidget library below in the Main Code section. This hooks them into the actual events when they occur. In the example code, the event functions common to all Phidgets are called things like AttachHandler() and DetachHandler(), etc. Some event functions will be specific to each device, like when a tag is read on an RFID board, or when a sensor value changes on an Interface Kit. Other functions are given in the examples to show you more detail on using your Phidget. For example, DeviceInitialize() will show what needs to be set up for your Phidget before using it.
// ----- Main Code ----- Create Manager Software Object Hook Event Functions created above to Device Open Device Wait for 'Enter' key character input Handle on-going attach and detach events Print Hello and Goodbye messages Exit upon input Close Device Delete Device		Creating a Phidget software object in C# is specific to the Phidget. For a Phidget Spatial, for example, this would involve creating a Spatial object. The examples show how to do this and other API functions. The object provides device specific methods and properties which are available from the API for your specific Phidget.

Common Problems and Solutions/Workarounds

Here you can put various frequent problems and our recommended solutions.