Ojmar Nexo NLX1 User manual

E
S
P
INSTRUCTIONS MANUAL
VERSION 2.0
NEXO NLX1 SYSTEM

INSTRUCTIONS MANUAL
VERSION 1.0
NEXO NLX1 SYSTEM


This document is fo info mation only and is not cont actually binding.
The info mation may have unde gone changes that have not yet been inco po ated
in the p esent document and we the efo e suggest that if in doubt you please
contact Ojma to obtain updated info mation.
© Ojma , S.A.

OJMAR 5
CONTENTS

1.1 SYSTEM ELEMENTS ................................................................................ 8
1.2 OPERATION ........................................................................................... 9
1.3 GENERAL WARNINGS ........................................................................... 10
1.3.1 Regulato y info mation USA ..................................................................... 10
1.3.2 Class B device notice ............................................................................... 11
1.3.3 RF exposu e safety ................................................................................... 11
1.4 TECHNICAL SUPPORT .......................................................................... 11

2.1 SDK INSTALLATION ............................................................................. 12
2.1.1 Installation ................................................................................................ 12
2.2 PHYSICAL INSTALLATION OF THE ROUTER ........................................... 28
2.3 ASSEMBLY OF THE NEXO NLX1 LOCK ................................................... 28
2.3.1 Lock Di ection ........................................................................................... 29
2.3.2 Assembly Conside ations ......................................................................... 29
2.3.3 Steps to Follow fo Assembly.................................................................... 34

3.1 CENTRAL PC AND PCS IPS, NETWORK, ETC.) ........................................ 40
3.2 READER/PORTABLE PROGRAMMER ...................................................... 43
3.2.1 Ojma NFC Model P og amme ................................................................ 44
3.2.2 Desktop Reade ........................................................................................ 50
3.3 LOADING INITIALISATION DATA TO THE NFC PROGRAMMER ................ 51
3.4 INITIALISE LOCKS WITH NFC PROGRAMMER ......................................... 51
3.5 DESCRIPTION OF LED FLASHES .............................................................55
3.5.1 Lists .......................................................................................................... 56

4.1 FREE .................................................................................................... 58
4.2 FIXED ................................................................................................... 58
4.3 MASTER ............................................................................................... 58
4.4 SERVICE ............................................................................................... 59
4.5 DELETED .............................................................................................. 59

5.1 OPENING OF THE NEXO NLX1 LOCK USING EMERGENCY POWER SUPPLY
............................................................................................................ 60
5.2 EMERGENCY MECHANICAL OPENING OF THE NEXO NLX1 LOCK ............ 63
5.3 DISASSEMBLY OF THE NEXO NLX1 LOCK .............................................. 65
5.4 REQUEST FOR DATA: EVENTS, CYCLES, SETUP ..................................... 67


5.5 BATTERY REPLACEMENT ..................................................................... 68
5.6 CLEANING ............................................................................................ 69
5.7 FAQ ..................................................................................................... 71
5.8 DECLARATION OF CONFORMITY .......................................................... 72

6.1 PURPOSE OF THE DOCUMENT ...............................................................75
6.2 SYSTEM INTRODUCTION .......................................................................75
6.2.1 NEXO NLX1 Pa ticula ities ....................................................................... 76
6.3 API STRUCTURE OVERVIEW .................................................................. 78
6.3.1 Online Communications ............................................................................ 79
6.4 DOCUMENTATION PROVIDED .............................................................. 80
6.5 SYSTEMS WORKFLOW ......................................................................... 80
6.5.1 Device Configu ation ................................................................................ 80
6.5.2 Custome s´ usage .................................................................................... 81
6.5.3 Devices´ maintenance .............................................................................. 81
6.6 LOCK CONFIGURATION EXAMPLE ........................................................ 83
6.6.1 Configu ed by RFID ca ds fo OTS family ................................................ 83
6.6.2 Configu ed by NFC p og amme fo OTS family ....................................... 84
6.6.3 Set up via NFC fo Nexo NLX1 family ....................................................... 85
6.6.4 Configu ed via TCP/IP fo Nexo NLX1 family ........................................... 86

7.1 INTRODUCTION ................................................................................... 87
7.2 API REFERENCES INDEX ....................................................................... 88
7.3 API REFERENCES DEFINITIONS ............................................................. 89
7.3.1 Datamodel´s API ....................................................................................... 89
7.3.2 Reco de ´s API ....................................................................................... 121
7.3.3 Socket API .............................................................................................. 131
7.4 EXAMPLE OF HOW TO CONFIGURE LOCK FROM FACTORY MODE ........ 169
7.4.1 Lock Complete Configu ation.................................................................. 169
7.4.2 Use ca d equest ................................................................................... 172
7.5 CODE EXAMPLES ................................................................................. 174
7.5.1 PHP ........................................................................................................ 174
7.5.2 Java ........................................................................................................ 175
7.5.3 C ............................................................................................................. 177
7.6 ANEXO ................................................................................................ 179
7.6.1 Gene ate and ead JSON files ................................................................ 179
7.6.2 How to make a REST call ....................................................................... 180

8.1 PHYSICAL INSTALLATION OF THE ROUTER .......................................... 185

OJMAR 7
PAGE LEFT BLANK INTENTIONALLY



Nexo NLX1 is an elect onic locking system mainly designed fo spo ts and leisu e
cent es and schools. The system ope ates with RFID p oximity media (Wellness®
w istbands, ca ds and key) with technologies based on inte national standa ds.
The Nexo NLX1 system connects wi elessly to the cent al PC of the system and
that way can:
• Configu e the locks quickly and conveniently.
• Manage the status of the locke s in eal time.
Ret ofit coin locks a e ve y easy as they have the same ancho holes.
The locks comply with all standa ds ancho age and dimensions and the efo e the
old locking systems can be eplaced without having to change the cupboa ds o
locke s.
• NB.: The locks must be initialized befo ehand.
1.1SYSTEM ELEMENTS
The complete system consists of the following components:
• Nexus NLX1 Locks (Assembly in Section 2.3 and Disassembly in Section 5.3)
including the st ike plate (depends on the design of the locke )
• Wi-Fi Route (see Section 2.2).
• PC (see Section 3.1).
• Desktop eade fo media (Wellness® Key, ca ds, w istbands) and/o Ojma
NFC po table p og amme (see Section 3.2).
• Maintenance kit (see Section 4).
• Eme gency powe supply tool.
• Eme gency mechanical opening tool.API fo Management softwa e

 OJMAR 9
1.2OPERATION
To sta t up the Nexo NLX1 system, the steps detailed below must be followed:
1. Configu e the PC (see Section 3.1).
2. Configu e the oute (see Section 2.2).
3. Configu e the pa amete s of the NFC p og amme (IP, netwo k, locks...)
connecting it to the PC and using the softwa e (see Section 3.3).
4. Initialize each lock with the NFC p og amme . This is done only the fi st time,
fo the sta t-up of the system (see Section 3.4).
•NB.: Once initialized, the lock connects to the PC wi elessly, sending back signal
confi ming connection to the system
5. W ite the keys with the NFC p og amme o with the CNReade ca d eade
(see Section 4).
The e a e diffe ent types of keys; f ee use , fixed use , maste , se vice and
eset (see Section 4).
The system has two types of use :
•Use : The use opens o closes the locks with one o seve al keys acco ding to
the pe missions assigned to the use .
•Manage : Gives pe missions to the ca ds, administe s the keys that open the
locks and asks the locks fo info mation (see Section 5.4).
The system has two ope ating modes:
•On-line (no mal ope ation of the system):
Use ´s key makes contact with f ont pa t of the lock.
The lock info ms the PC that a ca d is t ying to open/close it.
The PC decides whethe to open/close the lock acco ding to the
pe missions that have been given to the use /key.
Afte pe fo ming the ope ation (allow opening/closing the lock o not), the
event is sent to the PC with the batte y level of the lock (see Section 5.4).
•NB.: The communication sta ts with the ca d o the p og amme ; the PC
cannot initiate communication.
•Off-line (when occasionally wi eless connection is not available):
The use puts the key in f ont of the f ont pa t of the lock.
The lock attempts to connect to the PC and, when it cannot, it acts
acco ding to the last configu ation it has eceived f om the latte when the
system was on-line.
When the connection is eset and it connec ts, the PC equests info mation
to the lock of what has happened du ing the time that it was off-line.


1.3GENERAL WARNINGS
To ensu e the co ect ope ation of ou p oduct in you facilities you must follow the
following ules:
•P oduct installation and use must be ca ied out in acco dance with the
technical ope ating conditions desc ibed in the co esponding manual.
•When not specifically indicated, the p ope installation and use of the
application is the esponsibility of the custome .
•Inspect the packaging and mate ial fo damage immediately afte eception
of the mate ial. Also check that the delive y is complete (accesso ies,
documentation, etc.).
•If the packaging has been damaged du ing t anspo t o you suspect that it
could have been damaged o may be faulty, the mate ial must not be
sta ted up. In this case, please contact us.
•Ou p oducts' installation and handling must be ca ied out by autho ised
staff. The elect ical connections in pa ticula must be ca ied out only by
qualified specialists.
•Any eplacement o emoval of the p otection cove s is st ictly fo bidden.
•Do not attempt to epai mate ials afte a fault o damage and t y to
ope ate it again. In such an event, it is essential you contact us.
•We take no esponsibility fo damage caused as the esult of misuse.
•Befo e leaving the devices in thei pick-up installations, the batte ies must
be emoved and left sepa ately fo the p ope management.
1.3.1Regulatory information USA
Changes o modifications not exp essly app oved by the pa ty esponsible fo
compliance could void the use ’s autho ity to ope ate the equipment.
This device complies with pa t 15 of the FCC Rules. Ope ation is subject to the
following two conditions: (1) This device may not cause ha mful inte fe ence, and
(2) this device must accept any inte fe ence eceived, including inte fe ence that
may cause undesi ed ope ation.

 OJMAR 11
1.3.2Class B device notice
Note: This equipment has been tested and found to comply with the limits fo a
Class B digital device, pu suant to pa t 15 of the FCC Rules. These limits a e
designed to p ovide easonable p otection against ha mful inte fe ence in a
esidential installation. This equipment gene ates, uses and can adiate adio
f equency ene gy and, if not installed and used in acco dance with the inst uctions,
may cause ha mful inte fe ence to adio communications. Howeve , the e is no
gua antee that inte fe ence will not occu in a pa ticula installation. If this
equipment does cause ha mful inte fe ence to adio o television eception, which
can be dete mined by tu ning the equipment off and on, the use is encou aged to
t y to co ect the inte fe ence by one o mo e of the following measu es:
- Reo ient o elocate the eceiving antenna.
- Inc ease the sepa ation between the equipment and eceive .
- Connect the equipment into an outlet on a ci cuit diffe ent f om that to which the
eceive is connected.
- Consult the deale o an expe ienced adio/TV technician fo help.
1.3.3RF exposure safety
This p oduct is a adio t ansmitte and eceive . The antenna must be installed and
operated with minimum distance of 20 cm between the radiator and your body.
It is designed not to exceed the emission limits fo exposu e to adio f equency
(RF) ene gy set by the Fede al Communications Commission.
This t ansmitte must not be co-located o ope ating in conjunction with any othe
antenna o t ansmitte .
1.4TECHNICAL SUPPORT
If you have any questions about ou p oducts, please contact the technical
depa tment of Ojma :
Telephone no.: [phone]
Fax: [phone]
Web: www.ojma .com


 
2.1SDK INSTALLATION
OJMAR’s API allows you to install both the d ive s of the NFC p og amme and of
the CNReade . The following documents a e also copied in the installation p ocess:
•OJM-PR-2015-085 API gene al ove view.pdf
•OJM-PR-2016-118 API efe ence manual.pdf
2.1.1Installation
The files you have eceived and which a e necessa y to pe fo m the installation a e
the following:
•Installe “Ojma API Installe .exe”.
•Installe licence file.
Follow the steps listed below to ca y out the installation:
• !"#$%!&"'(($): Run the file “Ojma API Installe .exe”, which will p ovide the
installe of the API.
Right click and select “ !'&'*+%!%&")'",)”.
This file decomp esses the installe and the j e to a folde .

 OJMAR 13
•$($-""#$*$&"%!'"%,!.,(*$): Select the folde whe e the files will be
decomp essed.
•Nb: If you did not select a destination folde , the files will be decomp essed
in the same folde as the sou ce file.
Click on "Install". The decomp ession will begin. Close the window when the
installation is complete.


The following files will appea in the selected folde :
•j e
•Ojma API.exe

 OJMAR 15
•!&"'(('"%,!,."#$: Run the file “Ojma API.exe” to sta t the installation of
the API. Right click and select “Run as administ ato ”.
•$($-"('!/ '/$: The fi st step must be to select the language. The following
two languages a e available:
English
Spanish
The installation p ocess will begin. Click “Next” to continue.


•$'*"#$%!.,)+'"%,!'!*'/)$$","#$"$)+&'!*-,!*%"%,!&: P ess “Next”
afte eading the available info mation.
In the next step, you must accept the te ms and conditions of the licence
ag eement to continue.

 OJMAR 17
• $($-""#$%!&"'(('"%,!.,(*$): Select the installation folde fo the API.
If the folde does not exist, a message will be displayed wa ning that the folde
will be c eated. P ess “Accept” to continue with the p ocess.


• $($-"0'-1'/$&",%!&"'((: The API module is equi ed but the installation of
the d ive s and documentation is optional.
The packages available a e as follows:
 Base: This is the API package. It is not optional.
 NFC: D ive s of the NFC p og amme . If selected, they will be installed
automatically.
 CNReade : Desktop eade d ive s. If selected, they will be copied to the
API folde . Follow the steps of the “)%2$)&$'*$)” section to install
them.
 Docs: Manuals. If selected, they will be copied to the API folde .

 OJMAR 19
• %-$!-$: You must select the licence file.
Sea ch fo the file in the folde that contains it and p ess “Next”.


•,!.%)+%!&"'(('"%,!: When you p ess “Next” the installation oute and the
packages that will be installed will be displayed. P ess “Next” to begin the
installation.
•!&"'(('"%,!0),-$&&: The installation p og ess will be displayed in a window.
Befo e finishing, the installation p ocess of the d ive s of the NFC p og amme
will be launched if it has been p eviously selected.