Skip to content

Repository files navigation

SinricPro SDK for Node.js & TypeScript

npm versionLicense

Official SinricPro SDK for Node.js and TypeScript. Control your IoT devices with Alexa and Google Home.

🎯 Features:

  • ✅ Full TypeScript support with strong typing
  • ✅ Modern async/await API
  • ✅ WebSocket with automatic reconnection
  • ✅ HMAC-SHA256 authentication
  • ✅ Event rate limiting
  • ✅ Multiple device types (Switch, Light, Thermostat, etc.)
  • ✅ Comprehensive error handling
  • ✅ Unit tested

📦 Installation

npm install sinricpro

Or with yarn:

yarn add sinricpro

🚀 Quick Start

1. Get Your Credentials

  1. Sign up at sinric.pro
  2. Create a new device (e.g., "Switch")
  3. Copy your credentials:
    • APP_KEY
    • APP_SECRET
    • DEVICE_ID

2. Create a Simple Switch

importSinricProfrom'sinricpro';import{SinricProSwitch}from'sinricpro/devices';constconfig={appKey: 'YOUR-APP-KEY',appSecret: 'YOUR-APP-SECRET',};asyncfunctionmain(){// Create a switch deviceconstmySwitch=SinricProSwitch('YOUR-DEVICE-ID');// Handle power state changes from Alexa/Google HomemySwitch.onPowerState(async(deviceId,state)=>{console.log(`Device turned ${state ? 'ON' : 'OFF'}`);// Control your hardware herereturntrue;// Return true if successful});// Add device to SinricProSinricPro.add(mySwitch);// Connection eventsSinricPro.onConnected(()=>console.log('Connected!'));SinricPro.onDisconnected(()=>console.log('Disconnected!'));// Initialize SDKawaitSinricPro.begin(config);// Send events when state changes locallysetTimeout(async()=>{awaitmySwitch.sendPowerStateEvent(true);},5000);}main().catch(console.error);

3. Run Your App

ts-node app.ts

4. Control with Voice

  • "Alexa, turn on Switch"
  • "OK Google, turn off Switch"

🤝 Contributing

Contributions welcome! Please:

  1. Fork the repository
  2. Create a feature branch
  3. Add tests for new features
  4. Submit a pull request

📄 License

This project is licensed under CC-BY-SA-4.0.


🔗 Links


💬 Support


Made with ❤️ by the SinricPro team

About

Nodejs library for https://sinric.pro

Topics

Resources

Stars

13 stars

Watchers

5 watching

Forks

Releases

Packages

Used by

Contributors

Languages