Commit 9a641d50 authored by George Nash's avatar George Nash Committed by Rick Bell

Update the README file

Updated the README file to include instructions. Most of the
updates were indicating how to run the new plugin.

Change-Id: I6ea8deb90735856935335b010a6089f5ee601c22
Signed-off-by: George Nash's avatarGeorge Nash <george.nash@intel.com>
Reviewed-on: https://gerrit.iotivity.org/gerrit/19127Tested-by: default avatarjenkins-iotivity <jenkins@iotivity.org>
Reviewed-by: default avatarRick Bell <richard.s.bell@intel.com>
parent 9aac7c26
......@@ -29,37 +29,24 @@
### Fedora
$ sudo dnf install gssdp-devel gupnp-devel
$ sudo dnf install gupnp-tools #optional but recommended
## Update IoTivity
There is currently a [bug reported for IoTivity](https://jira.iotivity.org/browse/IOT-963)
This can be worked around by changing the following line in iotivity project and
rebuilding iotivity.
Find the file
<iotivity>/resource/csdk/stack/include/ocstackconfig.h
change
#define MAX_URI_LENGTH(64)
to
#define MAX_URI_LENGTH(256)
## Build
You will need to copy the setenv.sh.example to setenv.sh then setup the setenv.sh
file to reflect your environment. You can then source the setenv.sh to setup the
enviroment.
$ cp setenv.sh.example setenv.sh
$ cp setenv.sh.example setenv.sh
$ vi setenv.sh
$ source setenv.sh
To build you will need to copy the BuildOptions.txt.example to BuildOptions.txt
Open the files and update the change the build variables to reflect your
environment.
To build you copy the BuildOptions.txt.example to BuildOptions.txt. Open the
files and update the change the build variables to reflect your environment.
$ cp BuildOptions.txt.example BuildOptions.txt
$ vi BuildOptions.txt
To build run 'scons'. Variables specified in the BuildOptions.txt can be
overwriten by adding them to the scons command at runtime.
overwritten by adding them to the scons command at run-time.
$ scons BUILD_TYPE=release
......@@ -71,6 +58,34 @@ The ObserveClient runs until Control-C, it writes OBSERVE messages to the
console when the state of a light changes.
## Testing
The iotivity-upnp-bridge is in the process of transitioning from the IoTivity
resource container for bridging to the new bridging code found in IoTivity. Also
known as the mini-plugin-manager or MPM. Eventualy the older version of the upnp
bridge that used the resource container will depricated. Until that time both
version of the code can be used.
### Testing MPM version of the bridge
For the time being the MPM version of the bridge relies on the mpm_sample_client
to launch run the bridging plugin. The mpm_sample_client can be found in the
out folder of the IoTivity build.
Run the following:
$ gupnp-network-light #requires gupnp-tools be installed
$ ./mpm_sample_client -a -n /<path_to>/libupnpplugin.so
$ # mpm_sample_client does not automatically detect new devices
$ # type 0 0 to scan for new upnp devices.
$ ./Observer
$ ./SimpleClient
The `gupnp-network-light` is a virtual gupnp light that will only respond to
UPnP. The `mpm_sample_client` is sample program designed to load a bridging
plugin. The `libupnpplugin.so` is the plugin code responsible for discovering
and controlling UPnP devices. The `Observer` finds the UPnP light using IoTivity
and observes any changes in the current lights attributes and reports the
change. The `SimpleClient` will find the light and will toggle the light state.
### Testing resource container version of the bridge
Navigate to the `out/linux/x86_64/<build_type>/bin` directory.
Run the following:
......@@ -117,5 +132,5 @@ The UPnP AV Client Demo Android App, 'upnpavclient-debug.apk' is in the 'java/ex
Follow IoTivity instructions for installing Andriod example apps.
## Testing
Caveat: This currently requires the UpnpBridge running on a Linux system with UPnP Client Demo Android App
Caveat: This currently requires the UpnpBridge running on a Linux system with
UPnP Client Demo Android App
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment