3rd Party Application Deployment Instructions

Transcription

1 Cassia Networks, Inc. 97 East Brokaw Road, Suite 130 San Jose, CA rd Party Application Deployment Instructions Release date:nov 12 th, 2018 Contents 1. Keywords Overview Notes Deploy Container using AC Upload Container to AC Install Container to a Batch of Routers Container Operation View Container Status Delete, Reset, Start/Stop, Remote Login Container Login Container with SSH Make APP Package APP Package Naming Rule What Should be Included in APP Package APP Package Example Deploy APP via AC Console Upload APP to AC Console Install or Upgrade APP to a Batch of Routers Utilities and Packages WIKI for APP Designers Copyright 2019 Cassia Networks, Inc.

2 1. Keywords AC: Cassia IoT Access Controller Router: Cassia Bluetooth router APP: 3 rd party application Ubuntu: an open source operation system 2. Overview With firmware 1.3, Cassia now supports a container in the Cassia E1000 and X1000 Bluetooth routers. The core container OS is Ubuntu The customer can install and upgrade container and APP from Cassia AC and Router console. The container shares the CPU, storage and RAM with the host router. The container can use up to 2 CPU cores and can use up to 128MB RAM memory. 3. Notes It is suggested to keep the memory usage in the container below 70%. The other 30% is for peak hour and abnormal cases. It means the container should use less than 90MB, which includes memory used by 3rd party application and all the tools running in the container. If the user wants to upgrade an existing APP, please make sure that the name and/or version is different. Or, the user can delete the existing APP and install a new one. Cassia router container uses a compact version of Ubuntu. Certain packages may not be pre-installed and/or available. Please consider compiling your application code in a full development environment before loading and attempting to run in the container. The user has SSH/root access to the Ubuntu container. However, Ubuntu is running as a container, so it s core cannot be modified, and the properties of sysfs, e.g. /proc, is read-only. 4. Deploy Container using AC 4.1. Upload Container to AC Please follow the steps on AC: Maintenance->Container Update->Upload firmware- >Browse->OK. 2 Copyright 2019 Cassia Networks, Inc.

3 4.2. Install Container to a Batch of Routers Please follow the steps # on the AC console: Routers->select the routers that need to install Container->More->Container->Install. Please select the container version and click the OK button. 5. Container Operation 5.1. View Container Status The user can get container status and information from AC console. Please follow the steps on AC console: Routers ->select the router ->Edit->Container->The Container. 3 Copyright 2019 Cassia Networks, Inc.

4 5.2. Delete, Reset, Start/Stop, Remote Login Container User can delete, reset, start, stop and remote login container with AC. Please follow the steps on AC console: Routers ->select router->edit->container->delete/reset/start or Stop/Remote Login Login Container with SSH Local SSH login (Localhost and router is in the same network) Login with Linux Shell: ssh p cassia@x.x.x.x Login with Xshell: ssh cassia@x.x.x.x NOTE: x.x.x.x is the IP address of router and cassia/cassia is the username and password. Remote SSH login (Localhost and router is in the different network) Please follow the steps on AC console: Routers ->select router ->Edit->Container->Remote Login->OK. 4 Copyright 2019 Cassia Networks, Inc.

5 After logging into the container with SSH, the user can control Bluetooth with RESTful API, noble or dbus. User can also use apt-get command to install Linux tools. For example, the user can run apt-get install lrzsz to install lrzsz NOTE: In the AC console, users can only establish and maintain SSH session to one router at a time. 6. Make APP Package 6.1. APP Package Naming Rule APP package name format: name.major.minus.tar.gz Name is the name of the APP, which is made up by letter A-Z, a-z, digit 0-9, underline _, en dash -. The length of name string should be equal or less than 16 characters. Major is major version number Minus is minor version number. Note: Both major and minor number are made up of 0-9 only. The length should be no more than 3 digits. tar.gz is the compression format of the APP package What Should be Included in APP Package APP package should include all the program files, configuration files, and data files. It should also include a startup script (autorun.sh). First of all, the contents that the user wants to run automatically when the container starts up should be added in autorun.sh. After that, the user should save all the files following container root file system architecture, set access rights (ready and write), and set user group permissions. Finally, the user should use tar zvcf command to build the APP package APP Package Example Assuming the user wants to generate an APP named abcd with version 1.1. The APP includes startup script autorun.sh, executable program file /usr/bin/eeee, configuration file /etc/ff.conf, and lib file /usr/lib/gg.so 5 Copyright 2019 Cassia Networks, Inc.

6 The file architecture looks like below: When a user runs the command: tar-zcvf abcd.1.1.tar.gz abcd.1.1/, the system will generate APP package file abcd.1.1.tar.gz. After installed this APP package on router, user will find below files in container (the content of abcd.sh is same as autorun.sh): /etc/ff.conf /usr/bin/eeee /usr/lib/gg.so /root/apps/abcd.sh /root/apps/abcd.version 7. Deploy APP via AC Console 7.1. Upload APP to AC Console Please follow the steps on AC console: Maintenance->APP Update->Upload firmware->browse->ok Install or Upgrade APP to a Batch of Routers Please follow the steps on AC console: Routers->select the routers that need to install APP->More->Container->Update APP. 6 Copyright 2019 Cassia Networks, Inc.

7 Please select the APP version and click the OK button. Then the APP will be installed or updated. 8. Utilities and Packages Here is the list of utilities and packages pre-loaded in container version Name Version BlueZ 5.31 Bluetoothd Dbus Python Python Python Pip gobject dbus-python Nodejs * NPM node-gyp noble GCC Copyright 2019 Cassia Networks, Inc.

8 Name Version G++ * In container version 1.1.1, Cassia pre-installed Node.js 6. The customer can upgrade to a newer version of Node.js by themselves. 9. WIKI for APP Designers In order to support APP designers to build their APP, Cassia provides an online wiki resource: The wiki includes the supported features, development environment, supported programming language, built-in utilities and packages, etc. 8 Copyright 2019 Cassia Networks, Inc.