The following is a step by step guide for users with Windows. Mac users may use it as a reference.

Quick start for users who already have a Python environment and a third-party editor installed:

  • Skip to step 3, or install pyserial and cyberpi libraries with the following commands:
    pip install pyserial
    pip install cyberpi

    1. Set up a Python environment

  • Go to the Python.org to select and download Python for your operating system.


image.png

  • Click the selected version to install, remember to check Add Python 3.6 to PATH, and then click Install Now.
  • You can also click Customize installation to install Python environment to a specified directory.

image.png

2. Install and configure the third-party Python editor (Visual Studio Code as an example)

Note: The steps may vary depending on the editor you are using. It is also recommended that you configure the installed Python environment in the editor.

  • Download VS Code according to your operating system. Download VS Code
  • Click the downloaded installation package to install it. (Just follow the prompts to install)
  • Click the VS Code icon on the desktop to run the program.
  • On the left side of the software interface, find the icon in the red rectangle as shown below and click on it.

image.png

  • Search for Python extension and install it. Note that the publisher is Microsoft.

image.png

  • Configure the previously installed Python environment in VS Code editor.
  • Create a new folder and a .py file and you can write basic Python programs.

3. Preparation for programming CyberPi with the third party editor

  • In Windows OS, press Windows + R on the keyboard, type CMD and press Enter, then the CMD window will pop up.

image.png
image.png

  • Install pyserial library, which ensures that CyberPi is connected to the third-party editor via USB cable or Bluetooth dongle.

    1. Type `pip install pyserial` in the CMD window and press enter, wait for the library to be installed.<br />![](https://cdn.nlark.com/yuque/0/2021/png/22023205/1628045093986-8edb30c1-e2bd-435a-92a9-1999f97c3c34.png#from=url&id=JZTLs&margin=%5Bobject%20Object%5D&originHeight=511&originWidth=976&originalType=binary&ratio=1&status=done&style=none)

  • Install cyberpi library, which is a Python library used for online programming of CyberPi.

    1.  Type ` pip install cyberpi` in the CMD window and press **Enter**, wait until the library is installed.
    3.  You can refer to the [Python API Documentation for CyberPi](https://www.yuque.com/makeblock-help-center-en/mcode/cyberpi-api).<br />![image.png](https://cdn.nlark.com/yuque/0/2021/png/22023205/1628048457375-99e2470c-cd7d-44cc-801c-7cb723058b25.png#clientId=u955dbee2-4678-4&from=paste&height=510&id=ub69f36f1&margin=%5Bobject%20Object%5D&name=image.png&originHeight=510&originWidth=978&originalType=binary&ratio=1&size=18207&status=done&style=none&taskId=u7f82c3ae-8c20-46b5-94fc-15b16d91cf6&width=978)

  • After the installation is completed, you can write programs in the editor configured with the Python environment.

    4. Note

The third-party editor currently only supports online programming for CyberPi.

5. Sample programs

CyberPi mouse

Need to install pynput module. Refer to the above step pip install pynput

  1. """"
  2. Name: Cyber Pi mouse 
  3. Introduction:
  4. Use the gyroscope module, buttons of Cyber Pi, and the mouse control function of pynput module, to convert Cyber Pi into a mouse. 
  5. You can also use the Bluetooth module to convert Cyber Pi into a wireless mouse. 
  7. """"
  8. from pynput.mouse import Button, Controller
  9. import cyberpi
  10. import time
  12. mouse = Controller()
  14. while True:
  15.     if cyberpi.is_tiltback():
  16.         mouse.move(-3, 0)
  17.         print(mouse.position)
  18.     if cyberpi.is_tiltforward():
  19.         mouse.move(3, 0)
  20.     if cyberpi.is_tiltleft():
  21.         mouse.move(0, -3)
  22.     if cyberpi.is_tiltright():
  23.         mouse.move(0, 3)
  24.     if cyberpi.controller.is_press("b"):
  25.         mouse.press(Button.left)
  26.         mouse.release(Button.left)
  27.         mouse.press(Button.left)
  28.         mouse.release(Button.left)
  29.     if cyberpi.controller.is_press("a"):
  30.         mouse.press(Button.right)
  31.         mouse.release(Button.right)
  32.     time.sleep(0.01)

CyberPi voice typer

  1. """"
  2. Name: 074 Cyber Pi voice typer
  3. Hardware: Cyber Pi 
  4. Introduction:
  5. Use the voice recognition function of Cyber Pi, and the keyboard control function of pynput module.
  6. The result of voice recognition will be printed out in a file through pynput.
  7. This program currently only supports English.
  9. """"
  10. import cyberpi
  11. from pynput.keyboard import Key, Controller
  12. import time
  14. keyboard = Controller()
  15. cyberpi.console.clear()
  16. cyberpi.led.on(0, 0, 0)
  17. cyberpi.set_recognition_url()
  18. cyberpi.cloud.setkey("Enter the cloud service authorization code")    # You can get it through your mBlock account 
  19. cyberpi.wifi.connect("WIFI name", "WIFI password")
  20. while not cyberpi.wifi.is_connect():
  21.     pass
  22. cyberpi.led.on(0,0,255)
  23. cyberpi.console.println("WIFI connected")
  24. cyberpi.console.println("--------------")
  25. cyberpi.console.println("Press the button A to start voice recognition")
  26. while True:
  27.     if cyberpi.controller.is_press('a'):
  28.         keyboard.press(Key.space)
  29.         cyberpi.console.clear()
  30.         cyberpi.led.on(100, 0, 0)
  31.         cyberpi.console.println("Start voice recognition")
  32.         cyberpi.audio.play("switch")
  33.         cyberpi.console.println("--------------")
  34.         cyberpi.cloud.listen("english", 2)
  35.         cyberpi.led.on(0, 0, 0)
  36.         say = cyberpi.cloud.listen_result()
  37.         cyberpi.console.println(say)
  38.         cyberpi.console.println("--------------")
  39.         for i in say:
  40.             if i == '':
  41.                  keyboard.press(' ')
  42.             else:
  43.                 keyboard.press(str(i))
  44.                 time.sleep(0.03)

Matplotlib volume histogram

  1. import cyberpi
  2. import time
  3. from matplotlib import pyplot as plt
  5. plt.rcParams['font.sans-serif'] = ['Microsoft YaHei']
  6. plt.ion()
  8. while True:
  9.     loud = cyberpi.get_loudness()
  10.     plt.clf()
  11.     plt.xlabel("Data name")
  12.     plt.ylabel("Volume readings")
  13.     y_locator = plt.MultipleLocator(5)
  14.     ax=plt.gca()
  15.     ax.yaxis.set_major_locator(y_locator)
  16.     plt.ylim(0,100)
  17.     plt.bar('Volume', loud, align='center',label=f'Temperature{loud}')
  18.     plt.title('Cyber Pi sound sensor readings')
  19.     plt.legend()
  20.     plt.show()
  21.     plt.pause(0.01)

Matplotlib multi-chart display

  1. from matplotlib import pyplot as plt
  2. import time
  3. import cyberpi
  5. loud_list = []
  6. bri_list = []
  7. plt.rcParams['font.sans-serif'] = ['Microsoft YaHei']
  8. plt.ion()
  9. plt.figure(figsize=(10,10))
  10. plt.figure(1)
  11. x_locator = plt.MultipleLocator(5)
  12. y_locator = plt.MultipleLocator(5)
  13. while True:
  14.     loud = cyberpi.get_loudness()
  15.     bri = cyberpi.get_bri()
  16.     loud_list.append(loud)
  17.     bri_list.append(bri)
  18.     battery = cyberpi.get_battery()
  19.     size = [battery, 100-battery]
  20.     status = [f'Remaining power：{battery}%', f'Power used：{100-battery}%']
  21.     ax1 = plt.subplot(221)
  22.     plt.title('Light line chart')
  23.     ax1.plot(bri_list)
  24.     ax2 = plt.subplot(222)
  25.     plt.title('Sound histogram')
  26.     ax2.xaxis.set_major_locator(x_locator)
  27.     ax2.yaxis.set_major_locator(y_locator)
  28.     plt.ylim(0,100)
  29.     ax2.bar('sound', loud)
  30.     ax3 = plt.subplot(223)
  31.     ax3.xaxis.set_major_locator(x_locator)
  32.     ax3.yaxis.set_major_locator(y_locator)
  33.     plt.xlim(0,100)
  34.     plt.ylim(0,100)
  35.     plt.title('Sound and volume scatter chart')
  36.     ax3.scatter(loud_list,bri_list)
  37.     ax4 = plt.subplot(224)
  38.     ax4.pie(size, labels = status, radius=1,wedgeprops = {'width': 0.3, 'edgecolor': 'w'})
  39.     plt.title('Cyber Pi power')
  40.     plt.pause(0.2)
  41.     plt.clf()
  42.     if cyberpi.controller.is_press('a'):
  43.         break
  44.     if len(bri_list) > 500:
  45.         bri_list = []
  46.         loud_list = []