https://github.com/Microsoft/tsdoc

Ref: https://jeedom.github.io/core/fr_FR/api_http

the RPC api seems to not expose method for removing an object, try to reverse engineering jeedom in order to add the method

Ref: https://jeedom.github.io/core/en_US

Complete list

misc

• ping
• version
• datetime

config

• config::byKey
• config::save

event

• event::changes

object

• object::all
• object::full
• object::fullById
• object::byId
• object::save

summary

• summary::global
• summary::byId

eqLogic

• eqLogic::all
• eqLogic::fullById
• eqLogic::byId
• eqLogic::byType
• eqLogic::byObjectId
• eqLogic::byTypeAndId
• eqLogic::save

cmd

• cmd::all
• cmd::byId
• cmd::byEqLogicId
• cmd::execCmd
• cmd::getStatistique
• cmd::getTendance
• cmd::getHistory
• cmd::save

scenario

• scenario::all
• scenario::byId
• scenario::export
• scenario::import
• scenario::changeState

log

• log::get
• log::list
• log::empty
• log::remove

datastore

• datastore::byTypeLinkIdKey
• datastore::save

message

• message::all
• message::removeAll

interaction

• interact::tryToReply
• interactQuery::all

system

• jeedom::halt
• jeedom::reboot
• jeedom::isOk
• jeedom::update
• jeedom::backup
• jeedom::getUsbMapping

plugin

• plugin::listPlugin
• plugin::install
• plugin::remove
• plugin::dependancyInfo
• plugin::dependancyInstall
• plugin::daemonInfo
• plugin::daemonStart
• plugin::daemonStop
• plugin::daemonChangeAutoMode

update

• update::all
• update::checkUpdate
• update::update

network

• network::restartDns
• network::stopDns
• network::dnsRun

It would be nice to expose a high level API for jeedom (based on low level rpc api)

Ideas 💡

• device observer
• high level device objects (with methods)

device = eqLogic

Todos

• close #1

• We have to close #1 before release the first stable version (1.0)

New usage

const Jeedom = require('jeedom');

const { rpc } = Jeedom({
  host: 'http://jeedomip',
  apikey: '__JEEDOM_API_KEY__',
});

rpc.ping()
  .then(pong => console.log(pong));