Skip to content

Commit

Permalink
Merge pull request #2 from ebelinski/patch-1
Browse files Browse the repository at this point in the history
Grammar
  • Loading branch information
tectrolabs authored Apr 24, 2020
2 parents ed48d6a + 4a331ae commit ac0b78b
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# MicroRNG Software Kit

[MicroRNG](https://tectrolabs.com/microrng/) is a hardware (true) random number generator device that can be used in embedded systems as a reliable entropy source. It can interface with microcontrollers or microprocessors (mainboards) with integrated circuits and modules through a mikroBUS™ socket using SPI or 2-wire UART interface and can generate random numbers at a rate up to 1 Mbps in SPI mode and up to 1.5 Mbps in UART mode.
[MicroRNG](https://tectrolabs.com/microrng/) is a hardware (true) random number generator device that can be used in embedded systems as a reliable entropy source. It can interface with microcontrollers or microprocessors (mainboards) with integrated circuits and modules through a mikroBUS™ socket using SPI or 2-wire UART interfaces. It can generate random numbers at a rate up to 1 Mbps in SPI mode and up to 1.5 Mbps in UART mode.

This repository contains the MicroRNG Software Kit and utilities for using the MicroRNG device with Raspberry PI 3+ or other Linux-based single-board computers via the SPI interface.
This repository contains the MicroRNG Software Kit and utilities for using the MicroRNG device with Raspberry Pi 3+ or other Linux-based single-board computers via an SPI interface.

* [More about MicroRNG](https://tectrolabs.com/microrng/)

## Contents

* `MicroRngSPI.cpp` - API source code in C++ for communicating with the MicroRNG device over SPI interface.
* `mcdiag.cpp` - general purpose diagnostics utility that interacts with the MicroRNG device for determining the maximum clock speed and for validating the communication over SPI interface.
* `mcrng.cpp` - utility for downloading random bytes generated by MicroRNG device over SPI interface.
* `sample.cpp` - sample C++ program that demonstrates how to use the API for communicating with the MicroRNG device over SPI interface.
* `MicroRngSPI.cpp` - API source code in C++ for communicating with a MicroRNG device over an SPI interface.
* `mcdiag.cpp` - general purpose diagnostics utility that interacts with the MicroRNG device for determining the maximum clock speed and for validating the communication over an SPI interface.
* `mcrng.cpp` - utility for downloading random bytes generated by MicroRNG device over an SPI interface.
* `sample.cpp` - sample C++ program that demonstrates how to use the API for communicating with the MicroRNG device over an SPI interface.

## Getting Started

To build and run MicroRNG utilities you will need a sudo access permissions to your Linux instance and an Internet connection.
To build and run the MicroRNG utilities you will need sudo access permissions on your Linux instance.

### Dependencies

Expand All @@ -25,17 +25,17 @@ The following dependencies are required to successfully build utilities:
* git
* make

C++ compiler can be installed on Ubuntu with the following command:
The C++ compiler can be installed on Ubuntu with the following command:
```
sudo apt-get install g++
```

Git development dependency can be installed on Ubuntu with the following command:
The git development dependency can be installed on Ubuntu with the following command:
```
sudo apt-get install git
```

Make development dependency can be installed on Ubuntu with the following command:
The make development dependency can be installed on Ubuntu with the following command:
```
sudo apt-get install make
```
Expand All @@ -47,7 +47,7 @@ sudo apt-get install make
git clone https://github.com/tectrolabs/microrng.git
```

* Building utilities:
* Build the utilities:
```
cd microrng/mcrng
make
Expand All @@ -56,9 +56,9 @@ make
```
sudo make install
```
### Verify MicroRNG is working
### Verify the MicroRNG is working

* Connect MicroRNG device to the target board through provided SPI interface.
* Connect MicroRNG device to the target board through the provided SPI interface.
* Verify device connectivity with the following command (you may need to use a target board sepecific device path):
```
sudo mcdiag /dev/spidev0.0
Expand Down

0 comments on commit ac0b78b

Please sign in to comment.