Skip to content

Commit ae8da0d

Browse files
author
AlphaNodesDev
committed
Release v2.0.0 - Improved README & examples
1 parent fadb694 commit ae8da0d

File tree

2 files changed

+118
-18
lines changed

2 files changed

+118
-18
lines changed

README.md

Lines changed: 117 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,64 @@
1+
12
# 🚀 SciFy IoT Library
23

3-
SciFy IoT is an **Arduino-compatible library** designed to easily connect your IoT devices with the **SciFy Cloud Dashboard**.
4-
It helps developers build IoT-based applications quickly by providing built-in functions for **WiFi connectivity**, **data upload**, **real-time monitoring**, and **remote control**.
4+
SciFy IoT is an **Arduino-compatible IoT library** designed to connect IoT devices with the **[SciFy Cloud Dashboard](https://connect.scify-tech.com/)**.
5+
It simplifies **WiFi connectivity**, **real-time data upload**, **remote device control**, and **sensor monitoring** for IoT developers, students, and makers.
56

67
---
78

8-
## 📌 Features
9-
- 🌐 **Easy WiFi Setup** — Connect your device to the internet in seconds.
10-
- 📡 **Real-time Data Upload** — Send sensor data directly to SciFy Cloud.
11-
- 🟢 **LED / Device Control** — Control devices from the dashboard or mobile app.
12-
- 🔔 **Live Monitoring** — Monitor sensor readings instantly.
13-
-**Lightweight & Fast** — Optimized for ESP8266 / ESP32 boards.
9+
## 🌟 Features
10+
11+
- 🌐 **Easy WiFi Setup** — Connect ESP8266 / ESP32 boards in seconds.
12+
- 📡 **Real-time Data Upload** — Send sensor readings directly to the **SciFy Cloud**.
13+
- 🟢 **Device Control** — Control LEDs, motors, and other devices remotely from the dashboard.
14+
- 🔔 **Live Monitoring** — View sensor data instantly.
15+
-**Optimized & Lightweight** — Minimal memory usage for faster performance.
16+
- 📊 **Dashboard Integration** — Full compatibility with **[SciFy Cloud](https://connect.scify-tech.com/)**.
1417

1518
---
1619

17-
## 📦 Installation
20+
## 🛠️ Installation
1821

19-
### **Option 1 — Arduino IDE**
22+
### **Option 1 — Arduino IDE (Recommended)**
2023
1. Open **Arduino IDE**
2124
2. Go to **Sketch → Include Library → Manage Libraries**
2225
3. Search for **"SciFy IoT"**
2326
4. Click **Install**
2427

2528
### **Option 2 — Manual Installation**
26-
1. Download the repository as `.zip` from [GitHub](https://github.com/AlphaNodesDev/SciFy-Iot)
27-
2. Open **Arduino IDE****Sketch → Include Library → Add .ZIP Library**
28-
3. Select the downloaded `.zip` file.
29+
1. Download the repository as a `.zip`[SciFy IoT GitHub](https://github.com/AlphaNodesDev/SciFy-Iot)
30+
2. Open **Arduino IDE**
31+
3. Go to **Sketch → Include Library → Add .ZIP Library**
32+
4. Select the downloaded `.zip` file.
2933

3034
---
3135

32-
## 🛠️ Usage Examples
36+
## 🔗 Connect Your Device to SciFy Cloud
37+
38+
Follow these steps to connect your ESP8266 / ESP32 to the **SciFy IoT Dashboard**:
39+
40+
### **Step 1 — Sign Up**
41+
- Go to [https://connect.scify-tech.com/](https://connect.scify-tech.com/)
42+
- Create a free account.
43+
44+
### **Step 2 — Create a Project**
45+
- After login, click **"Create Project"**
46+
- Add your **Project Name** and **Description**.
47+
48+
### **Step 3 — Add Your IoT Device**
49+
- Go to **Devices → Add Device**.
50+
- Enter **Device Name**, **Device Type** (ESP8266 / ESP32), and **Location**.
51+
- The dashboard will generate:
52+
- **DEVICE_ID**
53+
- **AUTH_TOKEN**
54+
- **API_KEY**
55+
56+
### **Step 4 — Copy Credentials**
57+
- Use these credentials in your Arduino code for **WiFi + SciFy IoT setup**.
58+
59+
---
60+
61+
## 📦 Usage Examples
3362

3463
### **Example 1 — Basic LED Control**
3564
```cpp
@@ -45,17 +74,18 @@ void setup() {
4574
scify.begin("Your_SSID", "Your_PASSWORD", "Your_DEVICE_ID", "Your_AUTH_TOKEN");
4675

4776
// Setup LED Pin
48-
pinMode(2, OUTPUT); // ESP8266 (D4), ESP32 may use GPIO2
77+
pinMode(2, OUTPUT); // ESP8266 (D4) / ESP32 GPIO2
4978
}
5079

5180
void loop() {
52-
// Check for incoming commands from dashboard
81+
// Listen for commands from SciFy Cloud Dashboard
5382
String command = scify.listen();
5483

5584
if (command == "LED_ON") {
5685
digitalWrite(2, HIGH);
5786
Serial.println("LED Turned ON");
58-
} else if (command == "LED_OFF") {
87+
}
88+
else if (command == "LED_OFF") {
5989
digitalWrite(2, LOW);
6090
Serial.println("LED Turned OFF");
6191
}
@@ -95,3 +125,73 @@ void loop() {
95125
delay(2000); // Send every 2 seconds
96126
}
97127
```
128+
129+
---
130+
131+
## 🖥️ SciFy IoT Dashboard Features
132+
133+
| Feature | Description |
134+
|---------------------|-------------------------------------------|
135+
| **Live Data** | Monitor sensor readings in real-time. |
136+
| **Remote Control** | Control IoT devices from anywhere. |
137+
| **Project Logs** | View device connection & data logs. |
138+
| **API Integration**| Connect with other services easily. |
139+
140+
🌐 **Dashboard:** [https://connect.scify-tech.com/](https://connect.scify-tech.com/)
141+
142+
---
143+
144+
## 📚 Documentation
145+
146+
Full documentation is available here:
147+
[https://docs.scify-tech.com/](https://docs.scify-tech.com/) *(Coming Soon)*
148+
149+
---
150+
151+
## 🛠️ Troubleshooting
152+
153+
| Issue | Solution |
154+
|-------|----------|
155+
| **Library not found** | Make sure you've installed it via Library Manager or `.zip`. |
156+
| **Device not connecting** | Double-check WiFi credentials and `AUTH_TOKEN`. |
157+
| **No data on dashboard** | Verify your `DEVICE_ID` and check serial logs. |
158+
| **SSL Issues** | Update your board's certificates from Arduino IDE. |
159+
160+
---
161+
162+
## 🤝 Contributing
163+
164+
We welcome contributions!
165+
- Fork the repo
166+
- Create a feature branch
167+
- Submit a pull request 🚀
168+
169+
---
170+
171+
## 📧 Support
172+
173+
If you face issues, contact us at:
174+
📩 **support@scify-tech.com**
175+
🌐 **Website:** [https://scify-tech.com](https://scify-tech.com)
176+
📌 **Dashboard:** [https://connect.scify-tech.com/](https://connect.scify-tech.com/)
177+
178+
---
179+
180+
## 🏢 About SciFy Technologies
181+
182+
**SciFy Technologies Pvt Ltd** is a multi-domain R&D company focused on IoT, AI, and automation solutions.
183+
We provide **IoT hardware, cloud integration, project assistance,** and **student empowerment programs**.
184+
185+
🔗 **Website:** [https://scify-tech.com](https://scify-tech.com)
186+
📍 **Location:** Bangalore, India
187+
188+
---
189+
190+
## 🏷️ License
191+
192+
This project is licensed under the **MIT License**.
193+
Feel free to modify and distribute.
194+
195+
---
196+
197+
**Made with ❤️ by [SciFy Technologies](https://scify-tech.com)**

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=SciFyIoT
2-
version=1.0.2
2+
version=2.0.0
33
author=Abhiram S (AlphaNodesDev)
44
maintainer=shyjuss8129@gmail.com
55
sentence=Library to manage IoT commands using WebSockets.

0 commit comments

Comments
 (0)