Skip to content

Commit 490b597

Browse files
authored
Example readme added
0 parents  commit 490b597

File tree

4 files changed

+105
-0
lines changed

4 files changed

+105
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#include <pitcher.h>
2+
3+
int sensorPin = 32;
4+
5+
void setup() {
6+
/*
7+
Pitcher needs to initialize its environment before everything, so this must be called before the program
8+
*/
9+
pitcher_start();
10+
}
11+
12+
char valueString[10];
13+
14+
void loop() {
15+
float distance= (analogRead(sensorPin)/4096.0)*25.0;
16+
sprintf(valueString,"%f mm",distance);
17+
pitcher_set_sensor_value_distance(valueString);
18+
delay(1000);
19+
}

README.md

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
## [IotPitcher](https:www.iotpitcher.com) Example
2+
3+
Are you developing an IoT device with ESP32?
4+
5+
You will save atleast a month of development.
6+
7+
We don’t care about your cloud platform, IotPitcher is a sidekick for your application.
8+
9+
## [IotPitcher](https:www.iotpitcher.com) in a Nutshell
10+
11+
IotPitcher is an IoT development framework to build and configure easily with the following features :
12+
13+
- User friendly AP(Access Point) screen, so no need to know HTML, JavaScript or CSS!
14+
- Easy setter and getter API for multiple overloaded functions to change and read any data easily
15+
- Real time data output terminal, you can see your printed outputs without any extra work. You don't need to debug your devices with cable all the time!
16+
- OTA (Over The Air) updates from your web browser (computer or mobile phone, any device with a web browser), just upload your application binary file!
17+
- Info screen shows device MAC address, IP address in the network, connection status and RSSI value of the connected WiFi station.
18+
- Simple SSID and Password connection and change them any time with no code!
19+
- If your project is C or C++ or you develop in Arduino IDE environment, it doesn't matter we provide optimized library for all!
20+
21+
22+
23+
## How to use
24+
25+
IotPitcher provides you prebuilded archive file as a library and one header file (`pitcher.h`), when you have the library
26+
27+
28+
29+
To start easily, just include provided header file. It has everything what you need to talk with IotPitcher
30+
31+
```c++
32+
#include "pitcher.h"
33+
```
34+
35+
And start pitcher, its done!
36+
37+
```c++
38+
pitcher_start();
39+
```
40+
41+
42+
43+
44+
45+
## Linear Potentiometer Example developed in Arduino IDE
46+
47+
This project is provided as an example to show capabilites of IotPitcher. Configuration page contains only one data which is distance in this case. Inside the loop data is set each second, and IotPitcher AP page shows its value real time!
48+
49+
```c++
50+
#include <pitcher.h>
51+
52+
int sensorPin = 32;
53+
54+
void setup() {
55+
/*
56+
Pitcher needs to initialize its environment before everything, so this must be called before the program
57+
*/
58+
pitcher_start();
59+
}
60+
61+
char valueString[10];
62+
63+
void loop() {
64+
float distance= (analogRead(sensorPin)/4096.0)*25.0;
65+
sprintf(valueString,"%f mm",distance);
66+
pitcher_set_sensor_value_distance(valueString);
67+
delay(1000);
68+
}
69+
```
70+
71+
72+
73+
This is the main page of `IotPitcher`, it provides
74+
75+
![](docs/main_page.jpeg)
76+
77+
78+
79+
Configurations are created just for your project! With its simple API, you can read and write values directly from your code. If you want values can be changed from its AP page.
80+
81+
![](docs/config_page.jpeg)
82+
83+
84+
85+
For more info please visit [IotPitcher](https://iotpitcher.com/)
86+

docs/config_page.jpeg

38.2 KB
Loading

docs/main_page.jpeg

31.7 KB
Loading

0 commit comments

Comments
 (0)