Documentation
UHaveControl User Guide
Welcome to UHaveControl - your comprehensive IoT device management platform. This guide will help you get started with managing your devices, users, and integrations effectively.
What You Can Do
- Device Control: Monitor and control your IoT devices remotely
- User Management: Create and manage user accounts with role-based access
- API Integration: Connect third-party applications and services
- Fleet Management: Organize devices into groups for bulk operations
- Automation: Schedule commands and create device profiles
Device Provisioning Quick Start Guide
Get Started in 5 Steps
Navigate to uSwitch Cloud Settings
Log into your uSwitch cloud management portal and navigate to the device provisioning section.
Click "Provision Device"
Select the "Provision Device" option to begin the device setup process. This will generate the necessary credentials for your device.
Copy Device ID
Once the device is provisioned, locate the device ID under the "Provisioned Name" field. Copy this ID as you'll need it for registration.
Example Device ID: uhc_device_12345abcdef
Sign In or Create Account
Access the UHaveControl platform and either sign in to your existing account or create a new account if you're a first-time user.
Register Device
Navigate to the "Register Device" page and complete the registration form:
- Enter your copied Device ID
- Assign a friendly name to your device
- Select or create a device group
- Configure initial permissions (optional)
Next Steps
After registering your device, you can:
- Test device connectivity and basic controls
- Set up user permissions and access controls
- Create device profiles for standardized configurations
- Schedule automated commands and events
- Generate API keys for third-party integrations
User Management
User Roles
UHaveControl uses a role-based permission system to control access to devices and features:
Account Owner (Root User)
- Full access to all account features and settings
- Can create and manage other users
- Access to billing and enterprise settings
- Can delete the account
Account Administrator
- Can manage users and device permissions
- Access to most account settings
- Can create and manage device groups
- Cannot access billing or delete the account
Standard User
- Access to assigned devices only
- Can control devices based on granted permissions
- Can change personal account settings
- Cannot manage other users
Creating New Users
- Navigate to "Manage Users" in your account settings
- Click "Create Sub-User" or "Add User"
- Fill in the user's email, username, and contact information
- Select the appropriate user role
- Assign device permissions (optional)
- Send the invitation to the new user
Managing User Permissions
Device permissions can be granted at the individual user level or through device groups:
- Viewer: Can view device status and data
- Operator: Can control devices and send basic commands
- Manager: Can configure device settings and create schedules
- Administrator: Full device control plus user permission management
Device Management
Organizing Devices
Keep your devices organized and manageable using these features:
Device Groups
Group devices by location, type, or function:
- Create groups like "Building A", "HVAC Systems", or "Security Cameras"
- Apply permissions to entire groups at once
- Send commands to multiple devices simultaneously
- Apply configuration profiles to all devices in a group
Device Profiles
Create reusable configuration templates:
- Save common device configurations as profiles
- Apply profiles to new devices for quick setup
- Update multiple devices with the same configuration
- Copy settings from existing devices to create new profiles
Fleet Commands
Save frequently used commands for quick access and reuse:
- Navigate to Fleet Control in your device management area
- Create a new command or select from saved commands
- Choose target devices or device groups
- Execute the command across multiple devices simultaneously
- Monitor execution status and results
Scheduling and Automation
Automate device operations with scheduled events:
- Schedule commands to run at specific times
- Set up recurring schedules (daily, weekly, monthly)
- Create conditional automation based on device states
- Monitor and manage scheduled events from the dashboard
API Integration
Getting Started with the API
Connect your applications and services to UHaveControl using our REST API.
📚 Complete API Documentation
For detailed API reference with examples, error codes, and advanced usage, visit our full API documentation.
Step 1: Generate an API Key
- Go to Account Settings > API Keys
- Click "Generate New API Key"
- Give your key a descriptive name
- Select appropriate permissions (read-only, read & write, administrative)
- Copy and securely store your API key
Step 2: Authentication
Include your API key in the request header:
X-API-Key: your-api-key-here
Note: Use HTTPS for all requests to ensure your API key is encrypted in transit.
Common API Operations
/api/devices/{device_id}/data/
Retrieve current device status and sensor data
Requires: read-only permissions or higher
/api/devices/{device_id}/command/
Send control commands to devices
Requires: read & write permissions or higher
Query Parameters
The data endpoint supports filtering by component type:
?type=all
- All device data (default)?type=relay
- Only relay state data?type=gpio
- Only GPIO state data?type=adc
- Only ADC state data?type=relay_c
- Only relay configuration data?type=gpio_c
- Only GPIO configuration data?type=adc_c
- Only ADC configuration data
Rate Limits
Default API Rate Limits
- 60 requests per minute per API key
- 10,000 requests per day per API key
Note: These limits can be exponentially raised for production implementations and are only in place by default to prevent abuse due to the free nature of the service. Contact support to discuss higher limits for your use case.
Example Integration
Python Example - Get Device Data
import requests
# Get device data
headers = {
'X-API-Key': 'your-api-key-here',
'Content-Type': 'application/json'
}
response = requests.get(
'https://cloud.uhavecontrol.com/api/devices/your-device-id/data/?type=relay',
headers=headers
)
device_data = response.json()
print(f"Device status: {device_data['status']}")
Python Example - Send Command
import requests
# Send relay command
headers = {
'X-API-Key': 'your-api-key-here',
'Content-Type': 'application/json'
}
payload = {
"payload": {
"Output": "Relay",
"Relays": [
{
"relay": "Main Power",
"state": 1,
"id": "255.1"
}
]
}
}
response = requests.post(
'https://cloud.uhavecontrol.com/api/devices/your-device-id/command/',
headers=headers,
json=payload
)
result = response.json()
print(f"Command result: {result['status']}")
Account Settings
Security Settings
Keep your account secure with these recommended settings:
Two-Factor Authentication (2FA)
- Go to Account Settings > Security
- Click "Enable Two-Factor Authentication"
- Enter your phone number for SMS verification
- Verify the setup with a test code
- Save backup codes in a secure location
Password Management
- Use a strong, unique password for your account
- Change your password regularly (every 90 days recommended)
- Never share your password with other users
- Use the "Force Password Change" option for sub-users when needed
Enterprise Settings
Account owners can configure organization-wide policies:
- Require 2FA: Force all users to enable two-factor authentication
- Password Expiry: Set automatic password expiration periods
- Session Timeout: Configure automatic logout after inactivity
- User Permissions: Control what account information users can modify
Customization
Personalize your UHaveControl experience:
- Choose between light and dark theme
- Set your timezone and date format preferences
- Configure notification preferences
- Customize dashboard layout and widgets
Need Help?
If you need assistance with any of these features:
- Check our detailed help articles in the Support Center
- Contact our support team through the help desk
- Schedule a demo or training session
- Join our community forum for tips and best practices