Quick Start

Setup Wi-Fi

ReSpeaker is set to Repeater Mode as default, and you have to connect it to an existing wireless network before enjoying the speech recognition with the Internet.

When you first power on ReSpeaker, it will create a Wi-Fi network called "ReSpeakerXXXXXX". Here "XXXXXX" is the last 6 of your ReSpeaker MAC address, which is marked on the board. Connect your computer to this network.

If "ReSpeakerXXXXXX" does not appear, but "LinkIt_Smart_7688_XXXXXX" is found. Please click here.

Once you've obtained an IP address, open a web browser, and enter 192.168.100.1 in the address bar. After a few seconds, a web page will appear asking for ssid and password of an existing Wi-Fi network.

Select the Wi-Fi you wish to connect to and enter the password. When you press the OK button, ReSpeaker will join the specified network.

Now your ReSpeaker is able to visit the Internet.

Also, here are some ways to setup Wi-Fi with command line. Click here!

Dashboard

Visit 192.168.100.1 again, the Dashboard of ReSpeaker will appear. You are able to have a overview of ReSpeaker, set up network, wifi and system on Dashboard.

System Update

To update the firmware of you ReSpeaker, enter http://192.168.100.1/home.html in a web browser and click System Update.

Then ReSpeaker will check its version and the following web page will appear when there is an new firmware for ReSpeaker. Click "UPDATE" to continue and click "UPDATE NOW" after finish download. It will cost about 5 minutes for ReSpeaker to install the firmware and reboot, please don't turn off ReSpeaker when updating.

Update for old version

Note: If you can not update your ReSpeaker via Web or can not visit http://192.168.100.1/home.html, please click here to download the lastest firmware on your computer, copy it to a SD card and plug the SD card into ReSpeaker.

Connect to the serial console of ReSpeaker, type the following command lines to update the firmware:

mount /dev/mmcblk0p1 /mnt
cd /mnt
sysupgrade -n -F ramips-openwrt-latest-LinkIt7688-squashfs-sysupgrade.bin

It will cost about 3 minutes for ReSpeaker to install the firmware and reboot, please don't turn off ReSpeaker when updating.

Mopidy music player

Mopidy is an extensible music server written in Python. ReSpeaker runs Mopidy server for playing music from local disk, Spotify, SoundCloud, Google Play Music and more.

After connecting your computer to ReSpeaker's Wi-Fi, enter http://192.168.100.1/home.html in a web browser. Then Mopidy web page will appear.

Please click Music Player to enter the HTML frontend for the Mopidy music server. Now you are able to play music on ReSpeaker from local disk and radio streams!

File manager

File manager is an extension of Mopidy music server. It allows you to browse/search/edit/upload your local file system. Enter http://192.168.100.1/home.html in a web browser and click File Manager to get started.

Web terminal

Web terminal Pyxterm, a pure python websocket terminal server, is also an extension of Mopidy music server to get the web terminal. Enter http://192.168.100.1/home.html in a web browser and click Web Terminal to login in ReSpeaker terminal. The default username and password are all "root".

Serial console

Baudrate: 57600
Terminal app - on Windows, putty is recommended. On Linux/Mac, use screen /dev/xxx 57600

First impression with Voice Interaction - ReSpeaker, play music!

With Bing Speech API, ReSpeaker can turn on and recognize audio coming from the microphone in real-time, or recognize audio from a file.

To use Bing Speech API, first you have to get a key of Microsoft Cognitive Services from here, and copy it to BING_KEY = '', then save the following code in playmusic.py and run it python playmusic.py

import logging
import time
import os
from threading import Thread, Event
from respeaker import Microphone
from respeaker.bing_speech_api import BingSpeechAPI

# use madplay to play mp3 file     
os.system('madplay')               

# get a key from https://www.microsoft.com/cognitive-services/en-us/speech-api
BING_KEY = ''      


def task(quit_event):                                                         
    mic = Microphone(quit_event=quit_event)                                   
    bing = BingSpeechAPI(key=BING_KEY)                                        

    while not quit_event.is_set():
        if mic.wakeup('respeaker'):        
            print('Wake up')               
            data = mic.listen()            
            try:                      
                text = bing.recognize(data)
                if text:           
                    print('Recognized %s' % text)
                    if 'play music' in text:
                        print('I will play music!')
                        os.system('madplay Tchaikovsky_Concerto_No.1p.mp3')
            except Exception as e:               
                print(e.message)                 

def main():                                                              
    logging.basicConfig(level=logging.DEBUG)                                                           
    quit_event = Event()        
    thread = Thread(target=task, args=(quit_event,))
    thread.start()                          
    while True:                             
        try:                                
            time.sleep(1)                           
        except KeyboardInterrupt:                   
            print('Quit')                           
            quit_event.set()
            break        
    thread.join()                

if __name__ == '__main__':       
    main()

Try to say "ReSpeaker, play music!". Then ReSpeaker will play "Tchaikovsky_Concerto_No.1p.mp3" in the current path with madplay.

Play with AirPlay&DLNA

With Airplay&DLNA, you can stream music to ReSpeaker.

Use Airplay

Connect to the same Wi-Fi network on your iOS device and ReSpeaker.
On your iOS device, swipe up from the bottom of your screen to open Control Center.
In Control Center, swipe horizontally to find the Now Playing screen.
Select ReSpeaker as the following picture:
Connect your headphone/speaker to respeaker, then you can enjoy the music now.

Use DLNA

Connect your smart phone to ReSpeaker's Wi-Fi.
On your smart phone, open a DLNA software, such as: AllConnect.
Select ReSpeaker as the following picture:
Connect your headphone/speaker to respeaker, then you can enjoy the music now.

Use SD Card to Extend Storage

More often than not, a limited amount of storage is available on embedded devices(ReSpeaker has only 5M on-board flash storage left for users). More storage for applications and data can expand ReSpeaker's potential, so use SD card to extend storage as an extroot is a good choice.

By employing extroot, expansion of the storage capacity of your root file system is accomplished by using an added storage device. During the boot process, external storage space is mounted as the root file system, or in an overlay configuration over the original file system.

Make sure your SD card is plugged into ReSpeaker and /dev/mmcblk0p1 can be detected by df -h or ls /dev.

root@ReSpeaker:/# df -h Filesystem Size Used Available Use% Mounted on rootfs 1.8M 832.0K 960.0K 46% / /dev/root 29.0M 29.0M 0 100% /rom tmpfs 61.7M 276.0K 61.5M 0% /tmp /dev/mtdblock6 1.8M 832.0K 960.0K 46% /overlay overlayfs:/overlay 1.8M 832.0K 960.0K 46% / tmpfs 512.0K 0 512.0K 0% /dev /dev/mmcblk0p1 7.4G 2.5M 7.4G 0% /tmp/run/mountd/mmcblk0p1
Format your SD card into two partitions, one is FAT32, the other is EXT4. EXT4 file system will be as an extroot while FAT32 will be as a normal storage device, which is able to transfer files between ReSpeaker and your PC.

``` umount /dev/mmcblk0p1 fdisk /dev/mmcblk0

------------------ fdisk ------------------------

Command (m for help):o Created a new DOS disklabel Command (m for help):n Partition type p primary (0 primary, 0 extended, 4 free) e extended (container for logical partitions) Select (default p):p Partition number (1-4, default 1):1 First sector (2048-15523839, default 2048): Last sector, +sectors or +size{K,M,G,T,P} (2048-15523839, default 15523839): +2G Command (m for help):n Partition type p primary (1 primary, 0 extended, 3 free) e extended (container for logical partitions) Select (default p):p Partition number (1-4, default 2):2 First sector (4196352-15523839, default 4196352): Last sector, +sectors or +size{K,M,G,T,P} (4196352-15523839, default 15523839): Command (m for help):w The partition table has been altered. Calling i[ 292.010000] mmcblk0: p1 p2 octl() to re-read partition table. Syncing disks.

------------------ end ------------------------

mkfs.fat /dev/mmcblk0p1 mkfs.ext4 /dev/mmcblk0p2

reload mtk_sd kernel module

rmmod mtk_sd insmod mtk_sd ```
Prepare your external storage root overlay.

mount /dev/mmcblk0p2 /mnt ; tar -C /overlay -cvf - . | tar -C /mnt -xf - ; umount /mnt
Create fstab with the following command. This command will create a fstab template enabling all partitions and setting '/mnt/mmcblk0p2' partition as '/overlay' partition.

block detect > /etc/config/fstab; sed -i s/option$'\t'enabled$'\t'\'0\'/option$'\t'enabled$'\t'\'1\'/ /etc/config/fstab; sed -i s#/mnt/mmcblk0p2#/overlay# /etc/config/fstab; cat /etc/config/fstab;
Check if it is mountable to overlay.

root@mylinkit:/# mount /dev/mmcblk0p2 /overlay/ root@ReSpeaker:/# df -h Filesystem Size Used Available Use% Mounted on rootfs 1.8M 832.0K 960.0K 46% / /dev/root 29.0M 29.0M 0 100% /rom tmpfs 61.7M 276.0K 61.5M 0% /tmp /dev/mtdblock6 5.2G 11.8M 4.9G 0% /overlay overlayfs:/overlay 1.8M 832.0K 960.0K 46% / tmpfs 512.0K 0 512.0K 0% /dev /dev/mmcblk0p2 5.2G 11.8M 4.9G 0% /tmp/run/mountd/mmcblk0p2 /dev/mmcblk0p1 2.0G 4.0K 2.0G 0% /tmp/run/mountd/mmcblk0p1 /dev/mmcblk0p2 5.2G 11.8M 4.9G 0% /overlay
Reboot ReSpeaker and check again. If SD card is mounted automatically, you are done. More informations about extroot, please click here.

Install software on ReSpeaker

After extending storage with a SD card, there are enough storage to install software on ReSpeaker.

Install git

opkg update opkg install git git-http