*** Installation Guide for Invisily IoT Bridge ***
            ==============================================


1- System Requirements:
    1.1. Hardware
        Processor: Dual Core ARM V8
        Memory (RAM): 4 GB
        Network Interfaces: 2
            Ethernet Interface: 1
            Wifi Access Point: 1

    1.2. Software
        Ubuntu 22.04 (64 bit)

    1.3.
        1.3.1- Thin clients will be connected via wifi Access Point.
        1.3.2- 1 x Network Interface connected to Internet/Network where it can access	Invisily Infrastructure. (We call it Network Interface # 1)
        1.3.3- 1 x Wifi Interface acting as Access Point to connect IoT devices, which will access Invisily through Server Bridge. (We call it wifi AP)
               a.  Setup static IP Address on wifiAP interface, preferably 192.168.0.1/24. IoT Bridge uses this /24 by default (see Setting Static IP address on wifi AP Interface).
               b.  In case you would like to use any other subnet , then you can set up its first ip address as a static ip address on this Network Interface.
                   Ex. For IP Address range 192.168.100.0/24, first usable IP 192.168.100.1/24 would be configured on this Network Interface.
               c.  Access Point Setup on Wifi Interface
        1.3.4- Check Section # 7 below about how to setup IP address for Wifi AP

2- How to Install

    2.1- Open Terminal and assign permissions to installation script "install_invisily_controller.sh" by running following command in terminal.
             "sudo chmod a+x install_invisily_iot_bridge.sh"

    2.2- Run the installation script by running following command in terminal.
         a. If you want to use default IP Range 192.168.0.0/24 and have 192.168.0.1 configured for Network Interface,
            "sudo ./install_invisily_iot_bridge.sh --install --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>"
         b. If you want to use custom IP Range, then you would have to enter that custom IP Range in argument
            "sudo ./install_invisily_iot_bridge.sh --install --dhcp-ip-range=192.168.100.0/24 --dhcp-gw-ip=192.168.100.1 --kafka-servers-ips=<ip address of server> --kafka-port=<port> --kafka-topic=<topic>"

3- How to provide the user credentials to the Invisily IoT Bridge.

    First run the invisily application on front-end by running the following commands to provide the valid user credentials.

    3.1 Change the directory to : cd /opt/invisily/linuxclientd/bin/

    3.2 Run the invisily client with sudo : sudo ./invisily_backend

    3.3 Provide the valid user credentials (user,password)

    3.4 Invisily client will send the on-boarding request to web portal or login (registered device) successfully.

    3.5 Terminate the application by Ctrl+C.

    Note : This is for the first time only, Invisily client will save valid credentials for next login. If user credentials expire or user want to change credentials,
    please remove the "cred.data" from /opt/invisily/linuxclientd/bin/.

    3.6 Approve user from Admin Portal

    3.7 Once approved, start invisily service using below command

        sudo systemctl start invisily_backend



4- How to connect clients to Invisily IoT Bridge

    4.1- You client should be able to connect to IoT Bridge via its Wifi Access Point. Password is configured under Pre-requisites steps.
    4.2- Once you will connect a client to Wifi, you will get an ip address via DHCP.
    4.3- You can access http://services.inv in the browser inside the client, to see the list of available services.
    4.4- You can access listed services to confirm that you can access those services.



5- How to Un-install/Remove

    5.1- Open Terminal and run.
         sudo ./install_invisily_iot_bridge.sh --remove


6- How to Troubleshoot

    6.1- The debug and error log files are maintained at the path (/var/log/invisily/invisily-iot-bridge).


7- How to setup Static IP address on second Network Interface

    7.1. Setting Static IP address and wifi Access Point on Wifi Interface
        7.1.1- Considering name of wifi Interface is wlan0
        7.1.2- Access Raspberry pi4 via ssh and run the following commands to install and configure packages via root. You can run sudo su to access root.

                apt-get -y install dhcpcd5 hostapd
                systemctl unmask hostapd.service
                systemctl enable hostapd.service


        7.1.3- Now setup configuration files by copy pasting following

cat > /etc/dhcpcd.conf <<END
interface wlan0
    static ip_address=192.168.4.1/24
    nohook wpa_supplicant
END

        7.1.4- Replace IP address range with your desired IP Address range
        7.1.5- Create another file by copy pasting below

cat > /etc/hostapd/hostapd.conf <<END
country_code=GB
interface=wlan0
ssid=Invisily-iot-bridge
hw_mode=g
channel=7
macaddr_acl=0
auth_algs=1
ignore_broadcast_ssid=0
wpa=2
wpa_passphrase=InvisilyIsTheBest
wpa_key_mgmt=WPA-PSK
wpa_pairwise=TKIP
rsn_pairwise=CCMP
END


        7.1.6- Please replace following values with your desired values.
                - interface=
                - ssid=
                - wpa_passphrase=
        7.1.7- After that Reboot your machine, once it comes back online, wlan interface should have ip address assigned.