![\"Suli\"](\"\/wp-content\/uploads\/2014\/03\/Suli.jpg\")
<\/p>\nHere we are happy to announce Suli,\u00a0our plan of open hardware module libraries for Arduino, Raspberry Pi, mbed and etc.<\/p>\n
Sounds like a girl\u2019s name? Actually it means Seeed Unified Library Interface. It\u2019s a big thing on our to-do list in the near future.<\/p>\n
We have hundreds of sensors, actuators, displays and other useful modules. In the past, we mainly focused on Arduino applications, and supplied Arduino Library only. This means if you used another platform such as Raspberry, LauchPad, or MCS51, you needed to port our Library, and sometimes it’s not easy.<\/p>\n
Sometimes when some customers asked us to provide some libraries for a non-Arduino platform, what we could do was telling them \u201chey man, we only have Arduino library.” Replying the customers in this way made us feel bad.<\/p>\n
And we have been thinking what if there’s a way to make our libraries fit all platforms. It\u2019s really a hard task, but not impossible. And we are lucky to figure it out finally: it’s Suli – Seeed Unified Library Interface, which can make almost all of(at least 90%) our libraries fit many common platforms, or at least make it easy to port.<\/p>\n
Let\u2019s have a look at the following image<\/p>\n
<\/p>\n
We can find that there are four circles and the innermost is HW(hardware). Suli will call resources from HW, such as GPIO, I2C, Timer and UART; then Suli-compatible Library, and then User Application. All of our Libraries will call Suli function only. Thus, for different platforms, we can just port Suli, then the Library can be used. That means different platforms have their Suli, Suli for Arudino, Suli for Mbed, Suli for….<\/p>\n
There are several points about Suli:<\/p>\n
l\u00a0 Different platform has its equivalent Suli.<\/p>\n
l\u00a0 Suli-compatible Library is platform independent.<\/p>\n
l\u00a0 Suli-compatible Library will call the function in Suli.<\/p>\n
Suli has two files, Suli.h and Suli.cpp(.c). And Suli should implement the following function, which will be called by<\/p>\n
[php]<\/p>\n
GPIO type:<\/p>\n
typedef\u00a0\u00a0\u00a0\u00a0 int\u00a0\u00a0\u00a0\u00a0 IO_T;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ IO type<\/p>\n
typedef\u00a0\u00a0\u00a0\u00a0 int\u00a0\u00a0\u00a0\u00a0 PIN_T;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ pin name<\/p>\n
typedef\u00a0\u00a0\u00a0\u00a0 int\u00a0\u00a0\u00a0\u00a0 DIR_T;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ pin direction<\/p>\n
typedef int ANALOG_T;\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ pin analog<\/p>\n
GPIO state:<\/p>\n
#define HAL_PIN_INPUT\u00a0\u00a0 INPUT\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ INPUT and OUTPUT was declared in Arduino IDE<\/p>\n
#define HAL_PIN_OUTPUT\u00a0 OUTPUT<\/p>\n
#define HAL_PIN_HIGH\u00a0\u00a0\u00a0 HIGH\u00a0 \u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ HIGH and LOW was declered in Arduino IDE<\/p>\n
#define HAL_PIN_LOW\u00a0\u00a0\u00a0\u00a0 LOW<\/p>\n
Data type:<\/p>\n
typedef signed char\u00a0\u00a0\u00a0\u00a0 int8;<\/p>\n
typedef unsigned char\u00a0\u00a0 uint8;<\/p>\n
typedef signed short\u00a0\u00a0\u00a0 int16;<\/p>\n
typedef unsigned short\u00a0 uint16;<\/p>\n
typedef signed long\u00a0\u00a0\u00a0\u00a0 int32;<\/p>\n
typedef unsigned long\u00a0\u00a0 uint32;<\/p>\n
Digital IO Operation:<\/p>\n
void seeed_hal_pin_init(IO_T *pio, PIN_T pin);\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ pin initialize<\/p>\n
void seeed_hal_pin_dir(IO_T *pio, DIR_T dir);\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ set pin direction<\/p>\n
void seeed_hal_pin_write(IO_T *pio, int16 state);\u00a0 \u00a0\/\/ write pin<\/p>\n
int16 seeed_hal_pin_read(IO_T *pio);\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ read pin<\/p>\n
uint16 seeed_hal_pulse_in(IO_T *pio, uint8 state, uint32 timeout);<\/p>\n
Analog IO Operation:<\/p>\n
void seeed_hal_analog_init(ANALOG_T * aio, PIN_T pin);<\/p>\n
int16 seeed_hal_analog_read(ANALOG_T * aio);<\/p>\n
Delay<\/p>\n
void seeed_hal_delay_us(uint32 us);\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ delay us<\/p>\n
void seeed_hal_delay_ms(uint32 ms);\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ delay ms<\/p>\n
Times<\/p>\n
uint32 seeed_hal_millis(void);<\/p>\n
uint32 seeed_hal_micros(void);<\/p>\n
I2C Interface:<\/p>\n
void seeed_hal_i2c_init(void * i2c_device);<\/p>\n
uint8 seeed_hal_i2c_write(void * i2c_device, uint8 dev_addr, uint8 *data, uint8 len);<\/p>\n
uint8 seeed_hal_i2c_read(void * i2c_device, uint8 dev_addr, uint8 *buff, uint8 *len);<\/p>\n
UART:<\/p>\n
void seeed_hal_uart_init(void * uart_device, int16 uart_num, uint32 baud);<\/p>\n
void seeed_hal_uart_send(void * uart_device, int16 uart_num, uint8 *data, uint16 len);<\/p>\n
void seeed_hal_uart_send_byte(void * uart_device, int16 uart_num, uint8 data);<\/p>\n
uint8 seeed_hal_uart_read_byte(void * uart_device, int16 uart_num);<\/p>\n
uint16 seeed_hal_uart_readable(void * uart_device, int16 uart_num);<\/p>\n
You can find that Suli includes digital IO operation, analog IO operation, I2C, and Uart function. It\u2019s not very comprehensive, but based on our experience, it\u2019s enough for many of our libraries. Of course if we find that we need more functions someday, we\u2019ll add to it.<\/p>\n
[\/php]<\/p>\n
Our plan is to make all Seeed libraries Suli compatible and porting Suli of\u00a0some common platforms. These platforms will include Arduino, Mbed, Mesh Bee, Raspberry, LaunchPad in the first stage. This work is expected be finished before June. Stay tuned \ud83d\ude00<\/p>\n