-------------------------------------------------- HOMENET3D v0.1 README (released 22nd January 2014) -------------------------------------------------- This document is part of the Homenet3D for OpenWrt Project (http://caia.swin.edu.au/urp/homenet3d/openwrt) which is part of the Homenet3D Project (http://caia.swin.edu.au/urp/homenet3d/) OVERVIEW -------- Homenet3D is a project intended to represent the home network in a user-friendly 3D virtual world on portable and fixed end-user devices (such as smart phones, tablets and PCs). Homenet3D for OpenWRT v0.1 is our first new prototype of this idea. This system presents the current system state of an OpenWRT device inside a virtual world, rendered on any WebGL-enabled web browser. The actual 3D world presented in v0.1 is extremely rudimentary -- the code is intended as a platform for future experiments in browser-side 3D visualisation techniques. DOCUMENTATION ------------- For installation instructions, see INSTALL.txt Homenet3D is made up of a WebSockets server and helper scripts on the server side and a Javascript/HTML client. The client and server communicate over WebSockets. The server itself sits on the home router and monitors system and network state, constantly updating the server and therefore updating the virtual world presented to the client. The system state updates are communicated on a local UDP port using C sockets and Lua sockets. The default WebSocket port used between server and client is 10001. The default UDP port used internally on the server side is 27960 (legacy port for L3dgecomms [2]). The web pages for the client are served on default HTTP port (80) by a lightweight web server. The client-side javascript was based on a previous project (W3bworld) [1]. As such it makes use of the javascript files that are the basis of the the W3bworld client. These are described below: * w3b-core.js: contains functions mostly dealing with user input * w3b-entity.js: contains functions and classes for storing and using state information about each entity * w3b-hit.js: contains hit-detection for triggering actions on an entity * w3b-camera.js: contains camera manipulation functionality * w3b-websockets.js: contains network communication functionality * gfx.pde: contains the Processing.js scripts for rendering the world In addition to these, there are a number of third party libraries in use: * jquery-1.7.2.min.js: jQuery, used for simpler DOM manipulation and JS shorthand * processing.bug608.js: a modified version of Processing.js that allows for .obj file loading * fullscreenapi.js: a short script to enable the fullscreen API in web browsers that support it. In the near future, fullscreen support will become standardised and this script will not be needed Some example model files are also included. The server is separated out in to a server process and two helper daemons: * /bin/homenet3d-server: contains entity management and virtual world state * /bin/sys-state: Lua script to get and relay state updates to homenet3d-server * /bin/datarate: bash script that calculate average datarates on net interfaces To start using Homenet3D, read: howto/homenet3d-openwrt-starting-up-v0.1.txt REFERENCES ---------- [1] http://caia.swin.edu.au/urp/l3dge/tools/w3bworld [2] http://caia.swin.edu.au/reports/080222C/CAIA-TR-080222C.pdf LICENSE ------- Copyright (c) 2013-2014 Centre for Advanced Internet Architectures, Swinburne University of Technology. Authors: Dominic Allan (6513476@student.swin.edu.au) Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. CONTACT ------- The Homenet3D for OpenWrt website is: http://www.caia.swin.edu.au/urp/homenet3d/openwrt The Homenet3D website is: http://www.caia.swin.edu.au/urp/homenet3d/ If you have any questions or want to report any bugs please contact Grenville Armitage (garmitage@swin.edu.au) Dominic Allan (dallan@swin.edu.au) Centre for Advanced Internet Architectures Swinburne University of Technology Melbourne, Australia CRICOS number 00111D http://www.caia.swin.edu.au