CHAOS: Difference between revisions

(22 intermediate revisions by 3 users not shown)

Line 1:

CHAOS is our API - it's still work in progress, and further features will be added~~. We'll add to this section of the wiki with examples~~.

'''CHAOS''' is our API - it's still work in progress, and further features will be added.

==CHAOS Version 1==

⚫

~~Information~~: http://aa.net.uk/~~support-chaos~~.~~html~~

'''Disabled'''

Version 1 is no longer available for use. Use version 2 instead.

Other (3rd party) uses of CHAOS:

⚫

*https://github.com/~~JamesBelchamber~~/aaisp-~~tools~~

==CHAOS Version 2.x==

CHAOS is an application interface (API) for machine to machine interaction with our control and ordering systems. It provides a means to perform the following key operations:-

==Getting CQM Graphs==

*Access information about an existing service, eg your remaining quota

*Adjust settings on an existing service

*Obtain usage data relating to an existing service

*Obtain sync rates of a DSL line

*Obtain VoIP call rate card

*Order a cease of an existing service

*Order a change to an existing service

*Check availability of new services

*Order a new service, including creating a new account

*etc.

The control systems cover a wide range of services, including broadband, ethernet, telephony, domains, email, mobile SIMs, and so on.

This is a quick example of getting cqm graphs from CHAOS.

Whilst CHAOS may initially not provide access to all of these services, it is intended to be a general platform that can be extended over time to provide a comprehensive machine to machine interface to all of our services.

In short, the Info command is used to get the graph URLs. The HTML provides a form to enter the credentials or you can edit the javascript to hardcode these.

===Further Information===

CHAOS is currently limited to only showing DSL graphs (eg, not SIMs) and only for lines on the login, ie a 'Manager' or 'Group' login.

⚫

Manual: http://aa.net.uk/pdf/CHAOS2.pdf

==Uses==

HTML:

Here are some projects that are using the CHAOS API:

http://wiki.aa.org.uk/aacustom/chaosgraphs.html

*'''Munin Plugin by Nat Morris'''

**[https://github.com/natm/munin-plugins-aaisp Code on Github], [https://munin.hw.esgob.com/broadband-day.html Example]

**Just need to provide one account & password, it will automatically graph multiple lines and produce combined graphs etc.

*'''MQTT Service by Nat Morris'''

⚫

**[https://github.com/natm/aaisp-to-mqtt Code on Github]

** Publish circuit statistics to an [https://en.wikipedia.org/wiki/MQTT MQTT] broker, makes it very easy to integrate with home automation projects such as [https://home-assistant.io/ Home Assistant] and [http://www.openhab.org/ openHAB].

[[Category:Control Pages]]

Javascript (you'll also need jquery:)

http://wiki.aa.org.uk/aacustom/chaosgraphs.js