Konashi Class Reference

Inherits from	NSObject
Conforms to	CBCentralManagerDelegate CBPeripheralDelegate KonashiJavaScriptBindings
Declared in	Konashi.h Konashi.m

Tasks

Properties

analogPinDidChangeValueHandler

このHandlerはAIOの値が変化した際に呼び出されます。

@property (nonatomic, copy) KonashiAnalogPinDidChangeValueHandler analogPinDidChangeValueHandler

Declared In

Konashi.h

batteryLevelDidUpdateHandler

このHandlerはバッテリー残量の値を取得した際に呼び出されます。

@property (nonatomic, copy) KonashiBatteryLevelDidUpdateHandler batteryLevelDidUpdateHandler

Declared In

Konashi.h

connectedHandler

このHandlerはKonashiが接続された際に呼び出されます。

@property (nonatomic, copy) KonashiEventHandler connectedHandler

Declared In

Konashi.h

digitalInputDidChangeValueHandler

このHandlerはKonashiPinModeInputに設定されているPIOの値が変化した際に呼び出されます。

@property (nonatomic, copy) KonashiDigitalPinDidChangeValueHandler digitalInputDidChangeValueHandler

Declared In

Konashi.h

digitalOutputDidChangeValueHandler

このHandlerはKonashiPinModeOutputに設定されているPIOの値が変化した際に呼び出されます。

@property (nonatomic, copy) KonashiDigitalPinDidChangeValueHandler digitalOutputDidChangeValueHandler

Declared In

Konashi.h

disconnectedHandler

このHandlerはKonashiが切断された際に呼び出されます。

@property (nonatomic, copy) KonashiEventHandler disconnectedHandler

Declared In

Konashi.h

i2cReadCompleteHandler

このHandlerはI2Cで接続されたモジュールからデータを読みだした際に呼び出されます。

@property (nonatomic, copy) KonashiI2CReadCompleteHandler i2cReadCompleteHandler

Declared In

Konashi.h

readyHandler

このHandlerはKonashiが使用可能状態になった際に呼び出されます。

@property (nonatomic, copy) KonashiEventHandler readyHandler

Declared In

Konashi.h

signalStrengthDidUpdateHandler

このHandlerはRSSIが変化した際に呼び出されます。

@property (nonatomic, copy) KonashiSignalStrengthDidUpdateHandler signalStrengthDidUpdateHandler

Declared In

Konashi.h

uartRxCompleteHandler

このHandlerはUartで値を受信した際に呼び出されます。

@property (nonatomic, copy) KonashiUartRxCompleteHandler uartRxCompleteHandler

Declared In

Konashi.h

Class Methods

analogRead:

AIOの値を取得します。 [Konashi analogReadRequest:] を用いてAIOの値の要求後に正しい値を取得可能です。

+ (int)analogRead:(KonashiAnalogIOPin)pin

Parameters

pin: AIOの番号

Return Value

AIOの値。

Discussion

Warning: このメソッドは非推奨です。 [Konashi analogPinDidChangeValueHandler] を用いて値の取得をしてください。

Declared In

Konashi.h

analogReadRequest:

AIO の指定のピンの入力電圧を取得するリクエストを konashi に送ります。入力電圧の取得が完了した際は KonashiEventAnalogIODidUpdateNotification が発行されます。

+ (KonashiResult)analogReadRequest:(KonashiAnalogIOPin)pin

Parameters

pin: AIOのピン名。

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Discussion

Bug: koshianでは正確な値を取得することができません。

Declared In

Konashi.h

analogReference

アナログ入出力の基準電圧を返します。

+ (int)analogReference

Return Value

アナログ入出力の基準電圧(mV)。

Declared In

Konashi.h

analogWrite:milliVolt:

AIO の指定のピンに任意の電圧を出力します。

+ (KonashiResult)analogWrite:(KonashiAnalogIOPin)pin milliVolt:(int)milliVolt

Parameters

pin: AIOのピン名。

milliVolt: 設定する電圧をmVで指定します。

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

batteryLevelRead

バッテリーの残量を取得します。

+ (int)batteryLevelRead

Return Value

バッテリーの残量(%)

Discussion

Warning: このメソッドは非推奨です。 [Konashi batteryLevelDidUpdateHandler] を用いて残量を取得してください。

Declared In

Konashi.h

batteryLevelReadRequest

konashi のバッテリ残量を取得するリクエストを konashi に送ります。値の取得が成功した際には KonashiEventBatteryLevelDidUpdateNotification が発行されます。

+ (KonashiResult)batteryLevelReadRequest

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

digitalRead:

指定したPIOの値を取得します。

+ (KonashiLevel)digitalRead:(KonashiDigitalIOPin)pin

Parameters

pin: PIOの番号

Return Value

指定したPIOの値。KonashiLevelHigh及びKonashiLevelLow。

Discussion

Warning: このメソッドは非推奨です。 [Konashi digitalInputDidChangeValueHandler] 及び [Konashi digitalOutputDidChangeValueHandler] を用いて値を取得してください。

Declared In

Konashi.h

digitalReadAll

PIOの値を取得します。

+ (int)digitalReadAll

Return Value

PIOの状態。各bitにおいてHighの場合は1、Lowの場合は0がセットされている。

Discussion

Warning: このメソッドは非推奨です。 [Konashi digitalInputDidChangeValueHandler] 及び [Konashi digitalOutputDidChangeValueHandler] を用いて値を取得してください。

Declared In

Konashi.h

digitalWrite:value:

PIOの特定のピンの出力状態を設定します。

+ (KonashiResult)digitalWrite:(KonashiDigitalIOPin)pin value:(KonashiLevel)value

Parameters

pin: PIOのピン名。

value: 設定するPIOの出力状態。KonashiLevelHigh もしくは KonashiLevelLow が指定可能です。

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

digitalWriteAll:

PIOの特定のピンの出力状態を設定します。この関数での引数は、PIO0〜PIO7の出力状態が8bit(1byte)で表現されます。bitとピンの対応は以下です。

+ (KonashiResult)digitalWriteAll:(int)value

Parameters

value: PIO0〜PIO7の出力に設定する値。

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

disconnect

konashiとの接続を解除します。

+ (KonashiResult)disconnect

Return Value

切断した場合はKonashiResultSuccess、すでに切断されている及び何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

find

iPhone周辺のkonashiを探します。この関数を実行した後、周りにあるkonashiのリストが出現します。リストに列挙されているkonashiのひとつをクリックすると、konashiに自動的に接続されます。その後、KonashiEventConnectedNotification と KonashiEventReadyToUseNotification が発行されます。

+ (KonashiResult)find

Return Value

探索が開始された場合はKonashiResultSuccess、既に接続されている場合はKonashiResultFailure。

Discussion

Warning: 本来、KonashiEventCentralManagerPowerOnNotification のイベント以前に find を実行しても無効ですが、この場合に限り、KonashiEventCentralManagerPowerOnNotification のイベント後に自動的に find が遅延実行されるように調整されています。

Declared In

Konashi.h

findWithName:

konashiの名前を指定して接続します。 find の場合はkonashiのリストが出現しますが、findWithName を実行した場合はリストが出ずに自動的に接続されます。名前に関しては、find を実行することによって下から出現するリストでリストアップされる konashi#4-0452 などの文字列です。konashi#-** の部分の数字は、konashiの緑色チップのシール上に記載されている番号と同じです。もし、指定した名前が見つからない場合は KonashiEventPeripheralNotFoundNotification が発行されます。

+ (KonashiResult)findWithName:(NSString *)name

Parameters

name: 接続したいkonashiの名前。例："konashi#4-0452"

Return Value

探索が開始された場合はKonashiResultSuccess、既に接続されている場合はKonashiResultFailure。

Discussion

Warning: 本来、KonashiEventCentralManagerPowerOnNotification のイベント以前に findWithName を実行しても無効ですが、この場合に限り、KonashiEventCentralManagerPowerOnNotification のイベント後に自動的に findWithName が遅延実行されるように調整されています。

Declared In

Konashi.h

i2cMode:

I2C を有効/無効を設定します。

+ (KonashiResult)i2cMode:(KonashiI2CMode)mode

Parameters

mode: 設定するI2Cのモード。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

i2cRead:data:

I2Cで接続されたモジュールから得られるデータを取得します。[Konashi i2cReadRequest:address:] を用いてデータの要求後に正しいデータを取得可能です。

+ (KonashiResult)i2cRead:(int)length data:(unsigned char *)data

Parameters

length: データの長さ(byte)

data: 格納する変数

Return Value

値の取得に成功した場合はKonashiResultSuccess、失敗した場合はKonashiResultFailure。

Discussion

Warning: このメソッドは非推奨です。 [Konashi i2cReadCompleteHandler] を用いてデータの取得をしてください。

Declared In

Konashi.h

i2cReadData

I2Cで接続されたモジュールから得られるデータを取得します。[Konashi i2cReadRequest:address:] を用いてデータの要求後に正しいデータを取得可能です。

+ (NSData *)i2cReadData

Return Value

取得したデータ

Declared In

Konashi.h

i2cReadRequest:address:

I2C で指定したアドレスからデータを読み込むリクエストを行います。この関数はリクエストを行うだけでデータは取得できません。

+ (KonashiResult)i2cReadRequest:(int)length address:(unsigned char)address

Parameters

length: 読み込むデータの長さ

address: 読み込み先のアドレス

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

i2cRestartCondition

I2C のリスタートコンディションを発行します。事前に i2cMode で I2C を有効にしておいてください。

+ (KonashiResult)i2cRestartCondition

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

i2cStartCondition

I2C のスタートコンディションを発行します。事前に i2cMode で I2C を有効にしておいてください。

+ (KonashiResult)i2cStartCondition

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

i2cStopCondition

I2C のストップコンディションを発行します。事前に i2cMode で I2C を有効にしておいてください。

+ (KonashiResult)i2cStopCondition

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

i2cWrite:data:address:

I2C で指定したアドレスにデータを書き込みます。事前に i2cMode で I2C を有効にしておいてください。

+ (KonashiResult)i2cWrite:(int)length data:(unsigned char *)data address:(unsigned char)address

Parameters

length: 書き込むデータの長さ(byte)

data: 書き込むデータ

address: 書き込み先アドレス

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Discussion

Warning: このメソッドは非推奨です。 [Konashi i2cWriteData:address] を用いてデータの書き込んでください。

Declared In

Konashi.h

i2cWriteData:address:

I2C で指定したアドレスにデータを書き込みます。事前に i2cMode で I2C を有効にしておいてください。

+ (KonashiResult)i2cWriteData:(NSData *)data address:(unsigned char)address

Parameters

data: 書き込むデータ

address: 書き込み先アドレス

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

i2cWriteString:address:

I2C で指定したアドレスに文字列を書き込みます。事前に i2cMode で I2C を有効にしておいてください。

+ (KonashiResult)i2cWriteString:(NSString *)data address:(unsigned char)address

Parameters

data: 書き込む文字列

address: 書き込み先アドレス

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

initialize

konashiの初期化を行います。

+ (KonashiResult)initialize

Return Value

初期化した場合はKonashiResultSuccess、既に初期化されていた場合はKonashiResultFailure。

Discussion

Warning: 一番最初に表示されるViewControllerのviewDidLoadなど、konashiを使う前に必ず initialize をしてください。

Declared In

Konashi.h

isConnected

konashiと接続中かを返します。

+ (BOOL)isConnected

Return Value

接続されている場合はYES、されていない場合はNO。

Declared In

Konashi.h

isReady

konashiに接続完了しているかを返します。

+ (BOOL)isReady

Return Value

接続完了している場合はYES、していない場合はNO.

Declared In

Konashi.h

peripheralName

接続中のkonashiの名前を返します。 konashiに接続していない状態で peripheralName を実行すると空文字 @“” が返ります。

+ (NSString *)peripheralName

Return Value

接続しているkonashiの名前。

Declared In

Konashi.h

pinMode:mode:

PIOのピンを入力として使うか、出力として使うかの設定を行います。

+ (KonashiResult)pinMode:(KonashiDigitalIOPin)pin mode:(KonashiPinMode)mode

Parameters

pin: 設定するPIOのピン名。

mode: ピンに設定するモード。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

pinModeAll:

PIOのピンを入力として使うか、出力として使うかの設定を行います。それぞれのビットでは、入力設定を0、出力設定を1として表現します。この関数での引数は、PIO0〜PIO7の入出力設定を8bit(1byte)で表現します。

+ (KonashiResult)pinModeAll:(int)mode

Parameters

mode: PIO0 〜 PIO7 の計8ピンの設定。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

pinPullup:mode:

PIOのピンをプルアップするかの設定を行います。初期状態では、PIOはプルアップされていません(NO_PULLS)。

+ (KonashiResult)pinPullup:(KonashiDigitalIOPin)pin mode:(KonashiPinMode)mode

Parameters

pin: 設定するPIOのピン名。

mode: ピンをプルアップするかの設定。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

pinPullupAll:

PIOのピンをプルアップするかの設定を行います。この関数での引数は、PIO0〜PIO7のプルアップ設定を8bit(1byte)で表現します。

+ (KonashiResult)pinPullupAll:(int)mode

Parameters

mode: 設定するPIOのピン名。

Return Value

PIO0 〜 PIO7 の計8ピンのプルアップの設定。

Declared In

Konashi.h

pwmDuty:duty:

指定のピンのPWMのデューティ(ONになっている時間)を設定します。単位はマイクロ秒(us)で指定してください。

+ (KonashiResult)pwmDuty:(KonashiDigitalIOPin)pin duty:(unsigned int)duty

Parameters

pin: PIOのピン名。

duty: デューティ。単位はマイクロ秒(us)で32bitで指定してください。最大2^32us = 71.5分です。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

pwmLedDrive:dutyRatio:

指定のピンのLEDの明るさを0%〜100%で指定します。 pwmLedDrive 関数を使うには pwmMode で KonashiPWMModeEnableLED を指定してください。

+ (KonashiResult)pwmLedDrive:(KonashiDigitalIOPin)pin dutyRatio:(int)ratio

Parameters

pin: PIOのピン名。

ratio: LEDの明るさ。0〜100 をしてしてください。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

pwmMode:mode:

PIO の指定のピンを PWM として使用する/しないかを設定します。 PIO のいずれのピンも PWMモードに設定できます。

+ (KonashiResult)pwmMode:(KonashiDigitalIOPin)pin mode:(KonashiPWMMode)mode

Parameters

pin: PWMモードの設定をするPIOのピン名。

mode: 設定するPWMのモード。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

pwmPeriod:period:

指定のピンのPWM周期を設定します。周期の単位はマイクロ秒(us)で指定してください。

+ (KonashiResult)pwmPeriod:(KonashiDigitalIOPin)pin period:(unsigned int)period

Parameters

pin: PIOのピン名。

period: 周期。単位はマイクロ秒(us)で32bitで指定してください。最大2^32us = 71.5分です。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

readUartData

uartの値を取得します。

+ (NSData *)readUartData

Return Value

取得した値。

Declared In

Konashi.h

reset

konashi を再起動します。 konashi が再起動すると、自動的にBLEのコネクションは切断されてしまいます。

+ (KonashiResult)reset

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

shared

シングルトンを取得します。

+ (Konashi *)shared

Return Value

Konashiのインスタンス。

Declared In

Konashi.h

signalStrengthRead

RSSIの値を取得します。

+ (int)signalStrengthRead

Return Value

RSSIの値。

Discussion

Warning: このメソッドは非推奨です。 [Konashi signalStrengthDidUpdateHandler] を用いてRSSIを取得してください。

Declared In

Konashi.h

signalStrengthReadRequest

konashi の電波強度を取得するリクエストを行います。値の取得が成功した際には KonashiEventSignalStrengthDidUpdateNotification が発行されます。

+ (KonashiResult)signalStrengthReadRequest

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

softwareRevisionString

ファームウェアのバージョンを返します。

+ (NSString *)softwareRevisionString

Return Value

ファームウェアのバージョン文字列。

Declared In

Konashi.h

uartBaudrate:

UART の通信速度を設定します。

+ (KonashiResult)uartBaudrate:(KonashiUartBaudrate)baudrate

Parameters

baudrate: UARTの通信速度。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

uartMode:

UART の有効/無効を設定します。有効にする前に、uartBaudrate でボーレートを設定しておいてください。

+ (KonashiResult)uartMode:(KonashiUartMode)mode

Parameters

mode: 設定するUARTのモード。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

uartMode:baudrate:

UART の有効/無効を設定します。有効にする前に、uartBaudrate でボーレートを設定しておいてください。

+ (KonashiResult)uartMode:(KonashiUartMode)mode baudrate:(KonashiUartBaudrate)baudrate

Parameters

mode: 設定するUARTのモード。

baudrate: 設定するUARTのボーレート。

Return Value

設定に成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

uartRead

uartの値を取得します。

+ (unsigned char)uartRead

Return Value

取得した値。

Discussion

Warning: このメソッドは非推奨です。 [Konashi uartRxCompleteHandler] 及び [Konashi readUartData] を用いて値を取得してください。

Declared In

Konashi.h

uartWrite:

UART でデータを送信します。

+ (KonashiResult)uartWrite:(unsigned char)data

Parameters

data: 送信するデータ。

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Discussion

Warning: このメソッドは非推奨です。 [Konashi uartWriteData:] を用いでデータを送信してください。

Declared In

Konashi.h

uartWriteData:

UART でデータを送信します。

+ (KonashiResult)uartWriteData:(NSData *)data

Parameters

data: 送信するデータ。

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

uartWriteString:

UART で文字列を送信します。

+ (KonashiResult)uartWriteString:(NSString *)string

Parameters

string: 送信する文字列

Return Value

成功した場合はKonashiResultSuccess、何らかの原因で失敗した場合はKonashiResultFailure。

Declared In

Konashi.h

Konashi Class Reference

Tasks

Event handler

Basic method

Digital I/O (PIO)

PWM

Analog I/O (AIO)

I2C

UART

Hardware Control

Digital I/O (PIO)

Analog I/O (AIO)

I2C

UART

Hardware Control

Properties

analogPinDidChangeValueHandler

Declared In

batteryLevelDidUpdateHandler

Declared In

connectedHandler

Declared In

digitalInputDidChangeValueHandler

Declared In

digitalOutputDidChangeValueHandler

Declared In

disconnectedHandler

Declared In

i2cReadCompleteHandler

Declared In

readyHandler

Declared In

signalStrengthDidUpdateHandler

Declared In

uartRxCompleteHandler

Declared In

Class Methods

analogRead:

Parameters

Return Value

Discussion

Declared In

analogReadRequest:

Parameters

Return Value

Discussion

Declared In

analogReference

Return Value

Declared In

analogWrite:milliVolt:

Parameters

Return Value

Declared In

batteryLevelRead

Return Value

Discussion

Declared In

batteryLevelReadRequest

Return Value

Declared In

digitalRead:

Parameters

Return Value

Discussion

Declared In

digitalReadAll

Return Value

Discussion

Declared In

digitalWrite:value:

Parameters

Return Value

Declared In

digitalWriteAll:

Parameters

Return Value

Declared In

disconnect

Return Value