HOTSPOT MANAGER SPECIFICATIONS... 3 CHANGELOG... 4 REQUIREMENTS... 5 SETTINGS IP Address API Port Username Password...

Transcription

1 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Infinitel HtSpt Manager User Guide Cntents INFINITEL HOTSPOT MANAGER USER GUIDE... 1 HOTSPOT MANAGER SPECIFICATIONS... 3 CHANGELOG... 4 VERSION VERSION VERSION VERSION VERSION REQUIREMENTS... 5 SETTINGS... 6 MIKROTIK ROUTEROS... 7 IP Address... 7 API Prt... 7 Username... 7 Passwrd... 7 MIKROTIK USER MANAGER... 8 Custmer... 8 Passwrd Length... 8 Prfiles... 8 AUTOGENERATED USERS... 9 Página 1 de 12

2 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Prefix... 9 Username Length... 9 Serialized Number Username... 9 Next Number fr Username... 9 PREDEFINED USERS... 9 Use Predefined Users... 9 List f Users... 9 PRINTER IP Address Prt Ticket QRCODE HtSpt URL QRCde URL Redirectin Página 2 de 12

3 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: HtSpt Manager Specificatins HtSpt Manager fr Mikrtik generates custmized printed tickets with randmly generated r predefined usernames and passwrds fr a Mikrtik User Manager based HtSpt. HtSpt Manager wrks cnnected t Mikrtik User Manager and prints t a thermal ESC/POS cmpatible Epsn printer with netwrk supprt (wifi r ethernet) t issue paper tickets. Infinitel HtSpt Manager supprts as many Mikrtik User Manager prfiles as yu need. Yu can set yur Mikrtik User Manager t set tickets duratin in minutes, hurs, days r weeks and print them with a single tuch. The app allws yu t setup many ptins: Setup as many prfiles/credits as needed. Define the username prefix and length. Define the passwrd length. Define list f predefined reusable usernames Custmize main screen lg. Prtect settings with passwrd. Define a custmized ticket/vucher: Frmat yur text fnt: bld, underlined, duble tall, duble wide. Align it t left, center r right. Print yur custm lg. Print a QRCde t access htspt captive prtal and autfill username. Use the QRCde t redirect yur users t a page f yur chice after lgin. Set autcut paper if printer supprts it. HtSpt Manager is cmpatible with Mikrtik RuterOS 4.17, 5.12 r higher. Página 3 de 12

4 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Changelg Versin 1.5 Added ptin t register a list f predefied usernames that can be reused. A selectable drplist will appear n the main screen and yu can chse AUTO t generate a randm user r a predefined user name t delete the current user with the same name and create a new ne with the same name and the selected prfile. Versin 1.4 Added ptin t generate usernames randmly r sequentially Slved errr with Mikrtik RuterOS with beta/rc versin numbers Versin 1.3 App name/icn/lg changed t a mre neutral/n mark lk Added an ptin t custmize the main screen's lg The settings screen can be passwrd prtected Versin 1.2 Rebuilt printer libraries Added frmating tags: bld, underlined, duble tall, duble wide, alignment left,center r right. Added lg printing supprt. Added QRCde printing supprt. Added paper cut supprt. Versin 1.1 Added supprt fr Mikrtik User Manager Better handling f cnnectin errrs. Página 4 de 12

5 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Requirements The app needs these requirements t prperly perate: An Andrid device with versin 2.2 r higher A Mikrtik RuterOS 4.17, 5.12 r higher that shuld accmplish: T have installed and cnfigured an instance f Mikrtik User Manager T have enabled API service T have a user with access t API service A ticket printer with netwrk supprt (Ethernet r wifi) and ESC/POS cmpatible The Andrid device must have access t the netwrk address f the Mikrtik device and f the printer. Specifically, by default shuld have visibility f prt 8728 t access the service API and prt 9100 t access the printer. These parameters are cnfigurable frm yur applicatin t reslve cases where the default prts are nt used. Página 5 de 12

6 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Settings After installing the applicatin, n its first run, it will shw a message ntifying that the applicatin failed t cnnect t the device: Just accept the message and enter t the Settings screen t perfrm ur initial setup. As an example the next scenari will be used t explain sme f the available settings: Our basic installatin example cnsist f an Andrid device, a RB751 running the htspt and the User Manager s service, and a netwrk printer. As shwn n the previus diagram, Mikrtik User Manager is set at and the printer uses Página 6 de 12

7 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Mikrtik RuterOS As yu enter the setup windw, the first sectin cntains the cnfiguratin data t cnnect t the Mikrtik device running Mikrtik User Manager. IP Address We must set the IP address r dns entry f the Mikrtik device running Mikrtik User Manager. In ur example this shuld be API Prt The TCP prt used t cnnect t the previusly selected device. By default Username Username with enugh permissins t access the Mikrtik device thrugh API service, read settings and write new User Manager users. In ur example we will suppse we hava an apiuser use with has enugh permissins t cnnect t API, read the cnfiguratin and create new User Manager users. Passwrd The passwrd f the previusly specified user. In ur example lets suppse its apipass. Página 7 de 12

8 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Mikrtik User Manager The next grup f parameters refers t the Mikrtik User Manager settings. These will determine hw new User Manager users will be created. Custmer This parameter makes reference t the custmer/subscriber (depending n User Manager s versin) that wns the prfiles/credits that the applicatin uses. Specifically, the wner f the prfiles (in 5.x) r credits (in 4.17) and the wner f the newly created users that will get printed tickets. Fr ur example we will suppse a custmer named manager. Passwrd Length This parameter will set the default length fr the newly generated user s passwrd which will always be a randm string f the specified length. Prfiles The prfiles parameter refers t prfile elements in Mikrtik 5.12 r higher, r credit elements in versin There must be ne single entry n each line f the parameter s value. Each entry n this list will create a buttn in the main screen f the app. If an entry is errneus it will be ignred and the buttn fr that entry will nt be generated n the main screen. When yu push ne f the generated buttns n the main screen, the app will cnnect t the User Manager and will generate a new randm username with a randm passwrd and send the crrespnding ticket/vucher t the netwrk printer. The title f the generated buttns will be determined by: On versin 4.17: The credit s cmment value will be used as the buttn text. If the value f cmment is empty the name f the prfile will be used instead. On versin 5.12 r higher: The prfile s field name-fr-users will be used as the buttn s text. If nt set, the name f the prfile will be used instead. Página 8 de 12

9 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Autgenerated Users Prefix Newly created user will get an username like [prefix][randm string]. Fr example, when issuing a ticket, the app will generate a randm string like AaBbCc and the if the prefix has been set t Infinitel_ the new username will be Infinitel_AaBbCc. Username Length This parameter specifies the length f the randm string generated t cmpse the new usernames. It is recmmended t use a string length greater than r equal t 4. Lets suppse a prefix set t Infinitel_ and a value f 4 fr this parameter, the resulting username culd lk like Infinitel_AbCd. If we set 6 as the length value the result culd be like Infinitel_AbCdEf. Serialized Number Username When Serialized Number Username is enabled, usernames will be created sequentially building the username as [prefix]+[next number]. The username number will be taken frm Next Number fr Username and will be frmatted as a zer filled string based n the value f Username Length. As an example, having a Username Length f 4 and a Prefix as Pre_ new generated users will be in the range f Pre_0001 and Pre_9999. Once, in this example, the 9999 value is reached cunt will restart at 1. Next Number fr Username The value fr the next sequentially generated username. Predefined Users Use Predefined Users Enable predefined usernames. List f Users List f predefined and reusable usernames. Thse will be available frm the main app screen. This functin can be easily explained thrugh an example. Suppse we have a small htel with 10 rms. We want t assign an username t each rm and change the passwrd each time a new guest checks in. We shuld create a username list like this: Página 9 de 12

10 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Rm01 Rm02 Rm03 Rm10 On the main screen we will find a drp list with AUTO ptin and each f the defined usernames. If we chse AUTO the app wrk as usual, generating randm r sequential usernames. If we chse a predefined username, Rm03 as an example, and we push the desired prfile buttn, let s say 1week. Within this example we will get a ticket with Rm03 as username, fr 1 week and with a randm passwrd. If user Rm03 already exists in User Manager, it will be deleted and replaced with a newly created user. Printer The printer s sectin allws setting the cnnectin values t access the netwrk printer. It will als allw t setup the ticket/vucher s frmat. IP Address T set the address f the netwrk printer. Use its ip address r dns entry. In ur example deplyment we will use Prt The printer s TCP prt. Usually Página 10 de 12

11 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: Ticket The ticket parameter is a vertically scrllable field t set the full cntent f the ticket that will be send t the printer when creating an user. It s a text field with vertical scrll. An example f a ticket culd be smething like this: [C][LOGO] [B][U]HtSpt Infinitel" [L][b][u] [B]Acces: [b]${prfile} [B]Nmbre: [b]${user} [B]Clave: [b]${pass} [C][QR] [R][W][T]Thank yu [CUT] When editing the ticket we shuld specify the fllwing variables: ${prfile} will be filled with the prfile s name ${user} will be filled with the generated username ${pass} will be filled with the generated randm passwrd T set the frmat f the ticket we can use the fllwing tags: [B] Set bld text [b] Unset bld text [U] Set underlined text [u] Unset underlined text [T] Set duble tall text [t] Unset duble tall text [W] Set duble wide text Página 11 de 12

12 Avda. Ricard Curtys Gtarredna, 4 Lcal Santa Eulalia del Rí Teléfn Fax inf@infinitel.es - web: [w] Unset duble wide text [L] [l] Align t the left [C] [c] Align t center [R] [r] Align t the right [LOGO] Print the bitmap set t the psitin 1 f NV memry in the ESC/POS printer [CUT] Make paper cut (if supprted by the printer) [QR] Insert a QRCde that pens the htspt s captive prtal and redirect the user t a cnfigurable page after a successful lgin. QRCde The QRCde s sectin allws t enter the settings t include a QRCde in the printed utput. The QRCde pints t the htspt s captive prtal and autfills the username. When successfully lgged the user will be redirected t a specified url. HtSpt URL DNS r IP address URL f the htspt s gateway. Fr example: r Always as cnfigured in yur wn htspt deplyment. If blank, the [QR] tag n the ticket will be ignred. QRCde URL Redirectin The URL where the user will be redirected after a successful lgin. Fr example: If the parameter is left blank, the user will nt be redirected after lgin. The resulting QRCde, using ur example values, will generate the next url address: When using an QRCde decder n a mbile/table device the user will be send t the captive prtal, the username will be autmatically filled and when lgged successfully the brwser will be redirected t Página 12 de 12