wjsan / BqBusArduino

Simple protocol to easily communicate arduino boards to other devices

Open source easy of use protocol

BqBusArduino

BqBus is an extremely simple and intuitive open source communication protocol, whose objective is to allow data transmission between embedded devices and high-level computer systems, prioritizing performance and ease of implementation.

Table of contents

• Features
• Quickstart
• Example

Features

• Versatile data exchange beetween devices
• Lite implementation
• Easy of use

Quickstart

• Install library to arduino lib directory, and import him to your code

#include "BqBus.h"

• Create an BqBus Instance, with parameter size.

BqBus bqBus(size);

• On setup, initialize desired serial port, and set him to BqBus Bus property

  Serial.begin(9600);
  bqBus.setBus(Serial);

• On loop, make sure to always call the method 'communicationTask()' from your BqBus instance

bqBus.communicationTask();

• To write a value on a register use setReg(unsigned int address, int value) method.

bqbus.setReg(address, value);

• To read value from a register use GetReg(unsigned int address) method.

bqbus.getReg(address);

Example

This example, reads register 0, and turn on/off buitin led using readed value.

#include "BqBus.h"
  
BqBus pcApp(1);      //Instance to share 1 register with pcApp application
  
void setup() {
  // put your setup code here, to run once:
  Serial.begin(9600);                               //Initialize serial port
  pcApp.setBus(Serial);                             //Set serial port used to communicate with pcApp application
  pinMode(LED_BUILTIN, OUTPUT);                     //Configure board default output to control on-board led
}
  
void loop() {
  // put your main code here, to run repeatedly:
  pcApp.communicationTask();                      //Performs communication betteen arduino and pcApp application
  int cbValue = pcApp.getReg(0);                  //Get value from register address 0 (check box)
  digitalWrite(LED_BUILTIN, cbValue);             //Write check box value on led
}

Execution: