EuPI-mode Guide Document

[phj0407]

Hi! As you know, now there is no docs for EuPI mode. So, I want to write it.

I'm going to write in guide and sample code about EuPI, referring to

• https://github.com/orgs/euphony-io/projects/3/views/1
• GETTING_STARTED.md

[phj0407]

First, I wrote it roughly. Please check and give me your opinion🙏🙏
About RxManager, I wrote it considering applying Singleton Pattern.

Getting Started

English

EuPI is one of the mode of Euphony library. Differently from Default mode that transmits String data, in this mode, transmitter make sound wave of a setting frequency, and receiver simply recognize whether it occurs.

in Transmitter

---

Generate sound waves though a microphone.

1. Create EuTxManager object which generates sound waves.

• Java

mTxManager mTxManager = new EuTxManager();

• Kotlin

val mTxManager = EuTxManager()

2. Initialize mTxManager for EuPI mode, using setMode.

• Java

mTxManager.setMode(EuOption.ModeType.EUPI);

• Kotlin

mTxManager.setMode(EuOption.ModeType.EUPI)

3. With callEuPI, set sound wave frequency and duration and generate sound wave.

• Java

mTxManager.callEuPI(19000.0, EuTxManager.EuPIDuration.LENGTH_LONG);

• Kotlin

mTxManager.callEuPI(19000.0, EuTxManager.EuPIDuration.LENGTH_LONG)

in Receiver

---

Part of receiving sound waves.

Requires permission of RECORD_AUDIO

• Write in AndroidManifest.xml

<uses-permission android:name="android.permission.RECORD_AUDIO" />

1. Create EuRxManager object which listens sound wave.

• Java

EuRxManager mRxManager = EuRxManager.getInstance();

• Kotlin

val mRxManager = EuRxManager.getInstance()

2. With setOption, set mRxManager to EuPI mode. Then, write process when listener recognizes sound wave.

• Java

mRxManager.setOption( EuOption.builder()
            .modeWith(EuOption.ModeType.EUPI)
            .build());

mRxManager.setOnWaveKeyDown( freq ){
	// when recognize signal occurs
}

• Kotlin

mRxManager.setOption( EuOption.builder()
            .modeWith(EuOption.ModeType.EUPI)
            .build())

mRxManager.setOnWaveKeyDown( freq ){
	// when recognize signal occurs
}

• Now, we have three method. Choose one which fit for purpose.

setOnWaveKeyPressed
// API that keep calling when recognize sound wave once.

setOnWaveKeyDown
// API that recognizes once when sound wave is generated.

setOnWaveKeyUp
// API that recognizes once when sound wave is generated and off.

3. Start receiving sound waves

• Java

mRxManager.listen(); // Listening Start

• Kotlin

mRxManager.listen() // Listening Start

4. End sound wave reception

• Java

mRxManager.finish(); // Listening finish

• Kotlin

mRxManager.finish() // Listening finish