Skip to content
SensorScape client
Go Dockerfile Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ss_c move startup message Aug 31, 2019
.gitignore initial Aug 31, 2019
COPYING readme Aug 31, 2019
Dockerfile initial Aug 31, 2019
README.md readme Sep 2, 2019
build.sh initial Aug 31, 2019
run.sh initial Aug 31, 2019

README.md

SensorScapeClient v1.0.0

SensorScape is a data collection, transport, and analysis framework for sensor networks and the Internet of Things.
Data is collected from hardware devices with modules, queued and sent reliably to a server by the client, and parsed, analyzed, and presented by a server.

This is the SensorScape client.
The module repo is here.
The server repo is here.

Installation

  1. Fill out nodeID, publicKey, privateKey, serverKey, and serverHost in ss_c/ss_c.conf
    • nodeID must be registered on the server (using the nodes add command)
    • Keys can be generated on the server using the keypair command, or you can generate them yourself
  2. From the top level: ./build; ./run
  3. Run modules

Note: You must run ./build.sh after updating the ss_c.conf file for changes to take effect.

Operation

  1. Type help at the command line
  2. Modules that you run may register commands with the client. The output of the help command will include information about registered commands as well
  3. Metric granularity is one second. If you send the same metric twice in a second, the most recent is what's stored on the server.

Technical

  1. The client listens for metric data from modules on listenPort, and sends data to the server on serverPort
  2. Should the connection between the client and the server be interrupted, the client will queue metrics to send later
  3. Data is sent from the client to the server in protocol buffers over ZeroMQ

TODO

  • show nodeID when press enter
  • notification framework. the server can message the client to:
    • act as an intermediary to send messages between clients (implement a message command in the client)
    • let clients know about interesting events they're subscribed to
      • example: 'stationxx is close to you'
      • don't use zmq pub/sub because it is filtered at the client side. roll our own.
  • show throughput for each module, and total estimated throughput to server
  • verify when server returns a TSDB error client disconnects w/ message and tries to reconnect
  • fix client sends last heartbeat from before disconnect (measurement also if it was last to be sent? it's queued and uses it to test reconnect...)

License

Copyright (C) 2019 Joshua Davis

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

You can’t perform that action at this time.