This repository is the private cloud edition of IRext services and consoles
-
Prerequisite: Linux Server (Ubuntu 22.04 is recommended) and Docker runtime.
-
Go to the 'Applications' page, create an application of type 'Private Service', then click the application entry to enter the details page.
- On the details page, click the 'View Deployment Method' button to see two supported deployment options. Please select the radio buttons below according to your actual environment and requirements to view the deployment and initialization instructions for each mode.
The private service works in collaboration with the public cloud, authentication and data updates are handled through the public cloud
In hybrid cloud mode, the private service host requires Internet access. Follow the steps in the private service application details on the "Applications" page and run the docker run command directly.
During this process, please ensure that the deployment administrator is the IRext account that applied to create the "Private Service Application". The administrator's IRext login password, and the APP Key and APP Secret of the private service application are all sensitive information. Please keep these credentials safe and do not disclose them.
Runs completely offline, all authentication and data are managed locally.
In offline deployment mode, since the private service host cannot connect to the Internet or can only connect with restrictions, you need to follow the instructions in the private service application details on the "Application" page, download the container image package on a host with Internet access, safely copy it to the private service host, and then import and start the container image.
During this process, please ensure that the deployment administrator is the IRext account that applied to create the "Private Service Application". The administrator's IRext login password, and the APP Key and APP Secret of the private service application are all sensitive information. Please keep these credentials safe and do not disclose them.
After the container starts successfully, please wait 1 minute. Then open http://<server_ip>:8080 in a browser on a PC connected to the private service to access the private service console and enter the initialization settings.
-
In hybrid cloud deployment mode, the private service can call the user authentication and data synchronization Restful API of the IRext public cloud, facilitating convenient data download and import.
-
When logging in to the private service console for the first time, you can choose the hybrid cloud deployment mode or the offline deployment mode (hybrid cloud mode is compatible with offline mode). It is recommended to choose the hybrid cloud mode.
- Then enter your IRext username (email address) and 6-digit numeric password to perform administrator authentication.
- After the administrator authentication passes, it begins to download and import the private service data, which is stored in the container of the private service, completely isolated from the IRext public cloud.
- After initialization, you can enter the administrator username and password again to log in to the private service console, download binary codes in the console, and perform online decoding and data updates.
- In offline deployment mode, the deployment administrator must be the IRext user who created the private service application on the public cloud. Therefore, authentication is done by entering the APP_SECRET. The APP_SECRET can be obtained from the private service application details on the "Application" page.
- After the identity verification passes, you proceed to the data import step. You need to upload the encrypted data package (.tar.gz.enc format, no larger than 200MB) downloaded from the public cloud, which can be obtained by clicking the "Download Data Pack" button in the private service application details on the "Application" page. After the upload, the system automatically decrypts and extracts the package, and imports the code index database and the IR binary codes into the container of the private service. The import progress is displayed in real time, please wait patiently until it completes.
- After the data import completes, the initialization succeeds. Click the "Go to Login" button and the page returns to the login screen. You can then log in to the private service console with the IRext administrator account (email address and login password) that created the private service application, and perform online decoding, data updates and other operations.
-
Enter local console, find your target remote control binary step by step and download the bin file.
-
Use the online decoding feature to manually obtain and analyze the carrier time sequence generated after decoding the remote control binary code.
The private service provides Restful API through URL http://<server_ip>:8081/irext-server. Please refer to the "Cloud Restful API" chapter for more information.
Configure and call the following initialization interface during application initialization, so that the Cloud SDK connects to the private service:
private static final String ADDRESS = "http://<your private server IP>:8081";
private static final String APP_NAME = "/irext-server";
public WebAPIs mWeAPIs = WebAPIs.getInstance(ADDRESS, APP_NAME);
In hybrid cloud deployment mode, set app_key and app_secret in AndroidManifest.xml to the APP KEY and APP SECRET of the Android application you registered on the public cloud
In offline deployment mode, set app_key and app_secret in AndroidManifest.xml to the APP KEY and APP SECRET of the private service application you registered on the public cloud
<meta-data
android:name="irext_app_key"
android:value="your android app_key for hybrid mode OR your private cloud app_key for offline mode" />
<meta-data
android:name="irext_app_secret"
android:value="your android app_secret for hybrid mode OR your private cloud app_secret for offline mode" />
Configure the private service IP address in network_security_config.xml to allow http access.
Configure and call the following initialization interface during application initialization, so that the Cloud SDK connects to the private service:
private static final String ADDRESS = "http://<your private server IP>:8081";
private static final String APP_NAME = "/irext-server";
public WebAPIs mWeAPIs = WebAPIs.getInstance(ADDRESS, APP_NAME);
In hybrid cloud deployment mode, pass the app_key and app_secret parameters when calling signIn, using the APP KEY and APP SECRET of the Web application you registered on the public cloud
In offline deployment mode, pass the app_key and app_secret parameters when calling signIn, using the APP KEY and APP SECRET of the private service application you registered on the public cloud
For private service version 1.6.0 and later, data can be updated monthly to stay in sync with the public cloud's code library index and binary remote control codes. Versions earlier than 1.6.0 do not support this update capability; please upgrade and deploy as soon as possible by following the instructions in this chapter.
In hybrid cloud deployment mode, after entering the console, click the 'Update Data' button in the upper-right corner of the console to start updating data automatically.
In offline deployment mode, you can click the 'Download Latest Data Package' button in the details of the private service application on the 'Applications' page of the public cloud console to obtain the latest data package and perform an offline update.
