Language - Swift: Difference between revisions

From Phidgets Support
No edit summary
No edit summary
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Quick Downloads ==
{{#seo:|description=Learn how to use Phidget USB devices with Swift.}}
[[Category:Language]]


Already know what you're doing? Here you go:
== Get Started ==
With the Phidget22 library, it's easy to create Swift applications that work with Phidget devices.


=== Documentation ===
== Swift Libraries ==
If you've installed the Phidget drivers for  [[OS - macOS|macOS]] or [[OS - iOS|iOS]], then you already have the files you need for your project.


*{{Phidget22API}}
== Example Code ==
You can find examples for macOS and iOS on our [https://www.phidgets.com/?view=code_samples&lang=Swift Code Samples] page. Make sure you download one for the correct OS.


=== Example Code ===
[[Image:swift_example2.png|link=|center|750px]]


*{{SampleCode|Swift|Swift Examples}}
== XCode Configuration ==
[https://developer.apple.com/xcode/ Xcode] is an IDE provided by Apple that's used to develop code in a wide variety of programming languages, including Swift.


=== Libraries ===
=== macOS ===
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
|+ '''Instructions'''
|colspan="2"|{{hiddenh4|Use Our Examples}}||
|-
|colspan="2"|Start by downloading a [https://www.phidgets.com/?view=code_samples&lang=Swift Swift example] that will work with your Phidget.


{{MacQuickDownloads}}
Open the folder and run '''Package.swift''' to open it in Xcode.
{{iOSQuickDownloads}}
|-
| Next, simply press run. ||[[Image:Macos_swift_run2.png|link=https://cdn.phidgets.com/docs/images/b/b9/Macos_swift_run2.png|350px]]
|-
| Here's what the VoltageInput example will look like when it's running. Try playing around with the device and experiment with some of its functionality. The next step is configuring a new project and writing your own code. || [[Image:Macos_swift_output.png|link=https://cdn.phidgets.com/docs/images/0/00/Macos_swift_output.png|350px]]
|-
|colspan="2"|{{hiddenh4|Starting a New Project}}
|-
| Create a new XCode project and select a macOS app. || [[Image:Macos_new_proj.png|link=https://cdn.phidgets.com/docs/images/0/04/Macos_new_proj.png|350px]]
|-
| Name the project, select Swift as the language, and continue. || [[Image:Macos_new_nameproject.png|link=https://cdn.phidgets.com/docs/images/f/fb/Macos_new_nameproject.png|350px]]
|-
| Now that your project is created, you need to add the Phidget libraries.


== Getting Started with Swift ==
Go to File > '''Add Package Dependencies'''
Welcome to using Phidgets with Swift! By using Swift, you will have access to the complete {{Phidget22API}}, including events. We also provide example code in Swift for multiple Phidget classes.
|[[Image:Macos_swift_addpackage.png|link=https://cdn.phidgets.com/docs/images/1/13/Macos_swift_addpackage.png|350px]]
|-
| This will pop up the Swift package manager. || [[Image:Macos_swift_packageblank.png|link=https://cdn.phidgets.com/docs/images/3/3f/Macos_swift_packageblank.png|350px]]
|-
|Type this URL into the search bar in the top right:
<syntaxhighlight>https://www.phidgets.com/git/phidget22-swift.git</syntaxhighlight>
Then select the phidget22-swift package and click '''Add Package'''.
| [[Image:Macos_swift_packageurl.png|link=https://cdn.phidgets.com/docs/images/f/ff/Macos_swift_packageurl.png|350px]]
|-
|colspan="2"| Now you can access the Phidget libraries by adding the following line to the top of your files:
<syntaxhighlight>import Phidget22Swift</syntaxhighlight>
The project now has access to Phidgets you can begin coding. See [[Phidget Programming Basics]] for guidance on writing your own code.  
|}


== iOS ==
=== iOS ===
{{IOS_Languages}}
{| style="margin:auto;" class="table-no-border mw-collapsible mw-collapsed"
===Xcode===
|+ '''Instructions'''
====Use our examples====
|colspan="2"|{{hiddenh4|Use Our Examples}}||
One of the best ways to start programming with Phidgets is to use our example code as a guide. In order to run the examples for iOS you will need to download [https://developer.apple.com/xcode/ Xcode] from the Mac App Store.
|-
|colspan="2"|Start by downloading a [https://www.phidgets.com/?view=code_samples&lang=Swift Swift example] that will work with your Phidget.


Open the folder and run '''Package.swift''' to open it in Xcode.
|-
| Next, select the type of device you would like the application to run on, and press play. || [[Image:ios_swift_select_target.png|link=https://cdn.phidgets.com/docs/images/9/90/Ios_swift_select_target.png|350px]]
|-
|Here's what the VoltageInput example will look like when it's running. Try playing around with the device and experiment with some of its functionality. The next step is starting a new project and writing your own code.|| [[Image:ios_swift_output.png|link=https://cdn.phidgets.com/docs/images/1/1d/Ios_swift_output.png|200px]]
|-
|colspan="2"|{{hiddenh4|Starting a New Project}}
|-
|  Create a new XCode project and select an iOS app. || [[Image:ios_new_proj.png|link=https://cdn.phidgets.com/docs/images/d/d9/Ios_new_proj.png|350px]]
|-
| Name the project, select Swift as the language, and choose which devices will be supported. || [[Image:ios_new_nameproject.png|link=https://cdn.phidgets.com/docs/images/8/86/Ios_new_nameproject.png|350px]]
|-
| Now that your project is created, you need to add the Phidget libraries.
Go to '''File > Add Package Dependencies'''
| |[[Image:Macos_swift_addpackage.png|link=https://cdn.phidgets.com/docs/images/1/13/Macos_swift_addpackage.png|350px]]
|-
| This will pop up the Swift package manager. || [[Image:Macos_swift_packageblank.png|link=https://cdn.phidgets.com/docs/images/3/3f/Macos_swift_packageblank.png|350px]]
|-
|Type this URL into the search bar in the top right:
<syntaxhighlight>https://www.phidgets.com/git/phidget22-swift.git</syntaxhighlight>
Then select the phidget22-swift package and click '''Add Package'''.
| [[Image:Macos_swift_packageurl.png|link=https://cdn.phidgets.com/docs/images/f/ff/Macos_swift_packageurl.png|350px]]
|-
|colspan="2"| Now you can access the Phidget libraries by adding the following line to the top of your files:
<syntaxhighlight>import Phidget22Swift</syntaxhighlight>
The project now has access to Phidgets you can begin coding. See [[Phidget Programming Basics]] for guidance on writing your own code.
|}


Now that you have Xcode installed, download the Swift example:
==Phidget Programming Basics==
*{{SampleCode|Swift|Swift Example}}
{{PhidgetProgrammingBasicsLink}}


 
==API==
Next, open the example in Xcode and select the target you want the application to run on:
[{{SERVER}}/?view=api&lang=Swift Phidget22 API]
[[Image:ios_SelectTarget.png|link=|center]]
Note: you must be an [https://developer.apple.com/programs/ Apple Developer] in order to download the app to your iOS device.
 
 
To run the example, click on the Run button.
[[Image:ios_RuniOS.png|link=|center]]
 
 
The program will detect any servers that are currently online and have Phidgets connected. Here is an example output:
[[Image:ios_PhidgetApp_MainScreen.png|link= | 500px|center]]
 
 
After confirming that the Phidgets Example is working, you can proceed to run the example for your specific device. Do this by selecting your server and then continue to navigate through the hierarchy until you reach your device. After tapping your device, the example will show automatically. Currently, we have example programs for the following classes:
* DigitalInput
* DigitalOutput
* VoltageInput
* VoltageRatioInput
 
 
Here is an example of what the DigitalOutput example looks like:
[[Image:ios_PhidgetApp_DigitalOutput.png|link= | 500px |center]]
 
 
You should now have the example up and running for your device. Play around with the device and experiment with some of the functionality. When you are ready, the next step is configuring your project and writing your own code!
 
====Configure your project====
Whether you are  building a project from scratch, or adding Phidget functionality to an existing project, you will need to configure your development environment to properly link the Phidget library. To begin:
 
1. Create a new Xcode project
 
[[Image:Cocoa_CreateProject.png |link=|center]]
 
2. Select an iOS application. For this tutorial's purposes, we will use a Single View Application.
 
[[Image:iOS_SingleView.png |link=|center|850px]]
 
3. Give the project a descriptive name such as PhidgetTest, select Swift as the language, and choose which devices will be supported.
 
[[Image:iOS_NameProject_Swift.png|link=|center|850px]]
 
A .xcodeproj file will be created in the destination folder.
 
4. Remember the [{{SERVER}}/downloads/phidget22/libraries/ios/Phidget22_iOS.zip iOS drivers] you downloaded from the iOS page? Move the {{Code|iphoneos}} and {{Code|iphonesimulator}} folders as well as {{Code|phidget22.h}} into the same directory as your .xcodeproj
 
5. In Xcode, open Project Settings → Build Settings and navigate to the Linking section
 
6. In Linking → Other Linker Flags, following the following steps:
 
Select Any iOS Simulator SDK and enter: $(SRCROOT)/iphonesimulator/libPhidget22.a
 
Select Any iOS SDK and enter: $(SRCROOT)/iphoneos/libPhidget22.a
 
[[Image:iOS_LinkerFlags.png|link=|center]]
 
7. In Search Paths→Header Search Paths enter $(SRCROOT)
 
[[Image:iOS_HeaderSearchPaths.png|link=|center]]
 
8. In your header file, add a reference to phidget22.h
 
<syntaxhighlight lang="objc">
#import "phidget22.h"
</syntaxhighlight>
 
Success! The project now has access to Phidgets and we are ready to begin coding.
 
==Write Code==
 
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.
Your main reference for writing Objective-C code will be the {{Phidget22API}} Manual:
 
The following code snippets describe how to do various general tasks with Phidgets. You should be able to find places in the examples where these snippets exist, and modify them to suit your requirements. Remember: your main reference for writing Objective-C code will be the {{Phidget22API}} Manual and the example code.
 
==== Step One: Initialize and Open ====
You will need to declare your Phidget variable in your code. For example, we can declare a Phidget Digital Output like this:
 
<syntaxhighlight lang="swift">
var ch:PhidgetDigitalInput? = nil
</syntaxhighlight>
 
The object name for any Phidget is listed in the {{Phidget22API}} manual. Every type of Phidget also inherits functionality from the Phidget base class.
 
Next, the Phidget object needs to be initialized and opened.
 
<syntaxhighlight lang="swift">
PhidgetDigitalInput_create(&ch)
Phidget_open(ch)
</syntaxhighlight>
 
==== Step Two: Wait for Attachment (plugging in) of the Phidget ====
Simply calling open does not guarantee you can use the Phidget immediately. To use a Phidget, it must be plugged in (attached). We can handle this by using event driven programming and tracking the attach events and detach events. Alternatively, we can call the following function:
 
<syntaxhighlight lang="swift">
Phidget_openWaitForAttachment(ch, 5000) //wait for attach for 5 seconds, if not time out
</syntaxhighlight>
 
Waiting for attachment will block indefinitely until a connection is made, or until the timeout value is exceeded.
 
To use events to handle attachments, we need to first declare the function that will be called when an attach event is fired - in this case we will call the function gotAttach.
 
<syntaxhighlight lang="swift">
let gotAttach: @convention(c)(PhidgetHandle?, UnsafeMutableRawPointer?) -> () = {phid,context in
    DispatchQueue.main.async(execute: {
        let myObject = Unmanaged<YourViewController>.fromOpaque(context!).takeUnretainedValue()
        myObject.onAttachHandler()
    })
}
</syntaxhighlight>
 
Next, we have to modify our create/open code to emulate the following:
 
<syntaxhighlight lang="swift">
PhidgetDigitalInput_create(&ch)
Phidget_setOnAttachHandler(ch,gotAttach,bridge(self))
Phidget_open(ch)
</syntaxhighlight>
 
The bridge function mentioned above is described here:
 
<syntaxhighlight lang="swift">
func bridge<T : AnyObject>(_ obj : T) -> UnsafeMutableRawPointer {
    return Unmanaged.passUnretained(obj).toOpaque()
}
</syntaxhighlight>
 
==== Step Three: Do Things with the Phidget ====
We recommend the use of event driven programming when working with Phidgets. In a similar way to handling an attach event as described above, we can add an event handler with the following code:
 
<syntaxhighlight lang="swift">
PhidgetDigitalInput_setOnStateChangeHandler(ch, gotStateChange, bridge(self))
</syntaxhighlight>
 
This code will connect a function and an event. In this case, the gotStateChange function will be called when there has been a change to the devices input. Next, we need to create the gotStateChange function.
 
<syntaxhighlight lang="swift">
let gotStateChange: @convention(c)(PhidgetDigitalInputHandle?, UnsafeMutableRawPointer?, CInt) -> () = {_,context,cState in
    var state:Int32 = cState
    DispatchQueue.main.async(execute: {
        let myObject = Unmanaged<YourViewController>.fromOpaque(context!).takeUnretainedValue()
        myObject.onStateChangeHandler(state)
    })
}
</syntaxhighlight>
 
Above, the onStateChangeHandler method is invoked on the main thread. Event data is stored as an Int32.
 
The method onStateChangeHandler is defined as follows:
 
<syntaxhighlight lang="swift">
func onStateChangeHandler(_ state:Int32){
    if  state == 0{
        stateLabel.text = "False"
    }
    else{
        stateLabel.text = "True"
    }
}
</syntaxhighlight>
 
The example shown above simply changes the text of a UITextField to display whether the input is true or false.
 
Some events such as the attach or detach events belong to the base Phidget object and are thus common to all Phidgets. Please refer to the {{Phidget22API}} manual and the Swift examples for a list of events and their usage.
 
If events do not suit your needs, you can also poll the device directly for data using code like this:
 
<syntaxhighlight lang="swift">
var state = 0
PhidgetDigitalOutput_getState(ch, &state)
stateLabel.text = state ? "True" : "False"
</syntaxhighlight>
 
Polling code can be used inside a polling loop as an alternative to event driven programming.
 
==== Step Four: Close and Delete ====
At the end of your program, don't forget to close your device.
 
<syntaxhighlight lang="swift">
Phidget_close(ch)
PhidgetDigitalInput_delete(&digin)
</syntaxhighlight>
 
== Further Reading ==
 
[[Phidget Programming Basics]] - Here you can find the basic concepts to help you get started with making your own programs that use Phidgets.
 
[[Data Interval/Change Trigger]] - Learn about these two properties that control how much data comes in from your sensors.
 
[[Using Multiple Phidgets]] - It can be difficult to figure out how to use more than one Phidget in your program. This page will guide you through the steps.
 
[[Polling vs. Events]] - Your program can gather data in either a polling-driven or event-driven manner. Learn the difference to determine which is best for your application.
 
[[Logging, Exceptions, and Errors]] - Learn about all the tools you can use to debug your program.
 
[[Phidget Network Server]] - Phidgets can be controlled and communicated with over your network- either wirelessly or over ethernet.

Latest revision as of 21:03, 17 March 2026


Get Started

With the Phidget22 library, it's easy to create Swift applications that work with Phidget devices.

Swift Libraries

If you've installed the Phidget drivers for macOS or iOS, then you already have the files you need for your project.

Example Code

You can find examples for macOS and iOS on our Code Samples page. Make sure you download one for the correct OS.

Swift example2.png

XCode Configuration

Xcode is an IDE provided by Apple that's used to develop code in a wide variety of programming languages, including Swift.

macOS

Instructions
Use Our Examples
Start by downloading a Swift example that will work with your Phidget.

Open the folder and run Package.swift to open it in Xcode.

Next, simply press run. Macos swift run2.png
Here's what the VoltageInput example will look like when it's running. Try playing around with the device and experiment with some of its functionality. The next step is configuring a new project and writing your own code. Macos swift output.png
Starting a New Project
Create a new XCode project and select a macOS app. Macos new proj.png
Name the project, select Swift as the language, and continue. Macos new nameproject.png
Now that your project is created, you need to add the Phidget libraries.

Go to File > Add Package Dependencies

Macos swift addpackage.png
This will pop up the Swift package manager. Macos swift packageblank.png
Type this URL into the search bar in the top right: 
https://www.phidgets.com/git/phidget22-swift.git

Then select the phidget22-swift package and click Add Package.

Macos swift packageurl.png
Now you can access the Phidget libraries by adding the following line to the top of your files: 
import Phidget22Swift

The project now has access to Phidgets you can begin coding. See Phidget Programming Basics for guidance on writing your own code.

iOS

Instructions
Use Our Examples
Start by downloading a Swift example that will work with your Phidget.

Open the folder and run Package.swift to open it in Xcode.

Next, select the type of device you would like the application to run on, and press play. Ios swift select target.png
Here's what the VoltageInput example will look like when it's running. Try playing around with the device and experiment with some of its functionality. The next step is starting a new project and writing your own code. Ios swift output.png
Starting a New Project
Create a new XCode project and select an iOS app. Ios new proj.png
Name the project, select Swift as the language, and choose which devices will be supported. Ios new nameproject.png
Now that your project is created, you need to add the Phidget libraries.

Go to File > Add Package Dependencies

Macos swift addpackage.png
This will pop up the Swift package manager. Macos swift packageblank.png
Type this URL into the search bar in the top right: 
https://www.phidgets.com/git/phidget22-swift.git

Then select the phidget22-swift package and click Add Package.

Macos swift packageurl.png
Now you can access the Phidget libraries by adding the following line to the top of your files: 
import Phidget22Swift

The project now has access to Phidgets you can begin coding. See Phidget Programming Basics for guidance on writing your own code.

Phidget Programming Basics

To learn more about the structure of the example code, visit our Phidget Programming Basics guide.

API

Phidget22 API

Retrieved from "https://www.phidgets.com/docs/index.php?title=Language_-_Swift&oldid=35534"