Skip to content

Commit

Permalink
Readme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
renat2985 committed Sep 14, 2024
1 parent aabc51a commit a04ca65
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
A convenient and fast way to implement paid services using the TonCoin cryptocurrency. The process is simple: You open any crypto wallet, scan the QR code (for example, it can be printed on a sheet with the required amount), transfer the specified amount, and as soon as the payment is received, the relay will activate and turn on your device for the time you set. This could be any device, from a kettle, coffee machine, or light bulb to powering electricity in a room or another location.

You can assemble the device yourself or ask to build it for you. To order a ready-made device, contact me via [Telegram](https://t.me/ESPiotDevice), [Skype](https://skype:renat2985?chat), [Discord](https://discord.com/invite/zaGaDuGe).
We have a similar project with a screen, [check it out](https://github.com/renat2985/toncoin_payment).


<img src="https://github.com/renat2985/toncoin_payment_sonoff/blob/main/doc/intro2.png">
Expand All @@ -24,6 +25,7 @@ You can assemble the device yourself or ask to build it for you. To order a read
- **Router and Password:** Enter your Wi-Fi connection details.
- **Device Name:** Specify a device name, e.g., "Buy coffee."
- **Your Toncoin Wallet:** Enter your wallet address to receive payments.
- **CoinMarketCap API:** Is a service that allows you to get the current TonCoin price in fiat currency. For testing, you can use the default API, but if you plan to use the device on a regular basis, it is highly recommended to register on the [CoinMarketCap](https://coinmarketcap.com/api/) website and get your own API. The free version allows up to 10,000 requests per month for price data. This is more than enough for 10 devices, but if our API is used by more devices, not everyone will be able to receive the actual price, and as a result, payments may fail.
- **Currency:** Select the currency in which you want to receive payments (EUR, USD, RUB, BYN, BGN, GBP, etc.). This is necessary for automatic conversion to TonCoin based on the current exchange rate, updated hourly through coinmarketcap.com.
- **Service Currency Price:** Specify the price in your selected currency that the customer should pay.
- **Payment Tolerance:** In this field, specify the acceptable price deviation. Since the Ton price constantly fluctuates, you need to indicate a deviation range (as a single number) that you are willing to accept for payment.
Expand Down Expand Up @@ -51,7 +53,7 @@ Good luck! If you have any questions, don't hesitate to reach out.


### For Advanced Users: Firmware Instructions via Programmer
### Specification [ESP8266.bin](https://github.com/renat2985/toncoin_payment_sonoff/raw/main/build/esp8266.esp8266.generic/toncoin_payment_sonoff.ino.bin) / [ESP8285.bin](https://github.com/renat2985/toncoin_payment_sonoff/raw/main/build/esp8266.esp8266.esp8285/toncoin_payment_sonoff.ino.bin) files
### Specification [toncoin_payment_sonoff.ino.bin](https://github.com/renat2985/toncoin_payment_sonoff/raw/main/build/esp8266.esp8266.generic/toncoin_payment_sonoff.ino.bin) file
```
- Module: Generic ESP8266 Module
- Flash Size: 1M
Expand Down
4 changes: 3 additions & 1 deletion README_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Удобный и быстрый способ внедрения платных услуг с использованием криптовалюты TonCoin. Процесс простой: Вы открываете любой крипто кошелек, сканируете QR-код (Его можно например распечатать на листике с необходимой суммой), переводите эту указанную сумму, и как только платеж будет получен, реле активируется и включит ваш прибор на заданное вами время. Это может быть любой прибор, от чайника, кофемашины и лампочки до включения электричества в помещение или любом другом месте.

Вы можете собрать устройство самостоятельно или попросить это сделать для вас. Для заказа готового устройства свяжитесь через [Telegram](https://t.me/ESPiotDevice), [Skype](https://skype:renat2985?chat), [Discord](https://discord.com/invite/zaGaDuGe).
У нас есть похожий проект с экраном, [посмотри](https://github.com/renat2985/toncoin_payment).


<img src="https://github.com/renat2985/toncoin_payment_sonoff/blob/main/doc/intro2.png">
Expand All @@ -23,6 +24,7 @@
- **Роутер и пароль:** Введите данные для подключения к вашему Wi-Fi.
- **Device Name:** Укажите имя устройства, например, "Buy coffee".
- **Your Toncoin Wallet:** Введите адрес вашего кошелька для приема платежей.
- **CoinMarketCap API:** Это сервис, который позволяет получать текущую цену TonCoin в фиатной валюте. Для тестирования можно не менять API, но если вы планируете использовать устройство на постоянной основе, настоятельно рекомендуется зарегистрироваться на сайте [CoinMarketCap](https://coinmarketcap.com/api/) и получить свой собственный API. Т.к. бесплатная версия позволяет делать до 10 000 запросов в месяц на получение цены. Для 10 устройств этого вполне достаточно, но если наше API будет использоваться большим количеством устройств, не все смогут получать актуальную цену, и в результате оплата может не пройти.
- **Сurrency:** Выберите валюту, в которой хотите получать оплату (EUR, USD, RUB, BYN, BGN, GBP и др.). Это необходимо для автоматической конвертации суммы в TonCoin на основе текущего курса, который обновляется каждый час через coinmarketcap.com.
- **Service Currency Price:** Укажите цену в выбранной валюте, которую клиент должен оплатить.
- **Payment Tolerance:** В этой ячейке указывается допустимая погрешность в цене. Поскольку стоимость Ton постоянно колеблется, здесь нужно указать диапазон отклонений (одной цифрой), который вы готовы принять при оплате.
Expand Down Expand Up @@ -53,7 +55,7 @@


### Для совсем профи инструкция для прошивки через программатор
### Specification [ESP8266.bin](https://github.com/renat2985/toncoin_payment_sonoff/raw/main/build/esp8266.esp8266.generic/toncoin_payment_sonoff.ino.bin) / [ESP8285.bin](https://github.com/renat2985/toncoin_payment_sonoff/raw/main/build/esp8266.esp8266.esp8285/toncoin_payment_sonoff.ino.bin) files
### Specification [toncoin_payment_sonoff.ino.bin](https://github.com/renat2985/toncoin_payment_sonoff/raw/main/build/esp8266.esp8266.generic/toncoin_payment_sonoff.ino.bin) file
```
- Module: Generic ESP8266 Module
- Flash Size: 1M
Expand Down
Binary file modified doc/APFull.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/connect relay.fzz
Binary file not shown.

0 comments on commit a04ca65

Please sign in to comment.