Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This page is under development

Table of Contents
maxLevel1

Overview

  • Captive portal is part of onboarding process which is presented to user once device is activated.
  • It allows user to configure his/her WiFi credentials to be personalized which user can remember. It is presented to user if user does factory reset too.
  • It is presented to user if user does factory reset too.
  • A captive portal is a landing GUI page to users , when connected to the device WiFi for the first time,  before they gain broader access to gateway services.
  • To configure Wi-Fi SSID, credentials
  • On fresh boot-up and factory-reset, Captive Portal prompts to change the default ssid name and password for browsing on connected client's client’s through Gateway network

  • On fresh boot-up and factory-reset,, anything user tries in browser will redirect to local captive portal

    Panel

    WAN   https:  http://<WAN IP Address of device>:8080<LAN IP >/captiveportal.php

Code Flow

1) The  The below diagram depicts the captive portal flow via CcspPandM module.

draw.io Diagram
diagramNamecaptive portal flow via CcspPandM module.drawio
revision
Image Removed
1

2) The  The below diagram depicts the captive portal flow via CcspWifiAgent module.

draw.io Diagram
diagramNamecaptive portal flow via CcspWifiAgent module.drawio

...

revision1

Objects

MODULE

XML file

PARAMETERS

CcspPandM


TR181-USGv2.XML

Device.DeviceInfo.X_RDKCENTRAL-COM_CaptivePortalEnable

Device.DeviceInfo.X_RDKCENTRAL-COM_ConfigureWiFi

CcspWiFiAgent

TR181-WiFi-USGv2.XML




Device.WiFi.SSID.1.SSID

Device.WiFi.SSID.2.SSID

Device.WiFi.AccessPoint.1.Security.KeyPassphrase

Device.WiFi.AccessPoint.2.Security.KeyPassphrase

Dmcli command to enable captive portal

Code Block
$ dmcli eRT setv Device.DeviceInfo.X_RDKCENTRAL-COM_CaptivePortalEnable bool true

$ dmcli eRT setv Device.DeviceInfo.X_RDKCENTRAL-COM_ConfigureWiFi bool true

...

If "Device.DeviceInfo.X_RDKCENTRAL-COM_CaptivePortalEnable“ is set to False , WebUI should be UP instead of captiveportal.

...

Supported Languages

  • Currently the supported languages are “English” , “French”
  • The default language is “eng”

...

  • The default language will be obtained as a string through “Device.DeviceInfo.X_RDKCENTRAL-COM_Syndication.RDKB_UIBranding.DefaultLanguage".

TroubleShootingTrouble Shooting

  • During any captive portal issues, verify the below commands .

syscfg get redirection_flag

To get value of redirection_flag (true/false)cat  /nvram/syscfg.db | grep redirect

Code Block
root@RaspberryPi-Gateway:~# cat  /nvram/syscfg.db | grep redirect
block_nat_redirection=1
get redirection_flag=
true

          

 syscfg get HTTPS_Server_IP

To get HTTPS_Server_IP to which it is connected. cat  /nvram/syscfg.db | grep 10.0.0.1

Code Block
root@RaspberryPi-Gateway:~# cat  /nvram/syscfg.db | grep 10.0.0.1
HTTPS get HTTPS_Server_IP=10.0.0.1
lan_ipaddr=10.0.0.1
Default_Server_IP=10.0.0.1
HTTP_Server_IP=10.0.0.1

 

cat  /nvram/syscfg.db | grep PartnerID

 syscfg get PartnerID

To get partern id of syndication partners

Code Block
root@RaspberryPi-Gateway:~#~# syscfg  cat  /nvram/syscfg.db | grep get PartnerID
PartnerID=RDKM


 ifconfig erouter0 , brlan0

...