onwords 0.2.0

Onwords - Gate Control Package for Smart Gate Systems

Onwords

Gate Control Package for Smart Gate Systems

Control your Onwords smart gates (Sliding Gate, Arm Gate) via Python or CLI.

---

Installation

pip install onwords

Get Your API Key

1. Visit ostapi.onwords.in
2. Click "Get API Key" from the menu
3. Login with your email and password
4. Select the devices you want to control
5. Click "Generate API Key" and copy it

⚠️ Store your API key securely. Never expose it in public code.

Quick Start

1. Configure API Key

import onwords

onwords.configure("your-api-key")

Or via CLI:

onwords-config --api-key YOUR_API_KEY

2. List Your Products

import onwords

products = onwords.get_products()
for product_id in products:
    print(product_id)

Or via CLI:

onwords-list

3. Control Your Gate

import onwords

gate = onwords.control("your-product-id")

# Sliding Gate (3chsg)
gate.open()
gate.close()
gate.pause()       # or gate.stop()

# Sliding Gate Advanced (3chsgsl)
gate.open()
gate.close()
gate.pause()
gate.partial_open()  # or gate.pedestrian()

# Arm Gate - Single (3chag)
gate.open_single_gate()
gate.close_single_gate()
gate.pause_single_gate()

# Arm Gate - Double (3chag)
gate.open_double_gate()
gate.close_double_gate()
gate.pause_double_gate()

Or via CLI:

onwords-control PRODUCT_ID open
onwords-control PRODUCT_ID close
onwords-control PRODUCT_ID pause

Supported Gate Types

Gate Type	Product Prefix	Description
Sliding Gate	3chsg	Standard sliding gate
Sliding Gate Advanced	3chsgsl	Sliding gate with pedestrian mode
Arm Gate	3chag	Boom barrier / arm gate

Supported Actions

Gate Type	Actions
Sliding Gate (3chsg)	open, close, pause
Sliding Gate Advanced (3chsgsl)	open, close, pause, partial_open
Arm Gate Single (3chag)	open_single_gate, close_single_gate, pause_single_gate
Arm Gate Double (3chag)	open_double_gate, close_double_gate, pause_double_gate

CLI Commands

Command	Description
onwords	Show help and config status
onwords-config -k KEY	Configure your API key
onwords-list	List all your products
onwords-list --json	List products as JSON
onwords-control ID ACTION	Control a gate

Python API Reference

onwords.configure(api_key)

Save your API key for future use.

onwords.get_products()

Fetch all product IDs from your account.

onwords.control(product_id)

Get a controller for a specific product.

Controller Methods

Sliding Gate:

• .open() - Open the gate
• .close() - Close the gate
• .pause() / .stop() - Pause/stop the gate
• .partial_open() / .pedestrian() - Partial opening (Advanced only)

Arm Gate:

• .open_single_gate() / .close_single_gate() / .pause_single_gate()
• .open_double_gate() / .close_double_gate() / .pause_double_gate()

Generic:

• .action(action_name) - Send any action

Configuration

Config is stored at ~/.onwords/config.json

API Documentation

Full API docs: ostapi.onwords.in/api-documentation

Support

📧 [e-mail]

License

MIT License - see LICENSE for details.

---

Onwords - Where Luxury Meets Innovation
onwords.in