Newsletter YOUMBLE
Home | Forums | WAYRUN SDK
2 posts / 0 new
Last post
admin
Offline
Joined: 03/23/2011
A brief SDK description

To install SDK in your application, simply copy .h files and specific library to you development environment. Add .h files to your project and specific library in link sections. 

The library works in event driven mode and is very simple to use. On initialization phase you must instantiate an HRManager in simulated or non-simulated mode. Simulated mode allow developers to test the solution without a WAYRUN module, in simulator, in a preliminary phase. Initialization:

 

if( iWantSimulate )

hrManager = [[HRManager alloc] initSimulatedWithHeartRate:95];

else

hrManager = [[HRManager alloc] init];

 

hrManager.delegate = self;

[hrManager beginDispatchingEvents];

 

On deallocate:

 

[hrManager endDispatchingEvents];

[hrManager release];

 

Your class must implement the HRManagerDelegate protocol:

 

- (void)accessoryConnected

Occurs when the user physically connects the accessory

 

- (void)accessoryDisconnected

Occurs when the user physically disconnects the accessory

 

- (void)beltConnected

Occurs when WAYRUN detects the wireless belt

 

- (void)beltDisconnected

Occurs when WAYRUN loose the connection with the belt

 

- (void)heartPulseDidOccurWithRate:(NSUInteger)rate

Occurs to notify the new current heart rate detected by WAYRUN

 

Following are useful HRManager properties:

 

@property(nonatomic,readonly)NSString *manifacturer;

WAYRUN manifacturer

@property(nonatomic,readonly)NSString *sn;

WAYRUN serial number

@property(nonatomic,readonly)NSString *hwVersion;

WAYRUN hardware version

@property(nonatomic,readonly)NSString *fwVersion;

WAYRUN firmware version

@property(nonatomic,readonly)NSString *name;

WAYRUN name

@property(nonatomic,readonly)NSString *modelNo;

WAYRUN model number

@property(nonatomic,readonly)NSString *libraryVersion;

This library version

 

@property(assign) id<HRManagerDelegate> delegate;

The manager delegate

@property(assign) BOOL isDispatchingEvents;

Indicates if the manager is dispatching heart rate events

@property(assign,readonly) BOOL isSimulated;

Indicates if the manager was initialized in simulated mode

@property(nonatomic,retain)HRInfo *lastHRInfo;

Indicates the last notified heart rate

 

@property(assign, readonly)BOOL isBeltConnected;

Indicates the connection status of the belt

@property(nonatomic,readonly)BOOL isAccessoryConnected;

Indicates the connection status of the accessory

 

That's all.

 

For trouble or information, post replies to this message.

Edited by admin on 06/07/2011 - 08:45
admin
Offline
Joined: 03/23/2011
New 1.2 version!

The new 1.2 version upgrades WAYRUN SDK capabilities! This is the brief How-To:


 

Updated: 24/10/2011

 

INSTRUCTIONS

 

Simply copy .h files and specific library to you development environment. 

Add .h files to your project and specific library in link sections.

Your Xcode projects should include "COM.YOUMBLE.PROTOCOLS.WAYRUN.V0_1" value

in "Supported external accessory protocols" list.

 

BRIEF DOC:

 

The library works in event driven mode and is very simple to use. 

On initialization phase you must instantiate an HRManager in simulated or

non-simulated mode. Simulated mode allow developers to test the solution

without a WAYRUN module, in simulator, in a preliminary phase. Initialization:

 

if( iWantSimulate )

// Use the simulation mode to produce a simulator output

hrManager = [[HRManager alloc] initSimulatedWithHeartRate:95];

else

// The normal mode is the correct mode with the hardware

hrManager = [[HRManager alloc] init];

 

// Setup delegate so you can receive events

hrManager.delegate = self;

 

// Begin receiving events

[hrManager beginDispatchingEvents];

 

On deallocate:

 

// End receiving events and release the manager

[hrManager endDispatchingEvents];

[hrManager release];

 

Your class must implement the HRManagerDelegate protocol:

 

- (void)accessoryConnected

Occurs when the user physically connects the accessory

 

- (void)accessoryDisconnected

Occurs when the user physically disconnects the accessory

 

- (void)beltConnected

Occurs when WAYRUN detects the wireless belt

 

- (void)beltDisconnected

Occurs when WAYRUN loose the connection with the belt

 

- (void)heartPulseDidOccurWithRate:(NSUInteger)rate

Occurs to notify the new current heart rate detected by WAYRUN

 

- (void)updateiHRInformation:(HRInfo*)info

This is an optional part of the protocol. It supplies all information about current WAYRUN activity at regular interval of time

 

Following are useful HRManager properties / methods:

 

@property(nonatomic,readonly)NSString *manifacturer;

WAYRUN manifacturer

@property(nonatomic,readonly)NSString *sn;

WAYRUN serial number

@property(nonatomic,readonly)NSString *hwVersion;

WAYRUN hardware version

@property(nonatomic,readonly)NSString *fwVersion;

WAYRUN firmware version

@property(nonatomic,readonly)NSString *name;

WAYRUN name

@property(nonatomic,readonly)NSString *modelNo;

WAYRUN model number

@property(nonatomic,readonly)NSString *libraryVersion;

This library version

@property(assign) id<HRManagerDelegate> delegate;

The manager delegate, is the instance that receive protocol events

@property(assign) BOOL isDispatchingEvents;

Indicates if the manager is dispatching heart rate events

@property(assign,readonly) BOOL isSimulated;

Indicates if the manager was initialized in simulated mode

@property(nonatomic,retain)HRInfo *lastHRInfo;

Indicates the last notified heart rate

@property(assign, readonly)BOOL isBeltConnected;

Indicates the connection status of the belt

@property(nonatomic,readonly)BOOL isAccessoryConnected;

Indicates the connection status of the accessory

 

 

updateiHRInformation: specification

 

A special treatment should be made for updateiHRInformation protocol message. This message is called passing an instance of HRInfo class. This class has specific properties:

 

@property(nonatomic,assign)NSUInteger rate;

Is the current average heart rate detected by WAYRUN

 

@property(nonatomic,assign)NSUInteger signal;

Is a measure of signal, or in other words, a numeric value with a inverse-proportional relation with the distance from the belt to the WAYRUN module, when the distance decrease under a specific value, the property "learning" become true, as the WAYRUN module try to pair with coded Polar™ Heart belt. If this stage successful, the "code" property assumes the specific belt code sent

 

@property(nonatomic,assign)BOOL learning;

True is the WAYRUN module is trying to detect the belt Polar™ code

 

@property(nonatomic,assign)NSUInteger code;

0 if the WAYRUN mode is receiving a non-coded belt signal, otherwise, contains the detected Polar™ code sent from the belt

 

@property(nonatomic,retain)NSDate* timestamp;

The timestamp at which the info was received

 

 

That's all.

 

For trouble or information consider the YOUMBLE forum at http://www.youmble.com/site/en/forum

or write directly to jacovone@youmble.com.

Login to post comments

 

 

Recent comments