root/ossiedev/branches/jsnyder/trunk/tools/cornetApps/README @ 11067

Revision 11067, 2.4 KB (checked in by edent, 15 months ago)

add README

Line 
1#############
2Django setup
3#############
4There are 4 main applications in the project:  LoginUser, WebDash, HtmlPages, and DomainMan
5LoginUser:  handles logging in the user, redirecting pages, and user directory/accounts/waveforms
6WebDash:  controls the waveforms
7HtmlPages:  the main pages for the interface
8DomainMan:  Connecting to nodes and starting nodeBooter/naming service
9
10########
11Settings
12########
13Once the project is checked out from the repository, there is no need to change between the settings for the webserver and working directory
14This is handled in the apache/django.wsgi file: the webserver looks at settingsWeb.py
15and the working directory uses the default settings.py when using the development server (python manage.py runserver)
16
17############
18Static files
19############
20After changing the css or javascript files, you must run (python manage.py collectstatic) to update the main /static folder.
21Make sure that the directorys where the original file is located is also listed in the STATICFILES_DIRS of the settings file.
22
23Ossie interface layout
24======================
25Four main frames are separated into four div tags: the directory, the main frame, the workspace, and the active applications.
26#Directory: lists the waveforms of the loaded node,
27#Main frame: contains the status of the nodes in a grid or map form
28#Apps: Lists the waveforms that are running
29#Workspace: contains the information about the current waveform
30
31#########
32LoginUser
33#########
34The login runs on SQLite database file found in the main directory saved as cornetApps.db
35This is separate from the CORNET user database.
36It runs through the given Django login module (django.contrib.auth.views.login). 
37
38#########
39DomainMan
40#########
41Connects to the ip's of the nodes:  192.168.1.xx.
42.xx starts at 11 on floor 1 and increments by 1.  Each floor has 12 nodes:
43Floor 1: .11 - .22
44Floor 2: .23 - .34
45Floor 3: .35 - .46
46Floor 4: .47 - .58
47
48When connecting through the server, see http://cornet.wireless.vt.edu/trac/wiki/CORNET/HowToUseCORNET
49
50##################
51Using the interface
52###################
53
54When clicking on the node in the interface, it calls the loadNode(ip) javascript method,
55which in turn loads the waveform through WebDash into the #directory div/frame.
56
57In the directory column/frame, the home icon brings the user to the account page where you can view the user's available waveforms.
58the eject icon logs the user out of the interface.
Note: See TracBrowser for help on using the browser.