Page tree
Skip to end of metadata
Go to start of metadata

The following table shows an overview of the directories and files installed with the IzoT SDK:

 
DirectoryDescription
bin/IzoT SDK virtual environment bin directory.
Also contains the IzoT SDK tools (see IzoT SDK Tools).
etc/

Contains IzoT SDK configuration files and settings.

bootstrap is the primary installation/update/configuration tool for the IzoT SDK.

lonbridge/

classes/Contains IzoT Network Server class files that define the interface of IzoT Devices.
default/Contains the default (initial) version of the configuration files present in the parent directory. These files will be updated during upgrades, but the parent files will not be upgraded. Following an upgrade, you should compare the 'default' files to their parent counterparts.
instances/

Contains the run-time database of the IzoT Network Server.

devices.xml is a list of discovered IzoT Devices and their current state. This file is deleted when izot_reset is run.

nginx/

Contains IzoT SDK configuration files and settings for the Nginx Web Server.

izot is the main configuration file (see the configuration page for details).

server.* are the SSL certificate files used for HTTPS access to the IzoT Server. The installer creates self-generated files if they do not already exist to ensure that the server's certificate is unique. These files can be replaced with official certificate files.

supervisor/

default/Contains the default (initial) version of the configuration files present in the parent directory. These files will be updated during upgrades, but the parent files will not be upgraded. Following an upgrade, you should compare the 'default' files to their parent counterparts.
sysctl/

Contains IzoT SDK configuration files and settings for the host operating system.

izot.conf contains the sysctl overrides applied during installation.

include/IzoT SDK virtual environment include directory.
izot/
The root directory of the izot (Python) package.
device/The base directory of the izot.device package.
examples/

common/The directory of the izot.examples.common framework, shared by all IzoT SDK example applications.
resources/

datapoints/The directory of the izot.resources.datapoints package.
enumerations/The directory of the izot.resources.enumerations package.
profiles/The directory of the izot.resources.profiles package.
properties/The directory of the izot.resources.properties package.
server/

api/

The main directory of the izot.server.api (REST API) web application.

fixtures/ contains initial database entries (especially the default user accounts) for the IzoT Server (these are added when running izot_reset or resetdb).

templates/ contains dynamic HTML templates for customizing the look of the admin, (browsable) api and login web pages.

collectors/Contains standard and sample IzoT Collector izot.server.collectors modules.
project/

Contains server-specific settings and framework modules for the IzoT Server.

secret_key.py is auto-generated during installation and secures access to the IzoT Server.

settings/ contains the main settings (default.py) for the IzoT Server. Local settings can be created (local.py) by copying the example local settings (example.py) (see the configuration page for details).

templates/ contains dynamic HTML templates for customizing the look of the server (home) web page.

publishers/Contains standard and sample IzoT Publisher izot.server.publishers modules.
shared/Contains shared utility modules.
subscribers/Contains standard and sample IzoT Subscriber izot.server.subscribers modules.
lib/IzoT SDK virtual environment lib directory.
www/
Root of the web server's static files.
Dynamic web pages are served directly from the IzoT Server.
Pydoc reference pages are served directly from a Pydoc Server via the path /pydocs/.
css/CSS files.
dashboard/Sample web pages for the IzoT Server dashboard (includes a general-purpose IzoT Device browser).
docs/Contains Natural Docs-based documentation for the C/C++-based IzoT Device Stack and ISI libraries.
js/JavaScript files.
manual/The IzoT SDK Manual.
static/Static web pages used by the IzoT Server.
  • No labels