Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some spelling errors in the documentation. #10

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ This section is a lie because as of the time of writing, nobody has asked any qu
- [What pins are available to use for sensors etc](/FAQ.md#what-pins-are-available-to-use-for-sensors-etc)
- [Can I connect a SPI sensor/device to the Trinity](/FAQ.md#device-to-the-trinity)
- My colours are mixed up/not right
- Does it work with the Pixel Purse?
- Why is it called the "Trinity"?
- Does it work with the Pixel Purse ?
- Why is it called the "Trinity" ?

---

### Does this work with PxMatrix?

No it does not, it is designed to work with the I2S-DMA matrix library
No, it does not, it is designed to work with the I2S-DMA matrix library

**Advantages of the i2s version:**

Expand Down Expand Up @@ -118,7 +118,7 @@ For more details check out the [SDCardTest Example](/examples/TrinityFeatures/SD

### My colours are mixed up/not right

Well thats not technically a question, but I get you!
Well, that's not technically a question, but I get you!

Some matrix panels have some of the colour channels swapped around for some reason. The most common one I've seen is Blue and Green mixed, which seems to lead to a lot of purple images.

Expand All @@ -142,7 +142,7 @@ I have not tried, but the I2S Matrix library doesn't seem to support it by defau

The Trinity Knots symbol is something from Irish/Celtic history and is instantly recognizable as a symbol of Ireland. There are examples of artifacts dating back to the 8th century with Trinity Knots on them.

The Ireland national symbol is the shamrock, one of the main significances of the shamrock is a way to represent the Christian Holy Trinity. It's said that St Patrick used a shamrock to represent the Holy Trinity when he came to bring Christianity to Ireland.
The Ireland national symbol is the shamrock, one of the main significance of the shamrock is a way to represent the Christian Holy Trinity. It's said that St Patrick used a shamrock to represent the Holy Trinity when he came to bring Christianity to Ireland.

The most prestigious college in Ireland is Trinity college.

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Info, examples, instructions and hardware files for the ESP32 Trinity, an open s

## Help Support what I do!

My main contribution to the open source community to date has been my Arduino libraries for the ESP32 and ESP8266, but I recently been trying to contribute more certified open source hardware projects, and they are a lot of work!
My main contribution to the open source community to date has been my Arduino libraries for the ESP32 and ESP8266, but I have recently been trying to contribute more certified open source hardware projects, and they are a lot of work!

[If you enjoy my work, please consider becoming a Github sponsor!](https://github.com/sponsors/witnessmenow/)

Expand All @@ -17,9 +17,9 @@ My main contribution to the open source community to date has been my Arduino li
- [Unexpected Maker](https://unexpectedmaker.com/shop/esp32-trinity) (Ships from Australia)
- [Colin Hickey](https://store.eplop.co.uk/product/esp32_trinity/) (Ships from UK)

All Trinity's arrive assembled and have been fully tested.
All Trinity's arrives assembled and have been fully tested.

If you are interested in the Trinity and one of the reseller options suits better please do purchase from there, it being successful for resellers works out well for me too!
If you are interested in the Trinity and one of the resellers options suits better please do purchase from there, it being successful for resellers works out well for me too!

## Additional Hardware Required

Expand Down
4 changes: 2 additions & 2 deletions documentation/tindieListing.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Note: These displays are difficult to video correctly, they look much better in

Each ESP32 Trinity comes assembled with the following additional components:

- An LDR - The reason its not assembled is you may want to place it on the top of your panel
- An LDR - The reason it's not assembled is you may want to place it on the top of your panel
- 8p Female header for the Breakout area
- 16p (2x8) Stacking header (to be used if the Trinity does not fit with your matrix panel)

Expand Down Expand Up @@ -72,7 +72,7 @@ Please checkout [the ESP32 Trinity Github page](https://github.com/witnessmenow/

### Coding Support

Please note that I can not provide coding support for this item. I can offer some troubleshooting advice on getting them working (but please also read the section labeled "will this work with my display") and I can point you to some examples I have created using these board, but I will not be able to give support on building something specific.
Please note that I can not provide coding support for this item. I can offer some troubleshooting advice on getting them working (but please also read the section labeled "will this work with my display") and I can point you to some examples I have created using this board, but I will not be able to give support on building something specific.

### Change-log of versions

Expand Down
16 changes: 8 additions & 8 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You should also check out the [examples that come with the I2S Matrix library](h

### Basics

In this section you will find some simple sketches to get you up and running on your Trinity. These are a great place to get started, as I alway would recomend getting something simple running on any hardware to make sure your setup works!
In this section you will find some simple sketches to get you up and running on your Trinity. These are a great place to get started, as I would always recommend getting something simple running on any hardware to make sure your setup works!

- [Hello World](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/Basics/HelloWorld) - A simple example showing different size fonts in different colours
- [ColourTest](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/Basics/ColourTest) - A simple sketch that just cycles through colours (WARNING - can use a lot of power!)
Expand All @@ -23,27 +23,27 @@ This section shows examples on how to do some things that could be useful to use
- [ScrollingText](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/BuildingBlocks/Text/ScrollingText) - An example to show you how to scroll text.
- Images
- [DisplayImageFromWeb](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/BuildingBlocks/Images/DisplayImageFromWeb) - Downloads a JPG from a URL (imgur in this case), save it to SPIFFS and displays it to the Matrix
- [DisplayGIF](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/BuildingBlocks/Images/DisplayGIF) - Displays severtal GIFs on the matrix. Check the top of the file for more info.
- [DisplayGIF](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/BuildingBlocks/Images/DisplayGIF) - Displays several GIFs on the matrix. Check the top of the file for more info.

### Trinity Features

This section is show how to use some of the additional features of the Trinity
This section shows how to use some of the additional features of the Trinity

- [LDRAutoBrightness](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/TrinityFeatures/LDRAutoBrightness) - An example of using the LDR to automatically adjust the brightness of the display **Additional Requirements:** Included LDR needs to be soldered
- [SDCardTest](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/TrinityFeatures/SDCardTest) - An example of using an SD Card with your Trinity. Could be adapted to work with any SPI device. The matrix uses some of the deafult SPI pins so we had to get creative. **Additional Requirements:** An SD/Micro SD module
- [SDCardTest](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/TrinityFeatures/SDCardTest) - An example of using an SD Card with your Trinity. Could be adapted to work with any SPI device. The matrix uses some of the default SPI pins so we had to get creative. **Additional Requirements:** An SD/Micro SD module
- [TouchPointTest](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/TrinityFeatures/TouchPointTest) - A basic example of using the built-in Touch pads of the Trinity.

### Projects

This is a collection of some of the projects I've written for the Trinity that you should be able to just use to get a full working project going on your Trinity in just a few minutes! Also feel free to build on top of these or change them for you needs.
This is a collection of some of the projects I've written for the Trinity that you should be able to just use to get a full working project going on your Trinity in just a few minutes! Also feel free to build on top of these or change them for your needs.

_Note:_ This is not a full list of projects I've made as some will have their own repos. Please check the Project Section for a full list of my projects and user contributed ones.
_Note:_ This is not a full list of projects I've made as some will have their own repos. Please check the Project Section for a full list of my projects and user-contributed ones.

- [FallingSand](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/Projects/FallingSand):
A fun project that emulates sand falling on the Matrix using an accelerometer module. This was originally created by [Tetra3DPrint](https://twitter.com/tetra3dprint) and ported to the I2S matrix library by me.
**Additional Requirements:** GY521 Accelermoter Module
- [SnakeWithNunchuck](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/Projects/SnakeWithNunchuck)
I'm tired of these monkey fighting snakes on this Monday to Friday Matrix! A simple version of the clasic game controlled by a Nintendo Wii Nunchuck. **Additional Requirements:** Wii Nunchuck and an adaptor
I'm tired of these monkey fighting snakes on this Monday to Friday Matrix! A simple version of the classic game controlled by a Nintendo Wii Nunchuck. **Additional Requirements:** Wii Nunchuck and an adaptor
- [TetrisWithNunchuck](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/Projects/TetrisWithNunchuck)
Please don't sue me EA. Tetris on your matrix controlled by a Wii Nunchuck. **Additional Requirements:** Wii Nunchuck and an adaptor
- [WifiTetrisClock](https://github.com/witnessmenow/ESP32-Trinity/tree/master/examples/Projects/WifiTetrisClock)
Expand All @@ -57,7 +57,7 @@ _Note:_ This is not a full list of projects I've made as some will have their ow

### But I still haven't found what I'm looking for

If you feel like there is something missing please or you just need some addtional help, feel free to:
If you feel like there is something missing please or you just need some additional help, feel free to:

- [Ask on my Discord](https://discord.gg/2enC6GW) - This will be the fastest as other helpful makers can jump in too!
- Raise a Github Issue here
Expand Down
2 changes: 1 addition & 1 deletion setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ You will need to have the ESP32 setup for your Arduino IDE, [instructions can be

You can then select basically any ESP32 board in the boards menu. (I usually use "Wemos D1 Mini ESP32", but it doesn't really matter)

### Library despondencies
### Library dependencies

The following libraries will need to be installed for the Trinity to work.

Expand Down