https://github.com/videoexpertsgroup/vxg.uplink.sdk
https://github.com/videoexpertsgroup/vxg.uplink.sdk
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/videoexpertsgroup/vxg.uplink.sdk
- Owner: VideoExpertsGroup
- Created: 2023-09-20T08:53:10.000Z (almost 2 years ago)
- Default Branch: release-1.0.5
- Last Pushed: 2024-06-27T18:29:45.000Z (12 months ago)
- Last Synced: 2024-12-30T19:52:41.452Z (6 months ago)
- Language: C
- Size: 773 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ONVIF Uplink Camera Plugin for VXG Cloud
Learn more about Cloud Video Surveillance\
Learn more about usage and development in our Knowledge Base
The `ONVIF Uplink Camera Plugin` is a simple `C++` reference code for integration of `IP cameras` with `VXG Cloud`.
This library requires requires libwebsockets version 4.0 (4.0.20-2) as a minimum.
## CMake Guide
### Compile Application for Local Machine
1. Install necessary libraries.
```
sudo apt update && sudo apt install -y build-essential libwebsockets-dev cmake
```
2. Setup build and install directories.
```
cd
mkdir build && mkdir install
```
3. Build.
```
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=../install
make && make install
```
Binary executable will be found at `/build/vxg-proxy-client`
Library files will be found at `/install`
### Cross Compile Application
This process may require the cross compilation of additional libraries if they are not already built into the toolchain of the target platform.\
For example: If the target toolchain may have libssl and libcrypto already built, but not libwebsockets (LWS). You will need to cross-compile LWS with SSL support before cross compiling the Uplink App.
1. Install necessary build libraries on host machine.
```
sudo apt update && sudo apt install -y build-essential cmake
```
2. Setup build and install directories.
```
cd
mkdir build && mkdir install
```
3. Prepare cross file.
Example: `example_cross.cmake`
```
# the name of the target operating system
set(CMAKE_SYSTEM_NAME Linux)
# which compilers to use for C and C++
set(CMAKE_C_COMPILER -gcc)
set(CMAKE_CXX_COMPILER -g++)
# where is the target environment located
set(CMAKE_FIND_ROOT_PATH )
# adjust the default behavior of the FIND_XXX() commands:
# search programs in the host environment
set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
# search headers and libraries in the target environment
set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
set(CMAKE_C_FLAGS "-O2 -g -Wall -fmessage-length=0")
set(CMAKE_CXX_FLAGS "-O2 -g -Wall -fmessage-length=0")
```
4. Cross compile.
```
cd build
cmake .. -DCMAKE_INSTALL_PREFIX="../install" -DCMAKE_TOOLCHAIN_FILE="../cross/example_cross.cmake"
# Optional -DLWS_LIB
# -DLWS_INCLUDE
# -DSSL_LIB
# -DCRYPTO_LIB
# -DSSL_INCLUDE
make && make install
```
Binary executable will be found at `/build/vxg-proxy-client`\
Library files will be found at `/install`
## Example Application Usage
### Commandline Options
```
--token (Access token for camera, generated by VMS)
--serial (Serial number of device)
--http (disable HTTPS)
--insecure (do not verify HTTPS certificates)
--debug (enable debug logs)
-f :http|https|tcp:[]:
```
### Environment Variables
`VXG_API_HOST` - hostname of VXG Camera API (by default: camera.vxg.io)
`VXG_API_PATH` - template for VXG Camera API token request path + query string
(by default: /v1/token?serial_id=%s, %s here will be auto-replaced with device serial number during runtime)
`VXG_API_PASSWORD` - API password/authorization
(MUST be set if no --token argument provided)
`PROXY_API_PATH` - URI path for requesting websocket endpoint from proxy API
(by default: /api/ws-endpoint)
`AUTH_TOKEN` - so you could also provide auth token via env variable
`DEVICE_SERIAL` - so you could also provide device serial number via env variable
### Running Application
There are two main options for executing the sample application.
#### Using Provisioning Server to Retireve Access Token
This is the prefered method in practice. Access token will need to be created by creating an Uplink Camera on VMS using the Camera's Serial Number and MAC Address.
```
VXG_API_PASSWORD= ./vxg-proxy-client --serial -f fwd1:http:[127.0.0.1]:80 -f fwd2:tcp:[127.0.0.1]:554
```
`fwd1:http:[127.0.0.1]:80` creates a forward for port 80 on the local machine. Used for providing access to camera Web UI.\
`fwd2:tcp:[127.0.0.1]:554` creates a forward for port 554 on the local machine. Used for providing access to camera RTSP stream.
#### Using Access Token from VMS
This method is mainly used for testing application. Token will need to be created and fetched from VMS manually.
```
./vxg-proxy-client --token eyJjYW1pZCI6IDEyMzQ1NiwgInVwbGluayI6ICJkZXYtYXBpLnByb3h5LmNsb3VkLXZtcy5jb20ifQo= -f fwd1:http:[127.0.0.1]:80 -f fwd2:tcp:[127.0.0.1]:554
```
This method involves manually providing the access token to the application. The application will then avoid requesting the token from the provisioning server using `DEVICE_SERIAL` and `VXG_API_PASSWORD`\
`fwd1:http:[127.0.0.1]:80` creates a forward for port 80 on the local machine. Used for providing access to camera Web UI.\
`fwd2:tcp:[127.0.0.1]:554` creates a forward for port 554 on the local machine. Used for providing access to camera RTSP stream.\
### Checking Connection After Running Application
You can request connection info for a specific camera using the Uplink Server's API.
```
curl -H 'Authorization: Bearer ' https:///api/device/
```
`DEVICE_ID` can be retrieved from the Access Token used during execution of application.
Example response:
```
{
"camid": "123456",
"proxy_id": "f2f8b6edd7ebbdbd4100",
"forwards": [
{
"name": "fwd1",
"protocol": "tcp",
"host": "google.com",
"port": 443,
"proxy_port": 38103,
"proxy_host": "beeeaacf8af994911700.proxy.cloud-vms.com"
}
]
}
```
`proxy_host`:`proxy_port` is the address that you can access the forwarded address and port from.