Reference
PiDuino Library (libpiduino) aims to support the core official Arduino reference published in the Arduino official website as of April 2016 plus the Wire and SPI libraries. Note that the Arduino API has many legacy functions that although keep no longer used, the ported functions and libraries are only the ones published on the official website.
libpiduino 1.0.0 has 99 functions implemented out of 111 functions, this means that about 89% of the core official Arduino functions plus the I2C and SPI libraries were implemented. Also 11 (EXTRA) functions which give more functionality to the library were included. Note that only hardware PWM is included in this release and software PWM will be included in the next one.
(*) - Functions that have changes compared the official Arduino reference.
(#) - Functions that require sudo to run them.
(EXTRA) - Extra functions not in the official Arduino reference.
- Digital I/O
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| (*) pinMode(pin, mode) | YES |
| digitalWrite(pin, value) | YES |
| digitalRead(pin) | YES |
- Analog I/O (ADC and PWM)
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| analogReference(type) | NO - No hardware support for RPi |
| analogRead(pin) | NO - No hardware support for RPi |
| (#) analogWrite(pin, value) - PWM | YES |
| (EXTRA, #) setPwmDutyCycle(pin, dutycycle) | YES |
| (EXTRA, #) setPwmFrequency(pin, frequency, dutycycle) | YES |
| (EXTRA, #) setPwmFrequency(pin, frequency) | YES |
| (EXTRA, #) setPwmPeriod(pin, microseconds) | YES |
- Advanced I/O
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| (#) tone(pin, frequency) | YES |
| (#) tone(pin, frequency, duration) | YES |
| (EXTRA, #) tone(pin, frequency, duration, block) | YES |
| (#) noTone(pin) | YES |
| shiftOut(dataPin, clockPin, bitOrder, value) | YES |
| shiftIn(dataPin, clockPin, bitOrder) | YES |
| pulseIn(pin, value) | YES |
| pulseIn(pin, value, timeout) | YES |
- Time
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| time = millis() | YES |
| time = micros() | YES |
| delay(ms) | YES |
| delayMicroseconds(us) | YES |
- External Interrupts
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| attachInterrupt(digitalPinToInterrupt(pin), ISR, mode) | YES |
| detachInterrupt(interrupt) | YES |
| detachInterrupt(digitalPinToInterrupt(pin)) | YES |
- Serial
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| if (Serial) | YES |
| Serial.available() | YES |
| Serial.availableForWrite() | YES |
| Serial.begin(speed) | YES |
| Serial.begin(speed, config) | YES |
| (EXTRA) Serial.begin(driverName, speed) | YES |
| (EXTRA) Serial.begin(driverName, speed, config) | YES |
| Serial.end() | YES |
| Serial.find(target) | YES |
| Serial.findUntil(target, terminal) | YES |
| Serial.flush() | YES |
| Serial.parseFloat() | YES |
| Serial.parseInt() | YES |
| Serial.parseInt(char skipChar) | YES |
| Serial.peek() | YES |
| Serial.print(val) | YES |
| Serial.print(val, format) | YES |
| Serial.println(val) | YES |
| Serial.println(val, format) | YES |
| (EXTRA) Serial.printf(format, …) | YES |
| Serial.read() | YES |
| Serial.readBytes(buffer, length) | YES |
| Serial.readBytesUntil(character, buffer, length) | YES |
| Serial.readString() | YES |
| Serial.readStringUntil(terminator) | YES |
| (EXRTA) Serial.readStringCommand(character, buffer, length) | YES |
| Serial.setTimeout(time) | YES |
| Serial.write(val) | YES |
| Serial.write(str) | YES |
| Serial.write(buf, len) | YES |
| serialEvent() | In Progress |
- Wire (I2C)
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| Wire.begin() - I2C Master | YES |
| (EXTRA) Wire.begin(driverName) - I2C Master | YES |
| Wire.begin(address) - I2C Slave | NO/In Progress - Linux I2C Slave driver was added recently, still verifying |
| Wire.requestFrom(address, quantity) | YES |
| Wire.requestFrom(address, quantity, stop) | NO - There is no way to send an I2C stop msg to the driver |
| Wire.beginTransmission(address) | YES |
| Wire.endTransmission() | YES |
| Wire.endTransmission(stop) | NO - There is no way to send an I2C stop msg to the driver |
| Wire.write(value) | YES |
| Wire.write(string) | YES |
| Wire.write(data, length) | YES |
| Wire.available() | YES |
| Wire.read() | YES |
| Wire.onReceive(handler) | NO/In Progress - Linux I2C Slave driver was added recently, still verifying |
| Wire.onRequest(handler) | NO/In Progress - Linux I2C Slave driver was added recently, still verifying |
- SPI
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| SPISettings | YES |
| SPI.begin() - SPI Master | YES |
| (EXTRA) SPI.begin(driverName) - SPI Master | YES |
| SPI.end() | YES |
| SPI.beginTransaction(mySettings) | YES |
| SPI.endTransaction() | YES |
| SPI.setBitOrder(order) | YES |
| SPI.setClockDivider(divider) | YES |
| SPI.setDataMode(mode) | YES |
| receivedVal = SPI.transfer(val) | YES |
| receivedVal16 = SPI.transfer16(val16) | NO - Is almost depreciated and could be fixed better adding a bitsPerWord in settings that includes 16 bits and 32 bits |
| SPI.transfer(buffer, size) | YES |
| SPI.usingInterrupt(interruptNumber) | In Progress |
- Math
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| min(x, y) | YES |
| max(x, y) | YES |
| abs(x) | YES |
| constrain(x, a, b) | YES |
| map(value, fromLow, fromHigh, toLow, toHigh) | YES |
| pow(base, exponent) | YES |
| radians(deg) | YES |
| degrees(rad) | YES |
| sqrt(x) | YES |
| sq(x) | YES |
- Trigonometry
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| sin(rad) | YES |
| cos(rad) | YES |
| tan(rad) | YES |
- Characters
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| isAlphaNumeric(thisChar) | YES |
| isAlpha(thisChar) | YES |
| isAscii(thisChar) | YES |
| isWhitespace(thisChar) | YES |
| isControl(thisChar) | YES |
| isDigit(thisChar) | YES |
| isGraph(thisChar) | YES |
| isLowerCase(thisChar) | YES |
| isPrintable(thisChar) | YES |
| isPunct(thisChar) | YES |
| isSpace(thisChar) | YES |
| isUpperCase(thisChar) | YES |
| isHexadecimalDigit(thisChar) | YES |
- Random Numbers
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| randomSeed(seed) | YES |
| random(max) | YES |
| random(min, max) | YES |
- Bits and Bytes
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| lowByte(x) | YES |
| highByte(x) | YES |
| bitRead(x, n) | YES |
| bitWrite(x, n, b) | YES |
| bitSet(x, n) | YES |
| bitClear(x, n) | YES |
| bit(n) | YES |
- Interrupts
| Function | Implemented (YES/NO-Comment/In Progress) |
|---|---|
| interrupts() | NO |
| noInterrupts() | NO |
Notes:
B binary representation (e.g B1000000[7 bits] and B110[3 bits]) conflicts with some termios.h definitions so only 8 bit binary representations are supported (e.g B01000000[8 bits], B00010001[8 bits], etc). To represent a binary with less or more than 8 bits please use 0b instead.
By Jorge Garza , Updated on: Aug 5, 2016