Library to talk with VIVIWARE Cell Core.

VivicoreSerial library works on ATmega328PB which has 2 UART ports. One is for talking with VIVIWARE Cell Core, another is for flashing and debugging.

The official sketches of VIVIWARE Cell Branch are included as examples code.

The below table shows the corresponding Arduino IDE version VivicoreSerial library requires. Refer to How to setup to install Arduino IDE and configure the board and library manager.

VivicoreSerial library depends on Arduino core and libraries, and ATmegaBOOT.

And a part of the official sketches of VIVIWARE Cell Branch included as examples code depends on the following version's library modules. The library modules are neccessary to be installed on library manager or with archived zip file on Github if building examples code.

NOTE: The following libraries cannot be found on Library Manager, and need to be installed by zip archive got from the above Github link if you build and upload the examples code depending them.

• Arduino-misakiUTF16
• Arduino-LSM6DS3-LSM6DS3TRC

This instruction describes how to setup Arduino IDE to build VIVIWARE Cell Custom sketch and upload it to the board.

1. Download and install the required Arduino IDE version written on requisites which is available on Arduino official site top or Previous IDE Releases.
   • For Windows, use Windows Installer exe file but not zip file

1. Open Preferences of Arduino IDE.
2. Add URL https://raw.githubusercontent.com/vivitainc/custom_cell_boards/master/package_viviware_index.json into Additional Boards Manager URLs text box, and press OK button.

1. Open Arduino IDE and the menu Tools > Board: > Boards Manager....
2. Enter arduino into text box.
   • Find Arduino AVR Boards.
   • Select the required version written on requisites, and press Install button. Do not use another version to avoid unexpected built result mismatch.
   • After a while, check the status INSTALLED shown on right side of the version.
3. Enter viviware into text box.
   • Find VIVIWARE Cell Custom Boards.
   • Select the latest version (e.g. 6.3.0), and press Install button.
   • After a while, check the status INSTALLED shown on right side of the version.
4. Close Boards Manager by pressing Close button.

1. Open Arduino IDE and the menu Sketch > Include Library > Manage Libraries....
2. Select Type of All or Contributed, select Topic of All or Communication, and enter VivicoreSerial into text box, and find VivicoreSerial library.
3. Select the latest version of VivicoreSerial (e.g. 3.2.0+07010014), and press Install button.
4. After a while, check the status INSTALLED shown on right side of the version.
5. Close Library Manager by pressing Close button.

1. Open new sketch on Arduino IDE.
2. Copy the template code generated by VIVIWARE Developer and paste it to the new sketch.
3. Select board VIVIWARE Cell in the menu Tools > Board:.
4. Select version Custom in the menu Tools > Version:.
5. Select port connected to VIVIWARE Cell Custom board in the menu Tools > Port:.
6. Press Upload button.

Refer to README for library developer.

• 3.2.0 : Add features or fix issues as the following
  • Support VIVIWARE Cell Custom v4 board with custom_cell_board 6.3.0 or later
  • Support VIVIWARE Cell Custom v3 board as DeprecatedCustom
  • Drop supporting VIVIWARE Cell Custom v2, v1 board
• 3.1.0 : Add features or fix issues as the following
  • Support VIVIWARE Cell Custom v3 board with custom_cell_board 6.2.0 or later
  • Support VIVIWARE Cell Custom v2, v1 board as DeprecatedCustom
  • Support VIVIWARE Cell UserBranch with custom_cell_board 6.1.0 or later
• 3.0.0 : Add features or fix issues as the following
  • Remove setOverrideIni and use write before begin to override DC_INI
• 2.0.0 : Add features or fix issues as the following
  • Update UART protocol v7 to change the baudrate to 50k from 100k to avoid dropping data
  • Improve interface of begin, available, read, write, and flush
  • Update examples ino to support the latest library interface
• 1.1.0 : Add features or fix issues as the following
  • Send stored TX data set in discovery sequence
  • Make initial value to be able to override and send as DC_INI
  • Update examples ino to support the latest library interface
• 1.0.2 : Fix github URL for Library Manager
• 1.0.1 : Replace public README
• 1.0.0 : First version for Library Manager