Skip to content

JavaScript library for OpenKarotz API

License

Notifications You must be signed in to change notification settings

Wulfaz/openkarotz-js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

openkarotz-js

Description

JavaScript library for OpenKarotz API.

Current version is 0.5.0.

This library depends on jQuery.

OpenKarotz can be found here.

Usage

Include external libraries

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="openkarotz-0.4.0.min.js"></script>

Example call to status, leds and ears API

var K = new OpenKarotz("192.168.1.10");
console.log("OpenKarotz IP: " + K.getIp());

K.status(
  function(result) { console.log("Status success"); },
  function(errorMessage) { console.error("Status error"); });

console.log("OpenKarotz version: " + K.getState().version);

K.ledPulse("FF00FF", function() { K.ears(5, 5); });

Available API

  • clear_cache
  • clear_snapshots
  • ears
  • leds
  • moods
  • moods_list
  • reboot
  • rfid_delete
  • rfid_info
  • rfid_list
  • rfid_list_ext
  • rfid_start_record
  • rfid_stop_record
  • sleep
  • snapshot
  • snapshot_list
  • sound
  • sound_control
  • status
  • tts
  • wakeup

License

Copyright (c) 2023 Lionel Caillis Copyright (c) 2013-2014 Olivier Bagot

Licensed under The MIT License (MIT)

See LICENSE

About

JavaScript library for OpenKarotz API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 80.2%
  • HTML 19.3%
  • Batchfile 0.5%