Mparadis at 21:40, 17 December 2024

2024-12-17T21:40:31Z

← Older revision		Revision as of 21:40, 17 December 2024
Line 21:		Line 21:
	<p>First, make sure you have the following installed:</p>		<p>First, make sure you have the following installed:</p>

	<p>● Phidgets Drivers for ~~MacOS~~ on your development machine ~~(see Part 1 of this user guide)~~</p>		<p>● <span>[https://www.phidgets.com/docs/OS_-_macOS Phidgets Drivers for macOS]</span> on your development machine</p>

	<p>● <span>[https://developer.apple.com/xcode/ Xcode]</span> from the Mac App Store</p>		<p>● <span>[https://developer.apple.com/xcode/ Xcode]</span> from the Mac App Store</p>

Mparadis: Created page with "

Language - Objective C

2021-03-08T21:46:40Z

Created page with "<div class="phd-slide-deck" data-deck="PT3_OBJC_IOS_XCODE"> <div class="phd-slide-deck-header"><h3>Language - Objective C</h3></div> <div class="phd-slides"> <div class="phd-s..."

New page
<div class="phd-slide-deck" data-deck="PT3_OBJC_IOS_XCODE">
<div class="phd-slide-deck-header"><h3>Language - Objective C</h3></div>
<div class="phd-slides">
<div class="phd-slide">
<h2>iOS with Xcode</h2>

<div class="phd-panels">
<div class="phd-panel phd-flex-column-align-center phd-flex-column-justify-middle">
<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/200x-/50/xcode.jpg"></div>
</div>
<div class="phd-panel phd-flex-column-align-left phd-flex-column-justify-top">
<p>Welcome to using Phidgets with Objective C! By using Objective C, you will have access to the complete Phidget22 API, including events.</p>
<p>Xcode is an IDE provided by Apple that can be used to develop code in a wide variety of programming languages, including Objective C.</p>
</div>
</div>
</div>

<div class="phd-slide">
<h2>Requirements</h2>

<p>First, make sure you have the following installed:</p>

<p>● Phidgets Drivers for MacOS on your development machine (see Part 1 of this user guide)</p>

<p>● <span>[https://developer.apple.com/xcode/ Xcode]</span> from the Mac App Store</p>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>Next, download and unpack the Phidget libraries for iOS development</p>

<p>● <span>[https://www.phidgets.com/downloads/phidget22/libraries/ios/Phidget22_iOS.zip Phidget iOS Libraries]</span></p>

<p>You will later need to reference these files from your Xcode project in order to use Phidgets.</p>

<p>Next, download the Objective-C example:</p>

<p>● <span>[https://www.phidgets.com/?view=code_samples&lang=Objective-C Objective-C Example]</span></p>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>Unpack the Objective-C example and navigate to <b>Phidget.xcodeproj</b>. Open the file in Xcode:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/Objectivec_open.png"></div>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>With <b>Phidgets</b> as your target, navigate to Build Settings and find the <b>Header Search Paths</b> setting:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/Ios_header.png"></div>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>
The header file phidget22.h was included in the Phidget iOS libraries download. Add a reference to the folder that contains phidget22.h under the
<b>Header Search Paths</b> setting:
</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x325/50/Ios_header_path.png"></div>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>Next, find the <b>Other Linker Flags</b> setting:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/800x-/50/Ios_linker.png"></div>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>Add a reference to the Phidget libraries that were included in the Phidget iOS libraries download:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x350/50/Ios_linker_path.png"></div>
</div>

<div class="phd-slide">
<h2>Use Our Examples</h2>

<p>Now that the library files are linked, simply select the type of device you would like the application to run on and press play:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x325/50/Ios_simulator.png"></div>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>The application will detect any servers that are currently online and have Phidgets connected. Here is an example output:</p>

<div class="phd-panels">
<div class="phd-panel phd-flex-column-align-center phd-flex-column-justify-top">
<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x300/50/Ios_PhidgetApp_MainScreen.png"></div>
</div>
<div class="phd-panel phd-flex-column-align-left phd-flex-column-justify-top">
<p>
First, confirm that the Phidgets Example is working. Then, run the example for your specific device 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:
</p>
<ul>
<li>DigitalInput</li>
<li>DigitalOutput</li>
<li>VoltageInput</li>
<li>VoltageRatioInput</li>
</ul>
</div>
</div>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<p>Here is an example of what the VoltageInput example looks like:</p>

<div class="phd-panels">
<div class="phd-panel phd-flex-column-align-center phd-flex-column-justify-top">
<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x300/50/Ios_example_run.png"></div>
</div>
<div class="phd-panel phd-flex-column-align-left phd-flex-column-justify-top">
<p>
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!
</p>
</div>
</div>
</div>

<div class="phd-slide">
<h2>Configure Your Project</h2>

<p>
When you are building a project from scratch, or adding Phidgets to an existing project, you'll need to configure your development environment to properly link
the Phidget iOS library. To begin, create a new Xcode project:
</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x325/50/Cocoa_CreateProject.png"></div>
</div>

<div class="phd-slide">
<h2>Configure Your Project</h2>

<p>Select an iOS application. For this tutorial's purposes, we will use a Single View Application:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x350/50/IOS_SingleView.png"></div>
</div>

<div class="phd-slide">
<h2>Configure Your Project</h2>

<p>Name the project, select Objective-C as the language, and choose which devices will be supported:</p>

<div class="phd-lazy-image" data-src="https://www.phidgets.com/decks/PT3_OBJC_IOS_XCODE/-x350/50/IOS_NameProject_objc.png"></div>
</div>

<div class="phd-slide">
<h2>Configure Your Project</h2>

<p>
Now that your project is created, you need to add references to the Phidget iOS libraries in the same way you added them to run our example code earlier in this
guide.
</p>

<p>After you have linked the Phidget iOS libraries, simply add a reference to phidget22.h in your header file:</p>

<pre data-syntax-language="objectivec">#import <Phidget22/phidget22.h></pre>

<p>Success! The project now has access to Phidgets and we are ready to begin coding.</p>

<p>Remember: your main reference for writing Objective C code will be:</p>

<p>● The <span>[https://www.phidgets.com/?view=api Phidget22 API]</span> Manual (select 'C' as the language)</p>

<p>● Objective C <span>[https://www.phidgets.com/?view=code_samples&lang=Objective-C example code]</span></p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step One: Initialize and Open</h3>

<p>You will need to declare your Phidget object in your code. For example, we can declare a digital input object like this:</p>

<pre data-syntax-language="objectivec">PhidgetDigitalInput ch;</pre>

<p>Next, the Phidget object needs to be initialized and opened.</p>

<pre data-syntax-language="objectivec">
PhidgetDigitalInput_create(&ch);
Phidget_open((PhidgetHandle)ch);</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step One: Initialize and Open</h3>

<p>We won't go into detail on it in this guide, but this is the previous code with error handling:</p>

<pre data-syntax-language="objectivec">
PhidgetReturnCode res;
const char* errorString;

res = PhidgetDigitalInput_create(&ch);
if(res != EPHIDGET_OK){
Phidget_getErrorDescription ( returnValue, &errorString );
NSLog(@"Handle error here");
}

res = Phidget_open((PhidgetHandle)ch);
if(res != EPHIDGET_OK){
Phidget_getErrorDescription ( returnValue, &errorString );
NSLog(@"Handle error here");
}</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Two: Wait for Attachment of the Phidget</h3>

<p>
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. Alternatively, we can modify our code so we wait for an attachment:
</p>

<pre data-syntax-language="objectivec">
PhidgetDigitalInput_create(&ch);
Phidget_openWaitForAttachment(ch, 5000);</pre
>

<p>Waiting for attachment will block indefinitely until a connection is made, or until the timeout value is exceeded.</p>

<p>To use events to handle attachments, we have to modify our code slightly:</p>

<pre data-syntax-language="objectivec">
PhidgetDigitalInput_create(&ch);
Phidget_setOnAttachHandler((PhidgetHandle)ch,gotAttach,(__bridge void)self);
Phidget_open((PhidgetHandle)ch);</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Two: Wait for Attachment of the Phidget</h3>

<p>Next, we have to declare the function that will be called when an attach event is fired - in this case the function <b>gotAttach</b> will be called:</p>

<pre data-syntax-language="objectivec">
static void gotAttach(PhidgetHandle phid, void context){
[(__bridge id)context performSelectorOnMainThread:@selector(deviceAttached)
withObject:nil
waitUntilDone:NO];
}</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Three: Do Things with the Phidget</h3>

<p>
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 also add an
event handler for a state change event:
</p>

<pre data-syntax-language="objectivec">
PhidgetDigitalInput_create(&ch);
Phidget_setOnAttachHandler((PhidgetHandle)ch,gotAttach,(__bridge void)self);
PhidgetDigitalInput_setOnStateChangeHandler(ch, gotStateChange, (__bridge void)self);
Phidget_open((PhidgetHandle)ch);</pre
>

<p>
This code will connect a function and an event. In this case, the <b>gotStateChange</b> function will be called when there has been a change to the devices
input. Next, we need to create the <b>gotStateChange</b> function.
</p>

<pre data-syntax-language="objectivec">
void gotStateChange(PhidgetDigitalInputHandle phid, void context, int state){
[(__bridge id)context performSelectorOnMainThread:@selector(onStateChangeHandler:)
withObject:[NSNumber numberWithInt:state]
waitUntilDone:NO];
}</pre
>

<p>Above, the onStateChangeHandler method is invoked on the main thread. Event data is stored as an NSNumber.</p>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Three: Do Things with the Phidget</h3>

<p>The method <b>onStateChangeHandler</b> is defined as follows:</p>

<pre data-syntax-language="objectivec">
- (void)onStateChangeHandler:(NSNumber )state{
if(state.intValue)
stateTextField.stringValue = @"True";
else
stateTextField.stringValue = @"False";
}</pre
>

<p>If events do not suit your needs, you can also poll the device directly for data using code like this:</p>

<pre data-syntax-language="objectivec">
int state;

PhidgetDigitalInput_getState(ch, &state);
stateTextField.stringValue = [NSString stringWithFormat:@"%@", state ? @"True" : @"False"];</pre
>
</div>

<div class="phd-slide">
<h2>Write Code</h2>

<h3>Step Four: Close and Delete</h3>

<p>At the end of your program, be sure to close and delete your device:</p>

<pre data-syntax-language="objectivec">
Phidget_close((PhidgetHandle)ch);
PhidgetDigitalInput_delete(&ch);</pre
>
</div>

<div class="phd-slide">
<h2>What's Next?</h2>

<p>{{Slide_Deck_PT3_Outro}}</p>
</div>
</div>

<div class="phd-navigation-buttons">
<div class="phd-simple-button phd-to-slide-button" data-navigation-direction="prev">«</div>
<div class="phd-progress-container">
<div class="phd-progress-bar">
<div class="phd-progress-slide-info"></div>
</div>
</div>

<div class="phd-simple-button phd-to-slide-button" data-navigation-direction="next">»</div>
</div>
<div hidden class="phd-hidden-breadcrumb-label" data-label="Xcode"></div>
</div>

Template:PT3 OBJC IOS XCODE - Revision history

Mparadis at 21:40, 17 December 2024

Language - Objective C