Skip to content

Commit 01c4fef

Browse files
committed
Update README.md
1 parent 305f9c5 commit 01c4fef

File tree

1 file changed

+62
-2
lines changed

1 file changed

+62
-2
lines changed

README.md

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,62 @@
1-
# mcserver-status-arduino
2-
🔌📶 ESP32 script to check the online status of a Minecraft server via JSON API over Wi-Fi. Uses ArduinoJson and HTTPClient to fetch and parse data from mcsrvstat.us.
1+
# \# 🌐 ESP32 JSON Status Checker
2+
3+
#
4+
5+
# This project allows an \*\*ESP32\*\* to connect to a Wi-Fi network, send an \*\*HTTP GET request\*\* to a specified URL, and parse the JSON response using the powerful \*\*ArduinoJson\*\* library. It’s ideal for checking online services like a \*\*Minecraft server\*\*, a REST API status, or any endpoint that returns JSON data.
6+
7+
#
8+
9+
# ---
10+
11+
#
12+
13+
# \## 🚀 Features
14+
15+
#
16+
17+
# \- 📡 Connects to any Wi-Fi network
18+
19+
# \- 🌍 Makes HTTP requests to any given API or server URL
20+
21+
# \- 📦 Parses and processes JSON data
22+
23+
# \- ✅ Reads the `online` key from the response and displays it via the Serial Monitor
24+
25+
#
26+
27+
# ---
28+
29+
#
30+
31+
# \## 🧰 Requirements
32+
33+
#
34+
35+
# \- ESP32 development board
36+
37+
# \- Arduino IDE or PlatformIO
38+
39+
# \- Active Wi-Fi connection
40+
41+
# \- A valid URL that returns JSON data (e.g., a Minecraft server status API)
42+
43+
#
44+
45+
# ---
46+
47+
#
48+
49+
# \## 📜 Example Use Case
50+
51+
#
52+
53+
# Using the API from \[mcsrvstat.us](https://api.mcsrvstat.us), you can check the online status of a Minecraft server:
54+
55+
#
56+
57+
# ```cpp
58+
59+
# String url = "https://api.mcsrvstat.us/3/mc.example.com";
60+
61+
62+

0 commit comments

Comments
 (0)