Skip to content

Commit

Permalink
Further README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
eflynch committed Jan 25, 2016
1 parent 565d91a commit e9a03db
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ChainFlow #
This build max external objects for interacting with chainAPI
Max external objects for interacting with chainAPI (formerly called MAXChain).

## Build instructions ##

Expand Down Expand Up @@ -49,33 +49,10 @@ make


## Documentation ##
ChainFlow consists of a set of Max external objects that interact with eachother and collectively provide an interface for accessing spatially distributed time-series data hosted by chainAPI server.
ChainFlow consists of a set of Max external objects that interact with eachother and collectively provide an interface for accessing spatially distributed time-series data hosted by chainAPI server. See Help files for documentation on specific objects.

### Definitions ###
* "site" - a collection of devices, sensors, and their data
* "device" - a location in space associated with one or more streams of time-series data usually corresponding to a real-world physical device carrying sensors
* "metric" - a type of time-series data (e.g. "humidity", "temperature")

### Objects ###
The `[chain.site]` object manages a connection to a chainAPI server. The other `[chain.*]` objects need to be attached to an instance of `[chain.site]` which manages them. The first and only argument to all `[chain.*]` objects is an identifier to associate workers with a site. This defaults to a genric identifier "defaul_site." Each instance of `[chain.site]` should be given a unique identifier.

#### `[chain.site]` ####


#### `[chain.device]` ####


#### `[chain.info]` ####


#### `[chain.zone]` ####


#### `[chain.time]` ####


#### `[chain.metric]` ####


#### `[chain.map]` ####

0 comments on commit e9a03db

Please sign in to comment.