Ojmar Nexo NLX1 Instruction Manual Download

Page: 100 / 188

7_API REFERENCE MANUAL

Parameter of the request JSON file for the

OTS family

system:

Parameter

Mandatory

Data type

Possible values

lock_type

Yes

String

"OTS"

num_installation

Yes

String(4) hex

dedicated_locks

No (maximum 1

lock)

Array<Integer>

free_locks

No (maximum 3

locks)

Integer

From 0 to 3

subgroups

Yes for free locks

Array<Integer>

From 0 to 15

expiry_type

String

"no" or "endDate"

expiry_time

If expiry_type =

"endDate"

String

"HH:mm"

expiry_date

If expiry_type =

"endDate"

String

"dd/mm/yyyy"

prohibition

No (used only with

expiry date)

Integer

0 = no (default)1 =
closing forbidden2
= opening
forbidden3 = both
forbidden

time_zones

No (used only with

free locks)

Array

start_time

Yes

String

"HH:mm"

end_time

Yes

String

"dd/mm/yyyy"

weekdays

Yes

Array<Integer>

From 0 to 6
(Monday = 0,
Sunday = 6)

Summary of Contents for Nexo NLX1

Page 1: ...E S P INSTRUCTIONS MANUAL VERSION 2 0 NEXO NLX1 SYSTEM...

Page 2: ......

Page 3: ...INSTRUCTIONS MANUAL VERSION 1 0 NEXO NLX1 SYSTEM...

Page 4: ...y and is not contractually binding The information may have undergone changes that have not yet been incorporated in the present document and we therefore suggest that if in doubt you please contact O...

Page 5: ...o Follow for Assembly 34 3 START UP 40 3 1 CENTRAL PC AND PCS IPS NETWORK ETC 40 3 2 READER PORTABLE PROGRAMMER 43 3 2 1 Ojmar NFC Model Programmer 44 3 2 2 Desktop Reader 50 3 3 LOADING INITIALISATIO...

Page 6: ...r OTS family 83 6 6 2 Configured by NFC programmer for OTS family 84 6 6 3 Set up via NFC for Nexo NLX1 family 85 6 6 4 Configured via TCP IP for Nexo NLX1 family 86 7 API REFERENCE MANUAL 87 7 1 INTR...

Page 7: ...CONTENTSOJMAR 7 PAGE LEFT BLANK INTENTIONALLY...

Page 8: ...r holes The locks comply with all standards anchorage and dimensions and therefore the old locking systems can be replaced without having to change the cupboards or lockers NB The locks must be initia...

Page 9: ...es permissions to the cards administers the keys that open the locks and asks the locks for information see Section 5 4 The system has two operating modes On line normal operation of the system User s...

Page 10: ...st be carried out by authorised staff The electrical connections in particular must be carried out only by qualified specialists Any replacement or removal of the protection covers is strictly forbidd...

Page 11: ...to try to correct the interference by one or more of the following measures Reorient or relocate the receiving antenna Increase the separation between the equipment and receiver Connect the equipment...

Page 12: ...R 2016 118 API reference manual pdf 2 1 1 Installation The files you have received and which are necessary to perform the installation are the following Installer Ojmar API Installer exe Installer lic...

Page 13: ...lect the folder where the files will be decompressed Nb If you did not select a destination folder the files will be decompressed in the same folder as the source file Click on Install The decompressi...

Page 14: ...2_MANUAL DE INSTALACI N The following files will appear in the selected folder jre Ojmar API exe...

Page 15: ...mar API exe to start the installation of the API Right click and select Run as administrator Select language The first step must be to select the language The following two languages are available Eng...

Page 16: ...STALACI N Read the information and agree to the terms and conditions Press Next after reading the available information In the next step you must accept the terms and conditions of the licence agreeme...

Page 17: ...OJMAR 17 Select the installation folder Select the installation folder for the API If the folder does not exist a message will be displayed warning that the folder will be created Press Accept to con...

Page 18: ...lable are as follows Base This is the API package It is not optional NFC Drivers of the NFC programmer If selected they will be installed automatically CNReader Desktop reader drivers If selected they...

Page 19: ...2_MANUAL DE INSTALACI N OJMAR 19 Licence You must select the licence file Search for the file in the folder that contains it and press Next...

Page 20: ...packages that will be installed will be displayed Press Next to begin the installation Installation process The installation progress will be displayed in a window Before finishing the installation p...

Page 21: ...ACI N OJMAR 21 NFC Drivers An installation wizard will help you install the drivers Complete the installation When the progress of installation has finished press Next to install the shortcuts and com...

Page 22: ...These are copied to folder cnreader USBDriverV3 10 of the folder where the API has been installed The supplied drivers are supported for the following operating systems Windows XP 32 and 64 bits Windo...

Page 23: ...e computer 2 Windows will detect the programmer and displays the following messages 3 Windows will not be able to automatically install the Windows driver and therefore you will have to install it man...

Page 24: ...8 Press Browse and locate the Drivers Cnreader folder of the CD supplied by Ojmar 9 Confirm the driver installation clicking on the button Install 10 If the installation was successful the following s...

Page 25: ...t means that the driver was installed correctly Docs The manuals are copied in folder docs of the folder where the API has been installed Shortcuts In the last step you can create shortcuts to the app...

Page 26: ...2_MANUAL DE INSTALACI N From the start menu you can start the application or uninstall it The API can be started by double clicking on the shortcut on the desktop Run as administrator...

Page 27: ...to close the window Test the API You can test whether the API is running by opening the browser and going to the address below http localhost 8086 application wadl If the following xml is displayed it...

Page 28: ...in the corresponding user manual For the correct installation of the router see section 8 1 2 3 ASSEMBLY OF THE NEXO NLX1 LOCK The NEXO NLX1 lock can be installed on doors with thicknesses between 9 m...

Page 29: ...s between the different elements of the locker 2 3 2 Assembly Considerations The NEXO NLX1 lock is fixed to the locker door with four screws Recommended screws Conglomerate doors Countersunk coach nut...

Page 30: ...2_MANUAL DE INSTALACI N 2 3 2 1 Strike with reinforcement Figure 2 2 Measurements of the strike with reinforcement in mm inches Figure 1 of 2...

Page 31: ...2_MANUAL DE INSTALACI N OJMAR 31 Figure 2 2 Measurements of the strike with reinforcement in mm inches Figure 2 of 2...

Page 32: ...2_MANUAL DE INSTALACI N 2 3 2 2 Smooth strike with channel in the body of the locker Figure 2 3 Measurements of the smooth strike in mm inches Figure 1 of 2...

Page 33: ...2_MANUAL DE INSTALACI N OJMAR 33 Figure 2 3 Measurements of the smooth strike in mm inches Figure 2 of 2...

Page 34: ...this order 1 Mark the holes according to Figure 2 4 2 Drill the central hole of 23 0 1 0 3 If necessary drill the holes to fasten the lock 4 Screw the lock with four fixing screws Ensure that the pla...

Page 35: ...cover onto the lock 6 Assembly of the led viewer a Clean the surface of the door and make sure it is dry b Peel off the plastic film from the emblem c Insert front panel bulge in the hole connecting o...

Page 36: ..._MANUAL DE INSTALACI N d Press the front panel firmly so that it is correctly stuck in the door e Remove the protective film from the front panel 7 Remove plastic strip from the bottom side of the loc...

Page 37: ...to be used check the measurements shown in designs 1 2 and 1 3 Checking the correct position of the locking device a Once the locking device has been tightened check that the lock can be opened and c...

Page 38: ...2_MANUAL DE INSTALACI N POSITION RIGHT LOCK MOUNTING HOLES POSITION LEFT LOCK MOUNTING HOLES Figure 2 4 Measurements in mm inches...

Page 39: ...2_MANUAL DE INSTALACI N OJMAR 39 PAGE LEFT BLANK INTENTIONALLY...

Page 40: ...to the system must have a unique IP address configured and to do this we need to modify the parameters of the network 1 Access the network and sharing center in the computer s control panel The images...

Page 41: ...3_PUESTA EN MARCHA OJMAR 41 2 Press Change adapter settings 3 Right click the network card and select Properties...

Page 42: ...3_PUESTA EN MARCHA 4 Select Internet Protocol version 4 and press properties 5 You must then complete the following information and click OK...

Page 43: ...router PCs mobile phones tablets etc Subnetwork mask By default 255 255 255 0 If you want to manage more than 255 devices change the subnet mask Gateway IP address of the router 3 2 READER PORTABLE PR...

Page 44: ...locks NB Each time an operation is performed between the NFC programmer and the lock the programmer updates the time of the lock FRONT VIEW RIGHT SIDE VIEW FRONT VIEW 1 Touch screen 2 Card wristband...

Page 45: ...de of use with SW Write Read all kinds of Classic Mifare OTS cards 1k 4k 4B or 7B and Technogym Load the desired configuration in the lock Update the configuration in the lock Synchronisation with the...

Page 46: ...e and the time of the programmer This is the information that will be used for recording locks and cards wristbands 5 Battery level Displays programmer s battery level NB The level of the battery is s...

Page 47: ...g screen When the card wristband is put on the reading area the programmer the information associated with this will be displayed 2 Write card wristband Records on the card wristband the configuration...

Page 48: ...u for the locks of type NEXO NLX1 Initialize This menu option allows initialising locks Configure This menu option allows configuring locks To do so Press Initialize Press Set lock Select a lock previ...

Page 49: ...f the screen 2 Version Shows the software version number currently installed in the programmer 3 Auto power off When you turn this button on the programmer screen will turn off automatically after app...

Page 50: ...reading and recording keys using the installation s Management Software NB The desktop reader cannot connect directly with the locks It must be connected to the computer via the USB port and use the...

Page 51: ...nge 10 to 50 non condensing Approx weight 83g APPROXIMATE DIMENSIONS Outer length x width x height 116 x 67 x 14 mm 3 3 LOADING INITIALISATION DATA TO THE NFC PROGRAMMER See section 7 3 1 1 Initialisa...

Page 52: ...3_PUESTA EN MARCHA 2 Press button OTS Online 3 Press button Initialize 4 Pressing the top button you can choose between initialising all locks even or odd locks...

Page 53: ...3_PUESTA EN MARCHA OJMAR 53 5 Press button Continue 6 Hold the programmer in front of the led viewer symbol as shown in the following picture See the progress in the progress bar of the programmer...

Page 54: ...orded correctly 8 The PC sends the configuration data using wireless communication to the lock 9 The lock beeps 3 times and the green led lights up 3 times confirming that it has received the configur...

Page 55: ...No Rejected key Reading Not OK Impossible to open for whatever reason Details in NFC programmer and events AMBER 3x short No Detection low battery AMBER 1x long No Definitive low battery It ceases to...

Page 56: ...eir opening and closing the locks of the system have user lists White list Users who are on this list will be able to operate with the lock in question Black list Users who are on this list will not b...

Page 57: ...3_PUESTA EN MARCHA OJMAR 57 PAGE LEFT BLANK INTENTIONALLY...

Page 58: ...er EXAMPLE A gym member reserves a locker and only he she can use it Only fixed cards will have access to the assigned lock For each Fixed lock you can create as many cards as you like and all of them...

Page 59: ...each installation If you want an additional service key contact Ojmar NB For exclusive use of the facility s staff 4 5 DELETED This key allows deleting all the information of the lock and returning it...

Page 60: ...nd the condition of the batteries has not been checked the locker may be in the closed position and the lock has run out of batteries By bringing the key or master or service key close the lock does n...

Page 61: ...power supply tool in the hole of the door until the two pins make contact with lock s pins This way we power the lock and with a user key master key or service key placing it under the hole in the doo...

Page 62: ...5_MANUAL DE MANTENIMIENTO 1 2 3 User key master or service 4...

Page 63: ...carried out the steps in Section 5 1 and it still cannot be opened proceed as follows 1 Remove frontal display display See point 1 of Section 5 1 2 Once removed pick up the emergency mechanical openi...

Page 64: ...sure that the emergency opening tool is aligned with the door not in an angle With a drill and 10 mm bit insert the bit into the hole of 10 mm and drill to make a hole in the lock Bit 10 mm Hole 10 m...

Page 65: ...a right lock or to the left if it is a left lock The internal mechanism of the lock will move releasing the locker door 5 3 DISASSEMBLY OF THE NEXO NLX1 LOCK The steps to follow to disassemble a NEXO...

Page 66: ...NTO 3 Remove the cover To do this with the flat side of the key supplied by Ojmar push the clip of the cover upwards that is on the gap on the battery holder This clip is located in the central part o...

Page 67: ...unclipping the cover use the angular area of the key to push the cover and remove it from the lock 5 Attach the battery holder with the two screws 6 Loosen the 4 screws of the lock 5 4 REQUEST FOR DAT...

Page 68: ...se of change to a different type of battery Move those batteries away according to the instructions given The steps to be followed to replace the batteries are as follows 1 Loosen the two screws on th...

Page 69: ...continue use in damp environments it must adhere to the following guidelines for proper maintenance of the same Clean it with a soft damp cloth do not use any detergent product and then dry it comple...

Page 70: ...5_MANUAL DE MANTENIMIENTO...

Page 71: ...r Make a ping to the PC The lock does not open The lock is occupied by another key Pass the master key Red and check that it has released correctly closing and opening the lock with a free user key Th...

Page 72: ...Radio spectrum matters ERM Electromagnetic Compatibility EMC Standard for radio equipment and services Part 3 Specific Conditions for Short Range Devices SRDS operating on frequencies between 9 KHz a...

Page 73: ...5_MANUAL DE MANTENIMIENTO OJMAR 73 Short Range Devices SRD Close Range Inductive Data Communication equipment operating at 13 56 MHz Part 2 Harmonized EN under article 3 2 of the R TTE Directive...

Page 74: ...5_MANUAL DE MANTENIMIENTO PAGE LEFT BLANK INTENTIONALLY...

Page 75: ...NFC programmer a wireless network and the locks There will be also a 3rd party software that uses the API This software is out of the scope of this document There is also an Ojmar SW available except...

Page 76: ...C programmer or the desktop programmer 6 2 1 NEXO NLX1 Particularities This lock can work in both online and offline mode simultaneously When it is in online mode and has access to the server the lock...

Page 77: ...es limitations Online operations Up to 36 different profiles can be uploaded per lock Last 10 events can be viewed per communication Just one information request can be asked per communication Offline...

Page 78: ...Windows Linux and OS X The API interface is implemented by means of JSON REST Webservices which warranties a great compatibility with any programming language that includes JSON REST Support There ar...

Page 79: ...ly a frame must be created using the Datamodel API at the end it is like a translation from human language to lock language and after that it is decided where to send that information Desktop reader o...

Page 80: ...nctions can be used for the configuration of these devices 6 5 1 1 Configuration frames Frame for initialization Sets the basic network lock number and facility information Used only for Nexo NLX1 fam...

Page 81: ...configured cards for the final users can be written The following function is used for this purpose Frame for user simple card Creates a frame for a user card that will manage occasional or dedicated...

Page 82: ...the OTS family Frame for reset card Send a configured lock to default status to non configured lock Frame for subgroup master card If more than one subgroup is used and different level of maintenances...

Page 83: ...0000000000000000000 Once the frame is received it has to be decided where it is going to be written the card by Desktop reader or NFC Programmer So following html rest petition is made http localhost...

Page 84: ...000000000000000000000000000 And following response with be received ending the setup card write result ok data_ots Card write ok uid 00000011223344 6 6 2 Configured by NFC programmer for OTS family If...

Page 85: ...eSystem password A1A2A3A4 encrypt_type 2 server_ip 192 168 1 97 initial_ip 192 168 1 100 gateway_ip 192 168 1 10 range 1 50 mask 255 255 255 0 first_num_lock 1 last_num_lock 50 group 0 target pp And t...

Page 86: ...n The API receives the request translates it to JSON and forwards it to the 3rd party SW socket profiles uid 000000D4817BAA mem_uid 00000000000000 lock_status A L num_installation B1B2 num_subinstalla...

Page 87: ...eripherals including functions to write and read cards and all the NFC programmer functions 3 Socket API The API implements a mechanism based on sockets to receive information from the locks and to se...

Page 88: ...card Creates a frame that sets the access rightsaccess rights of a user Datamodel Both Custom user card Creates a frame that sets custom access rights of a user Datamodel Both Cancellation card Create...

Page 89: ...pdates the Nexo NLX1 FW Recorder Nexo NLX1 Update NFC programmer FW Updates the NFC programmer Fw Recorder Nexo NLX1 Asynchronous port configuration Defines the TCP IP port communication Socket Nexo N...

Page 90: ...s String 4 hex Provided by Ojmar num_subinstallation Yes String 2 hex ssid Yes String password Yes String encrypt_type Yes Integer From 0 to 8 server_ip Yes String initial_ip Yes String gateway_ip Yes...

Page 91: ...55 255 255 0 first_num_lock 1 last_num_lock 50 group 1 target pp JSON response result ok data 00051111B1B2C2098D020A0401000001000032B1B2030A04010000010000 32111104090401000001000032C2050B0401000001000...

Page 92: ...e Possible values lock_type Yes String OTS online num_installation Yes String 4 hex Provided by Ojmar num_subinstallation For Nexo NLX1 String 2 hex first_num_lock Yes Integer From 0 to 65534 last_num...

Page 93: ...t_num_lock 73 mode free card_model_setup classic subgroup 2 JSON response result ok data 666600000D840200000000000000000000000049000032F0000000000000 000000000000000000000000000000000000 Nexo NLX1 fam...

Page 94: ...ME SET Definition JSON file is sent by POST with the necessary information time setting of the lock Can be used for OTS family Nexo NLX1 family NOTE The computer where the OjmarAPI is serving must be...

Page 95: ...response result ok data 6666000030000000000000000000000000000000093619160815031E0000 000000000000000000000000000000000000 Nexo NLX1 family JSON request lock_type online num_installation 6666 num_subi...

Page 96: ...rialization timeExchangesCard Parameter Mandatory Data type Possible values lock_type Yes String OTS num_installation Yes String 4 hex time_advances No maximum 5 dates Array String dd mm yyyy time_del...

Page 97: ...y POST with the necessary information for the configuration of the automatic opening that will happen every day Only available for the OTS family Parameters POST http localhost 8086 serialization auto...

Page 98: ...the creation of a simple frame for user cards Available for OTS family Nexo NLX1 Parameters POST http localhost 8086 serialization userSimpleCard Parameter Mandatory Data type Possible values lock_ty...

Page 99: ...sponse result ok data 0005111122228901248400000104FFFFFF04FFFFFF04FFFFFF04FFFFFF04 FFFFFF04FFFFFF04FFFFFF04FFFFFF03065100006100000A03010800FE02A 490 7 3 1 2 2 FRAMES FOR CUSTOM USER CARD Definition JS...

Page 100: ...0 to 3 subgroups Yes for free locks Array Integer From 0 to 15 expiry_type No String no or endDate expiry_time If expiry_type endDate String HH mm expiry_date If expiry_type endDate String dd mm yyyy...

Page 101: ...tring HH mm expiry_date If expiry_type endDate String dd mm yyyy start_expiry_time If expiry_type endDate String HH mm start_expiry_date If expiry_type endDate String dd mm yyyy uses If expiry_type us...

Page 102: ...Boolean calendar If holidays true Array Boolean size 368 group Yes Integer From 0 to 255 start_range Yes Integer From 0 to 65534 end_range Yes Integer From 0 to 65534 time_zone No only 1 admitted Arr...

Page 103: ...bition 3 time_zones start_time 09 30 end_time 17 30 weekdays 0 1 2 3 4 JSON response result ok data 6666FDFC3600000000000000009A07440000000080FFFF6E80FFFF8080FF FF8026460700000000000000000000000067 JS...

Page 104: ...09 30 end_time 17 30 weekdays 0 1 2 3 4 JSON response result ok data 6666FF3F3300000000000038009B87440000000080FFFF1380FFFF800000 000026460700000000000000000000000067 Example for Nexo NLX1 family JSO...

Page 105: ...1 2015 end_time 17 30 end_date 01 01 2016 weekdays 0 1 2 3 4 group 1 start_range 1 end_range 10 time_zones start_time 09 30 start_date 01 01 2015 end_time 17 30 end_date 01 01 2016 weekdays 0 1 2 3 4...

Page 106: ...http localhost 8086 serialization cancellationCard Parameter of the request JSON file Parameter Mandatory Data type Possible values lock_type Yes String OTS online num_installation Yes String 4 hex n...

Page 107: ...data 666600000A0000000000000000000000112233440000004E000000000000 000000000000000000000000000000000000 Examples for Nexo NLX1 JSON request lock_type online num_installation 1234 num_subinstallation 3...

Page 108: ...Parameters POST http localhost 8086 serialization masterCard Parameter Mandatory Data type Possible values password Yes String Level1 and Level2 password lock_type Yes String OTS online num_installati...

Page 109: ...ent by POST with the information necessary for creating a service card that is able to open and close every lock from an installation Available for OTS family and Nexo NLX1 family Parameters POST http...

Page 110: ...ock_type OTS num_installation 6666 JSON response result ok data 666600000800000000000000000000000000000000000008000000000000 000000000000000000000000000000000000 Example for Nexo NLX1 family JSON requ...

Page 111: ...the request JSON file Parameter Mandatory Data type Possible values lock_type Yes String OTS online num_installation Yes String 4 hex num_subinstallation For the Nexo NLX1 String 2 hex bt No For the N...

Page 112: ...000000000000000000000001000000000000 000000000000000000000000000000000000 Example for Nexo NLX1 family JSON request lock_type online num_installation 6666 num_subinstallation 33 bcb false bc false bzl...

Page 113: ...by POST with the information necessary for creating a test card that open and closes any factory mode lock Only available for OTS family Parameters POST http localhost 8086 serialization testCard Par...

Page 114: ...ting an events card that can download 3 events from the lock Available for OTS family Parameters POST http localhost 8086 serialization eventsCard JSON file is sent by POST with the information necess...

Page 115: ...hat open and close any lock from a subgroup Only available for OTS family Parameters POST http localhost 8086 serialization subgroupMasterCard JSON file is sent by POST with the information necessary...

Page 116: ...ly with free locks Array start_time Yes String HH mm end_time Yes String dd mm yyyy weekdays Yes Array Integer From 0 to 6 Monday 0 Sunday 6 Response OK result ok data XXXXX XXXX Response NOK result e...

Page 117: ...POST with the frame to decode and return a JSON file with the object information described in the card Available for OTS family and Nexo NLX1 family Parameters POST http localhost 8086 serialization d...

Page 118: ...uest frame 00051111666633098D020A04010000010000326666030A040100 000100003211110409040100000100003233050B0401000001000032FFFFF F145B04010000010000324F6E6C696E6553797374656D0000000000000000 000000000000...

Page 119: ...e is sent by POST with the frame to decode and return a JSON file with events described in the card Only available for OTS family Parameters POST http localhost 8086 serialization getEvents Parameter...

Page 120: ...431C807A87 32881004791AA1 431C807A87328800000000 JSON response result ok card_type events_card num_installation 6666 num_lock 3 events num_lock 3 event_code 10 UID 04791AA1431C80 date 2014 05 15 12 34...

Page 121: ...r the NFC programmer for OTS family Nexo NLX1 family Parameters MULTIPART FORM POST http localhost 8086 nfc setPort Request POST parameters Parameter Mandatory Data type Possible values port Yes Text...

Page 122: ...e in order to translate the information of the received frame Parameters GET http localhost 8086 card read reader_type card_model Request GET parameters Parameter Mandatory Data type Possible values r...

Page 123: ...000000000000000000000 0000000000000000000000000000000000000000000000000000000000000 0000000000000000000000000000000000000000000000000000000000000 000000000000000000000000000000000000000000000000000000...

Page 124: ...card_model classic frame 00051111666633098D020A04010000010000326666030A040100 000100003211110409040100000100003233050B040100000100003200000 1145B0401000001000032496E616B6954657374000000000000000000000...

Page 125: ...he blacklist Only available for OTS family Parameters POST http localhost 8086 nfc writeInitialization Parameter of the request JSON file Parameter Mandatory Data type Possible values Locks Yes Array...

Page 126: ...ipart form is sent by POST with the data to update the configuration data of the locks to the programmer Available for the Nexo NLX1 family NOTE Use the Initialization frame web service or the setupCa...

Page 127: ...401000001 0000490169B89D9CB8D180C969B89D9CB8D180C9090F04010000010000490 4A0A1A2A3A4A5090F04010000010000490500008627C10A0A030108000B02 8021 JSON response result ok data Ok 7 3 2 3 2 LOCK MAINTENANCE Ge...

Page 128: ...3 event_code 12 UID 04791AA1431C80 date 2014 05 15 12 34 00 num_lock 3 event_code 10 UID 04791AA1431C80 date 2014 05 15 12 34 00 Firmware update Update the FW of the OTS real time Definition Multipar...

Page 129: ...part form is sent by POST with the data that updates the Firmware of the OTS Advance From OTS family lock NOTE Firmware version must be asked to Ojmar S A Parameters MULTIPART FORM POST http localhost...

Page 130: ...RT FORM POST http localhost 8086 nfc reprogramOTSOnlineLockFw Parameter Mandatory Data type Possible values file Yes File bin exe version Yes String X X X Response OK result ok data Ok Response NOK re...

Page 131: ...locks and determine whether a card should be able to operate with a lock in each situation This scenario presents an asynchronous communication where the connection can be started by the lock in any...

Page 132: ...locks API by defect connect to port number 7777 Parameters GET http localhost 8086 online setPort port_num Request GET parameters Parameter Mandatory Data type Possible values port_num Yes Integer Re...

Page 133: ...h following parameters Parameter Mandatory Data type Possible values profiles Yes Array Int uid Yes String Approached card s UID mem_uid Yes String UID that lock has in its memory lock_status Yes Arra...

Page 134: ...l send a request to the API The API will receive the request and forward it to the socket where the 3rd party SW will be listening If the SW detects that it is the first time receiving information fro...

Page 135: ...n Yes String Lock installation number num_subinstallation Yes String Lock subinstallation number dedicated_locks Yes Array Int Dedicated locks that the user will have access rights to free_locks Yes I...

Page 136: ...able to answer if the lock is able to open or close with that card by answering the request with the following JSON Parameters Parameter Mandatory Data type Possible values num_installation Yes Strin...

Page 137: ...stallation 33 locks lock_request true lock_response false num_lock 1 3rd party SW answer JSON num_installation 2222 num_subinstallation 33 dedicated_locks 1 free_locks 1 Example that will not open clo...

Page 138: ...G CUSTOM ALLOWEMENT Definition 3rd party SW will be able to answer if the lock is able to open or close giving to the user custom access rights Parameters Parameter Mandatory Data type Possible values...

Page 139: ...he user will be checked in the black list If offline Examples Lock request JSON profiles uid 000000D4817BAA mem_uid 00000000000000 lock_status A L num_installation 2222 num_subinstallation 33 locks lo...

Page 140: ...ration more than one lock configuration can be sent at the same time Up to 252 bytes Opening closing change lock s installation number Definition 3rd party SW will be able to answer if the lock is abl...

Page 141: ...String Lock s new installation number Example Lock request JSON profiles uid 000000D4817BAA mem_uid 000000D4817BAA lock_status C O num_installation B1B2 num_subinstallation C2 locks lock_request true...

Page 142: ...num_subinstallation Yes String Lock subinstallation number dedicated_locks Yes Array Int Dedicated locks that the user will have access rights to free_locks No Int Number of occasional locks that the...

Page 143: ..._subinstallation DE group 1 range_from 1 range_to 100 Opening closing change lock s number Definition 3rd party SW will be able to answer if the lock is able to open or close with that card by answeri...

Page 144: ...group Yes Int Group of locks that will be affected From 1 to 254 num_lock Yes Int Lock s new number Example Lock request JSON profiles uid 000000D4817BAA mem_uid 000000D4817BAA lock_status C O num_in...

Page 145: ...r Mandatory Data type Possible values num_installation Yes String Lock installation number num_subinstallation Yes String Lock subinstallation number dedicated_locks Yes Array Int Dedicated locks that...

Page 146: ...from 1 range_to 100 Opening closing white black list management Definition 3rd party SW will be able to answer if the lock is able to open or close with that card by answering the request with the fol...

Page 147: ...From 1 to 254 range_from Yes Int Initial lock number that will be affected From 1 to 65534 range_to Yes Int Last lock number that will be affected From 1 to 65534 items Yes Array uid Yes String 7 byte...

Page 148: ...ning closing lock reset Definition 3rd party SW will be able to answer if the lock is able to open or close with that card by answering the request with the following JSON plus restoring the lock to f...

Page 149: ...534 range_to Yes Int Last lock number that will be affected From 1 to 65534 options Yes String BT Example Lock request JSON profiles uid 000000AABBCCDD mem_uid 00000000000000 lock_status A L num_insta...

Page 150: ...7_API REFERENCE MANUAL options BT group 1 range_from 1 range_to 100...

Page 151: ...ering the request with the following JSON plus requesting the information concerning the installation and subinstallation of the lock Parameters Parameter Mandatory Data type Possible values num_insta...

Page 152: ...num_lock 1 num_installation 2222 num_subinstallation 33 dedicated_locks 2 free_locks 3 profiles request_data media serial_port get_inst_subinst true group 1 range_from 1 range_to 100 Opening closing...

Page 153: ...that the user will have access rights to free_locks No Int Number of occasional locks that the user will have access rights to profiles Yes Array Int request_data Yes Array media Yes String serial_po...

Page 154: ...ck 8 num_installation 2222 num_subinstallation 33 dedicated_locks 2 free_locks 3 profiles request_data media serial_port get_num_lock_group true group 1 range_from 1 range_to 100 Opening closing lock...

Page 155: ...sional locks that the user will have access rights to Profiles Yes Array Int request_data Yes Array media Yes String serial_port group Yes Int Group of locks that will be affected From 1 to 254 range_...

Page 156: ...lock is able to open or close with that card by answering the request with the following JSON receiving the last events that happened in the lock Parameters Parameter Mandatory Data type Possible val...

Page 157: ...ected From 1 to 65534 range_to Yes Int Last lock number that will be affected From 1 to 65534 get_log Yes Array n_events Yes Int 1 10 Example Lock request JSON profiles uid 65849301223344 mem_uid 6584...

Page 158: ...eter Mandatory Data type Possible values num_installation Yes String Lock installation number num_subinstallation Yes String Lock subinstallation number dedicated_locks Yes Array Int Dedicated locks t...

Page 159: ...ible values that will be affected From 1 to 65534 get_n_cycle Yes Boolean Example Lock request JSON profiles uid 000000BCDEFABC mem_uid 00000000000000 lock_status A L num_installation 2222 num_subinst...

Page 160: ...r close with that card by answering the request with the following JSON plus requesting the complete configuration of the lock Parameters Parameter Mandatory Data type Possible values num_installation...

Page 161: ...Int Last lock number that will be affected From 1 to 65534 read_public_information Yes Boolean Example Lock request JSON profiles uid 000000BCDEFABC mem_uid 00000000000000 lock_status A L num_install...

Page 162: ...lways answer the last event that happened in the lock that includes event type uid that performed the action time and date that happened Parameters A JSON structure will be received by TCP IP with fol...

Page 163: ...meter Mandatory Data type Possible values Log_items Yes Array log_item Yes Array string Timestamp Yes String Unix format eventCode Yes String Event code description See Annex battery_status Yes String...

Page 164: ...g_items Yes Array log_item Yes Array string Timestamp Yes String Unix format eventCode Yes String Event code description See Annex battery_status Yes String of battery level InformationRequest Yes Arr...

Page 165: ...nnex battery_status Yes String of battery level Per number of events Example logItems LogItem timestamp 1476888500 uid 00000000000000 eventCode EventType ALARM_CAM_FORCED 96 batteryStatus 100 commands...

Page 166: ...elChk checksum 50397 log overwrite false size 69 events date 1476888 500 event_code 6 0 uid 00000000000000 battery_status 100 date 14768 88501 event_code 12 uid 00000667BE4404 battery_status 73 date 1...

Page 167: ...ize 69 logItems LogItem timestamp 1476888906 uid 00000667BE4404 eventCode EventType USER_OPEN 16 batteryStatus 73 commands CommandCont ainer commands InformationRequest information NumberOfCyclesRespo...

Page 168: ...d 00000667BE4404 eventCode EventType USER_CLOSE 18 batteryStatus 73 commands CommandCon tainer commands InformationRequest information ReadPublicConfigurationRespons e integrator 0 inst 0 subinst 0 ti...

Page 169: ...wing data will be introduced POST http localhost 8086 initialization initData JSON request num_installation B1B2 num_subinstallation C2 ssid OnlineSystem password A1A2A3A4 encrypt_type 2 server_ip 192...

Page 170: ...0000000000000000000000000000 00000000000000000002C0A80161C0A80164C0A8010A0132FFFFFF000A030 10800FE02411D JSON response result ok data Ok So initialization data has been uploaded to the programmer 7 4...

Page 171: ..._lists group 1 range_from 0 range_to 1 items uid 94FC6B4A action add list_type white uid B4512B4A action add list_type white set_time group 1 range_from 0 range_to 1 profiles null num_installation B1B...

Page 172: ...t ok data 00051111B1B2C201248400000104FFFFFF04FFFFFF04FFFFFF04FFFFFF04 FFFFFF04FFFFFF04FFFFFF04FFFFFF03065100006100000A03010800FE02A 490 POST http localhost 8086 card write JSON request http localhost...

Page 173: ...ock_request true lock_response false num_lock 1 The third party software reads the JSON and sends the following JSON closing the lock and requesting logs num_lock 1 config false request_data group 1 r...

Page 174: ...0 uid 000094FC6B4A04 battery_status 33 num_installation 2222 num_subinstallation 33 locks lock_type free num_lock 1 lock_request false lock_response false num_lock 0 7 5 CODE EXAMPLES 7 5 1 PHP Create...

Page 175: ...er sockets socket_close sock 7 5 2 Java public class TcpExample private Socket socket public static void main String args Port is assumed to come as first argument Socket socket new Socket 127 0 0 1 a...

Page 176: ...of bounds start Other checks if needed May be better to save the streams in the support class just like the socket variable OutputStream out socket getOutputStream DataOutputStream dos new DataOutputS...

Page 177: ...endpoint for the socket This example uses port 7777 on the local computer IPHostEntry ipHostInfo Dns Resolve Dns GetHostName IPAddress ipAddress ipHostInfo AddressList 0 IPEndPoint remoteEP new IPEnd...

Page 178: ...C3D4 E5 Send the data through the socket int bytesSent sender Send whitelist Release the socket sender Shutdown SocketShutdown Both sender Close catch ArgumentNullException ane Console WriteLine Argum...

Page 179: ...512 Example php arr array a 1 b 2 c 3 d 4 e 5 echo json_encode arr The above example would be a 1 b 2 c 3 d 4 e 5 PHP has another function to decode JSON string and return an array mixed json_decode...

Page 180: ...back to object DataObject obj gson fromJson br DataObject class 7 6 1 3 C In C it is posible to create a JSON string from an object var jsonSerializer new System Web Script Serialization JavaScriptSe...

Page 181: ...TURNTRANSFER true curl_setopt curl CURLOPT_CUSTOMREQUEST POST curl_setopt curl CURLOPT_POSTFIELDS jsonString curl_setopt curl CURLOPT_HTTPHEADER array Content Type application json curl_response curl_...

Page 182: ...me iPad 4 OutputStream os conn getOutputStream os write input getBytes os flush if conn getResponseCode HttpURLConnection HTTP_CREATED throw new RuntimeException Failed HTTP error code conn getRespons...

Page 183: ...Verb i e GET POST simply use the provided HttpVerb enumeration Here is an expample of making a POST request var client new RestClient endpoint endPoint method HttpVerb POST postData someValueToPost Th...

Page 184: ...7_API REFERENCE MANUAL PAGE LEFT BLANK INTENTIONALLY...

Page 185: ...onnect the router to the mains and Ethernet connection is also necessary The best position of the router is on the ceiling in front of the locks this position depends on the layout of the lockers in t...

Page 186: ...7_API REFERENCE MANUAL Option b...

Page 187: ...7_API REFERENCE MANUAL OJMAR 187 Option c INSTALLING ONE ROUTER PER 50 LOCKS IS RECOMMENDED...

Page 188: ...7_API REFERENCE MANUAL...

Search results

Summary of Contents for Nexo NLX1

Reviews:

Related manuals for Nexo NLX1

Brands by name

Popular brands

Ojmar Nexo NLX1, Instruction Manual

Search results

Summary of Contents for Nexo NLX1

Reviews:

Related manuals for Nexo NLX1

Brands by name

Popular brands