Skip to content

Commit

Permalink
manually fix merge conflict
Browse files Browse the repository at this point in the history
  • Loading branch information
andrea-83 committed Aug 1, 2022
2 parents 1a03b7f + 493c026 commit 90aef7a
Show file tree
Hide file tree
Showing 11 changed files with 1,101 additions and 569 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# Changelog

#### v 2.1.0 - 2022.07.29
* Upd: ERR_GENERIC was redefined as ERR [#1jz91mu] (https://app.clickup.com/t/1jz91mu)
* Upd: ID_PREFIX removed from `store`, `mstore` and `storeTags` commands [#23v2xn3] (https://app.clickup.com/t/23v2xn3)
* Add: added executeCommandFast command [#394mek4] (https://app.clickup.com/t/394mek4)
* Add: added `mstore` with timestamp argument [#394memb] (https://app.clickup.com/t/394memb)


#### v 2.0.1 - 2022.05.27
* Fix: bug debug for arancino mignon board. [#2g4fxvx] (https://app.clickup.com/t/2g4fxvx)

#### v 2.0.0 - 2022.01.20
#### v 2.0.0 - 2022.01.17
* Upd: updated unit test examples. [#1uqbjbp] (https://app.clickup.com/t/1uqbjbp)
* Add: added useFreeRtos parameter in `start` command. [#1vht0nc] (https://app.clickup.com/t/1vht0nc)
* Fix: bug into `deviceIdentification` task. [#1w8qx9m] (https://app.clickup.com/t/1w8qx9m)
Expand Down
45 changes: 35 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,43 @@
# Arancino Library
# Arancino Library

The following Library works on Arancino.cc boards, it is written in Arduino lang and can be imported into the Arduino IDE and Platformio.IO. Arancino Library was written originally to run on [SAMD21](https://github.com/smartmeio/arancino-core-samd21) Microcontroller, now it can runs also on [NRF52](https://github.com/smartmeio/arancino-core-nrf52), [STM32](https://github.com/smartmeio/arancino-core-stm32) and [RP2040](https://github.com/smartmeio/arancino-core-rp2040) Microcontrollers. It uses the serial connection to communicate with the [Arancino Daemon](https://github.com/smartmeio/arancino-daemon) which runs on the linux side of the Arancino.cc board. It uses a serial interface to communicate with Arancino Daemon and another Serial for Debug (see more on [Debug](docs/DEBUG.md) chapter)



Arancino Library allows to export/import data to/from the Linux environment using Redis as database cache. Most of the API are modelled on Redis standard Commands.

- [Getting Started](docs/GETTING_STARTED.md)
- [Variables and Data Structures](docs/VARS_DATA_STRUCT.md)
- [API](docs/API.md)
- [FreeRTOS](docs/FREETOS.md)


- [Getting Started](docs/GETTING_STARTED.md)

- [Variables and Data Structures](docs/VARS_DATA_STRUCT.md)

- [API](docs/API.md)

- [FreeRTOS](docs/FREERTOS.md)

- Insights
- [Cortex Protocol](CORTEX_PROTOCOL.md)
- [Debug](docs/DEBUG.md)
- [Reserved Keys](docs/RESERVED_KEYS.md)

## Credits
- [Cortex Protocol](CORTEX_PROTOCOL.md)

- [Debug](docs/DEBUG.md)

- [Reserved Keys](docs/RESERVED_KEYS.md)

## Compatibility list
The Arancino Library `2.1.0` officially supports the following Arancino Core versions:
|Board| Core Version |
|--|--|
| SAMD21 | 1.3.0 |
| nRF52 | 1.1.0 |
| RP2040 | 1.1.0 |
| STM32 | 1.0.0 |


## Credits

Most of this documentation has been extrapolated from [Redis Command](https://redis.io/commands/), and [FreeRTOS quick start guide](https://www.freertos.org/FreeRTOS-quick-start-guide.html).

Redis, Arduino, Atmel, Nordic, STMicroelectronics, RaspberryPi and FreeRTOS are trademarks of their respective owners.


Redis, Arduino, Atmel, Nordic, STMicroelectronics, RaspberryPi and FreeRTOS are trademarks of their respective owners.
12 changes: 10 additions & 2 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -412,11 +412,17 @@ ___
##### *ArancinoPacket store(char* key, long value)*
##### *ArancinoPacket store(char* key, uint32_t value)*
##### *ArancinoPacket store(char* key, int value, char* timestamp)*
##### *ArancinoPacket store(char* key, float value, char* timestamp)*
##### *ArancinoPacket store(char* key, long value, char* timestamp)*
##### *ArancinoPacket store(char* key, uint32_t value, char* timestamp)*
Append (or create and append) a new sample to the series specified by key.
##### Parameters
* **`key`**: *key* to store.
* **`value`**: the *value* for the specified key.
* **`timestamp`**: the expicit *timestamp* for the specified key.
##### Return value
char* reply: the insertion timestamp.
Expand All @@ -431,16 +437,18 @@ ArancinoPacket reply: [ArancinoPacket](#arancinopacket) containing:
___
### mstore
##### *ArancinoPacket mstore(char** key, char** value, int len)*
##### *Void mstore(char** key, char** value, int len,char* timestamp)*
Append new samples to a list of series.
##### Parameters
* **`keys`**: the list of *keys* to store.
* **`values`**: corresponding values of the keys;
* **`len`**: number of keys to set, namely the length of keys array.
* **`timestamp`**: the expicit *timestamp* for the specified set of keys.
##### Return value
char** reply: list of insertion timestamps.
* char** reply: list of insertion timestamps.
* Returns nothing (`Void`) if timestamp prototype is used. (it uses ExecuteCommandFast so it don't require a response from Arancino Daemon).
or
Expand Down
2 changes: 1 addition & 1 deletion docs/FREERTOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Arancino library currently supports 4 architectures.
|--------------|-----------|------------|
| Arancino Mignon | SAMD21 | yes |
| Arancino Volante | NRF52 | yes |
| Arancino Pico | RP2040| no |
| Arancino Pico | RP2040| yes |
| Arancino V | STM32| yes |


Expand Down
2 changes: 1 addition & 1 deletion keywords.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ mstore KEYWORD2
storetags KEYWORD2
setReservedCommunicationMode KEYWORD2
isValidUTF8 KEYWORD2

getTimestamp KEYWORD2
2 changes: 1 addition & 1 deletion library.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"type": "git",
"url": "https://github.com/smartmeio/arancino-library.git"
},
"version": "1.4.1",
"version": "2.1.0",
"authors": {
"name": "smartme.IO",
"url": "https://www.arancino.cc"
Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=Arancino
version=2.0.1
version=2.1.0
author=smartme.IO
maintainer=smartme.IO <[email protected]>
sentence=Enables communication between microcontroller and Arancino Module running mainly in Arancino boards.
Expand Down
Loading

0 comments on commit 90aef7a

Please sign in to comment.