https://github.com/blockfrost/blockfrost-arduino

Arduino SDK for the Blockfrost.io API
https://github.com/blockfrost/blockfrost-arduino

api arduino blockfrost cardano ipfs rest sdk

Last synced: 26 days ago
JSON representation

Arduino SDK for the Blockfrost.io API

• Host: GitHub
• URL: https://github.com/blockfrost/blockfrost-arduino
• Owner: blockfrost
• License: apache-2.0
• Created: 2021-11-22T16:10:18.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-24T10:27:43.000Z (about 2 years ago)
• Last Synced: 2024-11-30T20:51:34.228Z (about 1 month ago)
• Topics: api, arduino, blockfrost, cardano, ipfs, rest, sdk
• Language: C++
• Homepage:
• Size: 264 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GitHub Actions](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fblockfrost%2Fblockfrost-arduino%2Fbadge&style=flat-square)](https://github.com/blockfrost/blockfrost-arduino/actions/workflows/platformio-build.yml)

[![Made by Five Binaries](https://img.shields.io/badge/made%20by-Five%20Binaries-darkviolet.svg?style=flat-square)](https://fivebinaries.com/)



# blockfrost-arduino




Arduino SDK for Blockfrost.io API.



  About •

  Getting started •

  Installation •

  Usage






## About

Arduino SDK for the Blockfrost.io API targeting ESP32 development boards.

[![Block, slot within an epoch, wen, transaction volume](./img/proj_thumb.jpg)](./img/proj.jpg)

## Getting started

To use this SDK, you first need to log in to [blockfrost.io](https://blockfrost.io), create your project and retrieve the API token.






## Installation

The SDK uses [platformio](https://platformio.org/).

You can either work directly with this repository or add this package as a dependency of your project using

```

lib_deps =

  https://github.com/blockfrost/blockfrost-arduino

```

To enter a development shell, use `nix-shell`.

## Usage

To build the [example](./example), copy `example/creds.h.sample`

to `example/creds.h` and fill in your credentials.

```sh

git clone https://github.com/blockfrost/blockfrost-arduino

cd blockfrost-arduino

cp example/creds.h.sample example/creds.h

```

Plug in your ESP32 development board, build and upload

using:

```sh

pio run --target upload

```

### Testing

It is possible to test correct JSON (de)serialisation natively using:

```

pio test -c platformio-test.ini -e native

```