OJMAR OJM002 Electro-mechanic lock User Manual Sistema Nexo NLX1 vxx EN
OJMAR S.A. Electro-mechanic lock Sistema Nexo NLX1 vxx EN
UserManual.wiki
>
OJMAR
>
OJM002 User Manual
>
User manual - v2
Contents
1.
User manual - v2
2.
User manual - v2.1
User manual - v2
Navigation menu
Upload a User Manual
Namespaces
Wiki Guide
HTML
PDF
Info
Views
User Manual
Discussion / Help
Navigation
![ "card_model_setup":"classic", "subgroup":2} And the answer shown is: {"result": "ok", "data": "666600000D800200000000000000000000000049000001C7000000000000000000000000000000000000000000000000"} Once received the frame, the information is written to the card in the same way as the set time card. http://localhost:8086/card/write with following body: {"reader_type":"cnreader", "card_model":"desfire", "frame": "666600000D800200000000000000000000000049000001C7000000000000000000000000000000000000000000000000"} And following response with be received, ending the setup card write: {"result": "ok", "data_ots": "Card write ok", "uid": "00000011223344"} 6.6.2Configured by NFC programmer for OTS family If configuration is made via NFC programmer it can be done in only one step (Second part of the API). The following url should be typed: http://localhost:8086/nfc/writeInitialization with following body: {"locks":[ {"type":"free", "number":53, "facilityNumber":"6666", "subgroup":1, "config":"", "dst_advances":"","dst_delays":""}, {"type":"dedicated", "number":1, "facilityNumber":"2222", "subgroup":0, "config":"", "dst_advances":"","dst_delays":""} ], "blacklist":["12345678"]} And following response will be given: {"result": "ok", "data": "Init data write ok" }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-84.png)
![ 6.6.4Configured via TCP/IP for Nexo NLX1 family Once the programmer has the initialization frame, we can place the NFC programmer in a stock factory lock. After that, the lock will get connected to the wireless network and send a request packet to the API at the IP passed in the initialization. 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_subinstallation":"01", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1 } The SW will check that the lock number 1 has pending configuration and will respond with the config flag enabled: { "num_lock": 1, "config": true, "num_installation": "B1B2", "num_subinstallation": "01", "dedicated_locks": [], "free_locks": 3, "profiles": [] } The lock has been configured.](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-86.png)
![ 7.3.1.1.4 FRAME FOR TIME EXCHANGES Definition JSON file is sent by POST with the necessary information for the next 5 time advances and 5 time delays. Can be used for the OTS family. Parameters POST http://localhost:8086/serialization/timeExchangesCard Parameter Mandatory Data type Possible values (,-1"<0$ K$& ")%!/ MM! +%!&"'(('"%,! K$& ")%!/9;#$6 "%+$'*2'!-$& ,9+'6%+ +*'"$&;))'<N")%!/O PM**8++8<<<<MQ"%+$*$('<& ,9+'6%+ +*'"$&;))'<N")%!/O PM**8++8<<<<MQ Response OK: { "result": "ok", "data": "XXXXX...XXXX" } Response NOK: { "result": "error", "code":"-1", "message":"...." } Example JSON request: { "lock_type": "OTS", "num_installation": "6666", "time_advances": [ "28/03/2010", "27/03/2011" ], "time_delays": [ "31/10/2010",](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-96.png)
![ OJMAR 97 "30/10/2011" ] } JSON response: { "result": "ok", "data": "666600004000E18AD98BFFFFFFFFFFFFFD0AF50BFFFFFF8FFFFFFFFF0000000000000000000000000000000000000000" } 7.3.1.1.5 FRAME FOR AUTOMATIC OPENING CARD Definition JSON file is sent by 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/automaticOpeningCard Parameter Mandatory Data type Possible values (,-1"<0$ K$& ")%!/ MM! +%!&"'(('"%,! K$& ")%!/9;#$6 %+$ K$& ")%!/ M77>++M Response OK: { "result": "ok", "data": "XXXXX...XXXX" } Response NOK: { "result": "error", "code":"-1", "message":"...." } Example JSON request:](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-97.png)
![ OJMAR 99 "num_installation":"2222", "subgroups":[0,1,3], "free_locks":2 } JSON response: { "result": "ok", "data": "2222FFF4060000000000000000FFFFFF0000000080FFFF7280FFFF800000000000000000000000000000000000000000" } Example for Nexo NLX1 JSON request: { "lock_type":"online", "num_installation":"2222", "num_subinstallation":"89", "free_locks":8, "dedicated_locks":[1] } JSON response: { "result": "ok", "data": "0005111122228901248400000104FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF03065100006100000A03010800FE02A490" } 7.3.1.2.2 FRAMES FOR CUSTOM USER CARD Definition JSON file is sent by POST with the information necessary for creating a customized user card. In the case of user cards parameters for OTS family and Nexo NLX1 family are not always the same. Below are two tables with the parameters required for each system. Parameters POST http://localhost:8086/serialization/userSimpleCard Parameters for OTS family](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-99.png)
![ OJMAR 103 7.3.1.2.3 EXAMPLES Example for OTS family JSON request for offline system with free locks: { "num_installation": "6666", "lock_type": "OTS", "free_locks": 3, "subgroups": [0,1,9], "expiry_time": "17:00", "expiry_date": "19/04/2014", "prohibition": 3, "time_zones":[{ "start_time":"09:30", "end_time":"17:30", "weekdays":[0,1,2,3,4] }] } JSON response: { "result": "ok", "data": "6666FDFC3600000000000000009A07440000000080FFFF6E80FFFF8080FFFF8026460700000000000000000000000067" } JSON request for offline system with dedicated locks: { "num_installation": "6666", "lock_type": "OTS", "dedicated_locks": [294] } JSON response: { "result": "ok", "data": "66660000050000000000000000FFFFFF000000008001265D000000000000000000000000000000000000000000000000" }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-103.png)
![ JSON request for offline system with locks of two types: { "num_installation": "6666", "lock_type": "OTS", "dedicated_locks": [56], "free_locks": 2, "subgroups": [6,7], "expiry_time": "17:00", "expiry_date": "19/07/2014", "prohibition": 3, "time_zones":[{ "start_time": "09:30", "end_time": "17:30", "weekdays": [0,1,2,3,4] }] } JSON response: { "result": "ok", "data": "6666FF3F3300000000000038009B87440000000080FFFF1380FFFF800000000026460700000000000000000000000067" } Example for Nexo NLX1 family JSON request for online system: { "lock_type": "online", "num_installation": "6666", "num_subinstallation": "1", "dedicated_locks": [6, 11], "free_locks": 3, "expiry_type": "endDate", "expiry_time": "17:08", "expiry_date": "19/04/2014", "start_expiry_time": "17:08", "start_expiry_date": "19/04/2015",](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-104.png)
![ OJMAR 105 "profiles": [{ "openClose": { "occupy": true, "close": "USER_CLOSING", "behavior": "REGULAR_BEHAVIOUR", "timeBetweenOperations": 200 }, "behavior": { "habitual": "OCCASIONAL", "white_list": true, "black_list": false }, "timeZones": [{ "start_time": "09:30", "start_date": "01/01/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] }] } JSON response: { "result": "ok", "data": "0005A1A26666010114840000068400000B04FFFFFF04FFFFFF04FFFFFF02085533E0F05352AD700303510001040954A513985686B7985C09260112040100000100000A05000240020201200C14040100000100000A0154A513985686B7985C0A030108000B021A52" }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-105.png)
![ Parameter Mandatory Data type Possible values 0),#%5%"%,! ,9 &$*,!(<4%"#$60%)<*'"$;!"$/$) R!,9*$.' (";R-(,&%!/.,)5%**$!R,0$!%!/.,)5%**$!R5,"#.,)5%**$!"%+$H,!$& ,9 &$*,!(<4%"#.)$$(,-1&;))'< &"')""%+$ K$& ")%!/ M77>++M$!*"%+$ K$& ")%!/ M**8++8<<<<M4$$1*'<& K$& ))'<N!"$/$)O ),+",9,!*'<R= !*'<R; Response OK: { "result": "ok", "data": "XXXXX...XXXX" } Response NOK: { "result": "error", "code":"-1", "message":"...." } Example JSON request: { "lock_type": "OTS", "num_installation": "6666", "subgroups": [6, 8], "expiry_time": "17:00", "expiry_date": "19/07/2014", "prohibition": 3, "time_zones": [{ "start_time":"09:30", "end_time":"17:30", "weekdays":[0,1,2,3,4]](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-116.png)
![ OJMAR 117 }] } JSON response: { "result": "ok", "data": "6666FEBF3B00000000000000009B87440000000080FFFFA2000000000000000026460700000000000000000000000067" } 7.3.1.4Decode frames 7.3.1.4.1 DECODE CARD FRAMES Definition JSON file is sent by 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/describeCard Parameter of the request JSON file: Parameter Mandatory Data type Possible values )'+$ K$& ")%!/ Response OK: { "result": "ok", "card_type": "XXXX", (card information by type ... } Response NOK: { "result": "error", "code":"-1", "message":"...." } Example Example for OTS family](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-117.png)
![ OJMAR 119 "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", "group": 1, "target": "pp" } 7.3.1.4.2 DECODE EVENTS FROM CARD Definition JSON file 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 of the request JSON file: Parameter Mandatory Data type Possible values .)'+$ K$& ")%!/ Response OK: { "result": "ok", "num_installation": XXXX, "events": [{ "num_lock": XX, "event_code": XX, "UID": "XXXXXXXXXXX", "date": "YYYY/MM/DD HH:mm:ss" }] }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-119.png)
![ Response NOK: { "result": "error", "code":"-1", "message":"...." } Example JSON request: { "frame": "66660003070800401004791AA1431C807A8732881204791AA1431C807A8732881004791AA1 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:00" }, { "num_lock": 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" } ] }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-120.png)
![ Example JSON request: { "locks":[ {"number":53, "facilityNumber":"6666", "subgroup":1, "config":"free"}, { "number":1, "facilityNumber":"6666", "subgroup":0, "config":"dedicated"} ], "blacklist":["12345678"] } JSON response: { "result": "ok", "data": "Init data write ok", } Configure programmer NDM Definition Multipart 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 setupCard web service result as the frame for the upload. Parameters MULTIPART FORM POST http://localhost:8086/nfc/configureProgrammerNMD Request POST parameters: Parameter Mandatory Data type Possible values *'"' K$& ")%!/ .)'+$ Response OK: { "result": "ok", "data": "Ok", } Response NOK: {](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-126.png)
![ OJMAR 127 "result": "error", "code":"-1", "message":"...." } Example JSON request: Content-Disposition: form-data; name="data" 0005111122223309A7011004010000000000640100020401020102011004010000000000640200020401020106011004010000000000640300020001020104011004010000000000640400020101020102080F04010000010000490100000000001F080F040100000100004900000040FC02E0091904010000010000490169B89D9CB8D180C969B89D9CB8D180C9090F040100000100004904A0A1A2A3A4A5090F04010000010000490500008627C10A0A030108000B028021 JSON response: { "result": "ok", "data": "Ok", } 7.3.2.3.2 LOCK MAINTENANCE Get events from NFC Definition Reads the events that have previously been downloaded from the lock to the NFC programmer. Only available for the OTS family. Parameters GET http://localhost:8086/nfc/getEvents The events that have been downloaded to the NFC programmer will be read. Response OK: [ { "lock_num": XXX, "eventCode": XXX, "UID": "XXXXXXXX", "date": "YYYY/MM/DD HH:mm" } ] Response NOK:](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-127.png)
![ { "result": "error", "code":"-1", "message":"...." } Example JSON request: GET http://localhost:8086/nfc/getEvents JSON response: { "result": "ok", "num_installation": "6666", "num_lock": 3, "events": [ { "num_lock": 3, "event_code": "10", "UID": "04791AA1431C80", "date": "2014/05/15 12:34:00" }, { "num_lock": 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 Multipart form is sent by POST with the data that updates the Firmware of the real time OTS (From OTS family) lock. • NOTE: Firmware version must be asked to Ojmar S.A. Parameters MULTIPART FORM POST http://localhost:8086/nfc/reprogramOtsLockFw Request POST parameters:](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-128.png)
![ "profiles":[], "uid":"000000D4817BAA", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1 7.3.3.33rd party SW answer Once a request is received, 3rd party SW will be able to answer with the following options (These options can be sent at the same time). 7.3.3.3.1 LOCK CONFIGURATION Definition When a Nexo NLX1 lock is initialized, it is connected to the network provided and will 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 from that lock it will respond with a JSON with the config flag enabled. The API will get the JSON and send back the configuration data to the lock. First of all, we need to provide the network information to the lock. We will generate an initialization card for that: http://localhost:8086/initialization/initData. Once the initialization card has been used, the lock will get connected to the wireless network and send a request packet to the API at the IP passed in the initialization.](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-134.png)
![ OJMAR 135 Parameters JSON structure that the 3rd party SW will answer in order to configure a lock Parameter Mandatory Data type Possible values ! +(,-1 K$& !" ,-1J&! +5$)-,!.%/ K$& :,,($'! $.%!$&%."#$(,-1%&/,%!/",5$-,!.%/ )$*,)!,"! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& K$& !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",0),.%($& K$& ))'<9!"; Example Lock request JSON: { "profiles":[], "uid":"000000D4817BAA", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-135.png)
![ 3rd party SW answer JSON: { "num_lock": 1, "config": true, "num_installation": "2222", "num_subinstallation": "33", "dedicated_locks": [2], "free_locks": 3, "profiles": [] } The lock has been configured. 7.3.3.3.2 LOCK OPENING/CLOSING ALLOWEMENT 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. Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-136.png)
![ OJMAR 137 Examples Example that will open/close the lock Lock request JSON: { "profiles":[], "uid":"000000D4817BAA", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"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/close the lock Lock request JSON: { "profiles":[], "uid":"000000D4817BAA", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-137.png)
![ 3rd party SW answer JSON: { "num_installation": "2222", "num_subinstallation": "33", "dedicated_locks": [3] } 3rd party SW will send a dedicated_lock that is not the actual lock number. If a different installation or subinstallation number is sent, lock will not perform the action too. • NOTE: It is mandatory to answer with a no permission JSON in order to avoid the opening or closing of the lock. If there is no answer, lock will try to solve the operation in a local way (As if it was online). 7.3.3.3.3 LOCK OPENING/CLOSING 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 ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",,-- 0< K$& :,,($'! $.%!$&%."#$-')*,-- 0%$&"#$(,-14#$!%"/$"&-(,&$*' ",+'"%--(,&$ K$& :,,($'! $.%!$&%.(,-1/$"&' ",-(,&$*4#$!%"&,0$!$*)$2$)&$4,)1%!/ K$& :,,($'! $.%!$&%""#$(,-1/$"&,-- 0%$*4#$!%"&,0$!$*](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-138.png)
![ OJMAR 139 Parameter Mandatory Data type Possible values %+$5$"4$$!,0$)'"%,! K$& !" 9+&;3,)1%!/"<0$ K$& ")%!/ U*$*%-'"$*V=V.)$$V3#%"$(%&" K$& :,,($'! $.%!$&%."#$ &$)4%((5$-#$-1$*%!"#$4#%"$(%&"9.,..(%!$;:('-1(%&" K$& :,,($'! $.%!$&%."#$ &$)4%((5$-#$-1$*%!"#$5('-1(%&"9.,..(%!$; Examples Lock request JSON: { "profiles":[], "uid":"000000D4817BAA", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1 } 3rd party SW answer JSON: { "num_installation": "2222", "num_subinstallation": "33", "dedicated_locks": [3] “occupy": true automatic_close", false reverse_working" false time_between_operations",100 working_type", "dedicated" white_list", true black_list", false](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-139.png)
![ OJMAR 141 Parameter Mandatory Data type Possible values "#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;! +%!&"'(('"%,! K$& ")%!/ ,-1J&!$4%!&"'(('"%,!! +5$)Example Lock request JSON: { "profiles":[], "uid":"000000D4817BAA", "mem_uid":"000000D4817BAA ", "lock_status":["C","O"], "num_installation":"B1B2", "num_subinstallation":"C2", "locks":[], "lock_request":true, "lock_response":false, "num_lock":156 } 3rd party SW answer: { "num_installation": "B1B2", "num_subinstallation": "C2", "dedicated_locks": [1,2], "free_locks": 1, "change_num_installation": { "num_installation": "CCDD", "group": 1, "range_from": 1, "range_to": 100 } }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-141.png)
![ Opening/closing + change lock´s subinstallation number 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 the option of changing lock´s sub-facility number if it is needed. Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",0),.%($& K$& ))'<9!"; -#'!/$! +& 5%!&"'(('"%,! K$& ))'< /), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;)'!/$.),+ K$& !" !%"%'((,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;! +& 5%!&"'(('"%,! K$& ")%!/ ,-1J&!$4& 5%!&"'(('"%,!! +5$) Example Lock request JSON: { "profiles":[],](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-142.png)
![ OJMAR 143 "uid":"000000D4817BAA", "mem_uid":"000000D4817BAA ", "lock_status":["C","O"], "num_installation":"B1B2", "num_subinstallation":"C2", "locks":[], "lock_request":true, "lock_response":false, "num_lock":156 } 3rd party SW answer: { "num_installation": "B1B2", "num_subinstallation": "C2", "dedicated_locks": [1,2], "free_locks": 1, "profiles": [], "change_num_subinstallation": { "num_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 answering the request with the following JSON plus the option of changing lock´s number if it is needed. Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-143.png)
![ Parameter Mandatory Data type Possible values #'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",0),.%($& K$& ))'<9!"; -#'!/$! +(,-1 K$& ))'< /), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;! +(,-1 K$& !" ,-1J&!$4! +5$) Example Lock request JSON: { "profiles":[], "uid":"000000D4817BAA", "mem_uid":"000000D4817BAA ", "lock_status":["C","O"], "num_installation":"B1B2", "num_subinstallation":"C2", "locks":[], "lock_request":true, "lock_response":false, "num_lock":156 } 3rd party SW answer: { "num_installation": "B1B2", "num_subinstallation": "C2", "dedicated_locks": [1,2], "free_locks": 1, "expiry_type": "no", "uses": 0, "profiles": [],](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-144.png)
![ { "profiles":[], "uid":"11223344556677", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"AABB", "num_subinstallation":"CC", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1785 } 3rd party SW answer JSON: { "num_installation": "AABB", "num_subinstallation": "CC", "dedicated_locks": [5,8], "free_locks": 6, "profiles": [], "set_time": { "group": 1, "range_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 following JSON plus managing the white and black list if the lock goes offline. Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-146.png)
![ OJMAR 147 Parameter Mandatory Data type Possible values ",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",0),.%($& K$& ))'<9!"; -#'!/$(%&"& K$& ))'< /), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;)'!/$.),+ K$& !" !%"%'((,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;%"$+& K$& ))'< %* K$& ")%!/ 5<"$&'-"%,! K$& ")%!/ U'**V=V*$($"$V=V+,*%.<V(%&""<0$ K$& ")%!/ U4#%"$V=V5('-1V Example Lock request JSON: { "profiles":[], "uid":"000000AABBCCDD", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"EEFF", "num_subinstallation":"AC", "locks":[], "lock_request":true, "lock_response":false, "num_lock":12 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-147.png)
![ 3rd party SW answer JSON: { "num_installation": "B1B2", "num_subinstallation": "C2", "dedicated_locks": [1,2], "free_locks": 1, "profiles": [], "change_lists": { "items": [ {"uid": "000000AAAAAAAA", "action": "add", "list_type": "white"}, {"uid": "000000BBBBBBBB", "action": "delete", "list_type": "white"} {"uid": "CCCCCCCCDDDDDD", "action": "add", "list_type": "black"} ], "group": 1, "range_from": 1, "range_to": 100 } } Opening/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 factory value. Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-148.png)
![ OJMAR 149 #'2$'--$&&)%/#"&",0),.%($& K$& ))'<9!"; *$($"$*'"' K$& ))'< /), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;)'!/$.),+ K$& !" !%"%'((,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;,0"%,!& K$& ")%!/ U:V Example Lock request JSON: { "profiles":[], "uid":"000000AABBCCDD", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"EEFF", "num_subinstallation":"AC", "locks":[], "lock_request":true, "lock_response":false, "num_lock":12 } 3rd party SW answer JSON: { "num_installation": "B1B2", "num_subinstallation": "C2", "dedicated_locks": [1,2], "free_locks": 1, "expiry_type": "no", "uses": 0, "profiles": [], "delete_data": {](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-149.png)
![ "options": ["BT"], "group": 1, "range_from": 1, "range_to": 100 } }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-150.png)
![ Example Lock request JSON: { "profiles":[], "uid":"000000AABBCCDD", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"EEFF", "num_subinstallation":"AC", "locks":[], "lock_request":true, "lock_response":false, "num_lock":12 } 3rd party SW answer JSON: { "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 + lock group and number 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 requesting the information concerning the lock´s number and group.](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-152.png)
![ Example Lock request JSON: { "profiles":[], "uid":"000000AABBCCDD", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":8 } 3rd party SW answer JSON: { "num_lock": 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 installation & lock time and date request 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 requesting the information of the lock´s time and date.](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-154.png)
![ OJMAR 155 Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",),.%($& K$& ))'<9!"; )$I $&"*'"' K$& ))'< +$*%' K$& ")%!/ U&$)%'(0,)"V/), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;)'!/$.),+ K$& !" !%"%'((,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;/$""%+$ K$& :,,($'! Example Lock request JSON: { "profiles":[], "uid":"123456781234", "mem_uid":"123456781234", "lock_status":["C","O"], "num_installation":"6666", "num_subinstallation":"33", "locks":[], "lock_request":true,](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-155.png)
![ "lock_response":false, "num_lock":11 } 3rd party SW answer JSON: { "num_installation": "6666", "num_subinstallation": "33", "dedicated_locks": [2], "profiles": [], "request_data": { "media": "serial_port", "get_time": true, "group": 1, "range_from": 1, "range_to": 100 } } Opening/closing + get events 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 receiving the last events that happened in the lock Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",0),.%($& K$& ))'<9!"; ](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-156.png)
![ OJMAR 157 Parameter Mandatory Data type Possible values )$I $&"*'"' K$& ))'< +$*%' K$& ")%!/ U&$)%'(0,)"V/), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;)'!/$.),+ K$& !" !%"%'((,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;/$"(,/ K$& ))'< !$2$!"& K$& !" Example Lock request JSON: { "profiles":[], "uid":"65849301223344", "mem_uid":"65849301223344", "lock_status":["O","B"], "num_installation":"2432", "num_subinstallation":"16", "locks":[], "lock_request":true, "lock_response":false, “num_lock":6157, } 3rd party SW answer JSON: { "num_lock": 1, "num_installation": "2432", "num_subinstallation": "16", "dedicated_locks": [2], "free_locks": 3, "profiles": [],](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-157.png)
![ OJMAR 159 Parameter Mandatory Data type Possible values "#'"4%((5$'..$-"$*9),+",;/$"!-<-($ K$& :,,($'! Example Lock request JSON: { "profiles":[], "uid":"000000BCDEFABC", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":3 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-159.png)
![ 3rd party SW answer JSON: { "num_lock": 1, "num_installation": "2222", "num_subinstallation": "33", "dedicated_locks": [2], "free_locks": 3, "profiles": [], "request_data": { "media": "serial_port", "get_n_cycle": true, "group": 1, "range_from": 1, "range_to": 100 } } Opening/closing + get public configuration 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 requesting the complete configuration of the lock Parameters Parameter Mandatory Data type Possible values ! +%!&"'(('"%,! K$& ")%!/ ,-1%!&"'(('"%,!! +5$)! +& 5%!&"'(('"%,! K$& ")%!/ ,-1& 5%!&"'(('"%,!! +5$)*$*%-'"$*(,-1& K$& ))'<9!"; $*%-'"$*(,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",.)$$(,-1& , !" +5$),.,--'&%,!'((,-1&"#'""#$ &$)4%((#'2$'--$&&)%/#"&",),.%($& K$& ))'<9!"; )$I $&"*'"' K$& ))'< +$*%' K$& ")%!/ U&$)%'(0,)"V](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-160.png)
![ OJMAR 161 Parameter Mandatory Data type Possible values /), 0 K$& !" ), 0,.(,-1&"#'"4%((5$'..$-"$*9),+",;)'!/$.),+ K$& !" !%"%'((,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)'!/$", K$& !" '&"(,-1! +5$)"#'"4%((5$'..$-"$*9),+",;)$'*0 5(%-%!.,)+'"%,! K$& :,,($'! Example Lock request JSON: { "profiles":[], "uid":"000000BCDEFABC", "mem_uid":"00000000000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[], "lock_request":true, "lock_response":false, "num_lock":3 } 3rd party SW answer JSON: { "num_lock": 1, "num_installation": "2222", "num_subinstallation": "33", "dedicated_locks": [2], "free_locks": 3, "profiles": [], "request_data": { "media": "eth",](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-161.png)
![ "read_public_information": true, "group": 1, "range_from": 1, "range_to": 100 } } 7.3.3.4Lock response Every 3rd party SW answer will be replied by the lock sending a final response. This response can contain two different structures. First one will be for all the opening/closing operation + card configuration + lock configuration and the last one will be the answer to the information request. 7.3.3.4.1 LOCK RESPONSE TO OPENING/CLOSING PETITION (INCLUDING CARD CONFIGURATION AND LOCK CONFIGURATION) Definition Lock will always 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 following parameters. Parameter Mandatory Data type Possible values ,/%"$+& K$& ))'<9; (,/%"$+ K$& ))'<9&")%!/; %+$&"'+0 K$& ")%!/ !%6.,)+'"$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$( Example { logItems=[LogItem [timestamp=1476885376, uid=00000667BE4404 , eventCode=EventType[USER_CLOSE: 18], batteryStatus=73]] } 7.3.3.4.2 LOCK RESPONSE TO OPENING/CLOSING PETITION (INCLUDING CARD CONFIGURATION AND LOCK CONFIGURATION) + INFORMATION REQUEST Lock installation & subinstallation request](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-162.png)
![ OJMAR 163 Returns the information concerning the installation and subinstallation data of the lock, plus the last event. Definition Lock will always answer the last event that happened in the lock,that includes event type, uid that performed the action, time and date that happened and the lock´s installation and subinstallation information. Parameters A JSON structure will be received by TCP/IP with following parameters. Parameter Mandatory Data type Possible values ,/%"$+& K$& ))'<9; (,/%"$+ K$& ))'<9&")%!/; %+$&"'+0 K$& ")%!/ !%6.,)+'"$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$(!.,)+'"%,!$I $&" K$& ))'< !.,)+'"%,! K$& ")%!/ ,-1 +), 0$&0,!&$! +%!&"'(('"%,! K$& ")%!/ ,-1J&.'-%(%"<! +5$) +& 5%!&"'(('"%,! K$& ")%!/ ,-1J&& 5%!&"'(('"%,!! +5$) Example logItems=[LogItem [timestamp=1476886236, uid=00000667BE4404 , eventCode=EventType[USER_OPEN: 16], batteryStatus=73]]]],commands=[CommandCont ainer [commands=[InformationRequest [information=NumInstSubinstResponse[sub inst alation=51, instalation=26214]]]]]](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-163.png)
![ Lock number and group request Returns the information concerning the lock number and group, plus the last event. Definition Lock will always answer the last event that happened in the lock, that includes event type, uid that performed the action, time and date that happened and the lock´s installation and subinstallation information. Parameters A JSON structure will be received by TCP/IP with following parameters. Parameter Mandatory Data type Possible values ,/%"$+& K$& ))'<9; (,/%"$+ K$& ))'<9&")%!/; %+$&"'+0 K$& ")%!/ !%6.,)+'"$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$(!.,)+'"%,!$I $&" K$& ))'< !.,)+'"%,! K$& ")%!/ ,-1 +), 0$&0,!&$/), 0 K$& ")%!/ ,-1J&/), 0$6" K$& ")%!/ ,-1J&$6"$!&%X! +5$) K$& ")%!/ ,-1J&! +5$) Example logItems=[LogItem [timestamp=1476887561, uid=00000667BE4404 , eventCode=EventType[USER_CLOSE: 18], batteryStatus=73]]]],commands=[CommandCon tainer [commands=[InformationRequest [information=LockNumGroupResponse[group=1, ext=0, number=1]]]] Lock events request Definition Returns the information concerning the last events of the lock, plus the last event.](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-164.png)
![ OJMAR 165 Parameters A JSON structure will be received by TCP/IP with following parameters. Parameter Mandatory Data type Possible values ,/%"$+& K$& ))'<9; (,/%"$+ K$& ))'<9&")%!/; %+$&"'+0 K$& ")%!/ !%6.,)+'"$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$(!.,)+'"%,!$I $&" K$& ))'< !.,)+'"%,! K$& ")%!/ ,/$&0,!&$L,/%"$+& K$& ))'<9; L(,/%"$+ K$& ))'<9&")%!/; L%+$&"'+0 K$& ")%!/ !%6.,)+'"L$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;L5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$( *Per number of events Example logItems=[LogItem [timestamp=1476888500, uid=00000000000000 , eventCode=EventType[ALARM_CAM_FORCED: 96], batteryStatus=100]]]],commands=[Com mandContainer [commands=[InformationRequest [information=LogResponse[overwrite=0 , logSize=69, logItems=[LogItem [timestamp=1476888500, uid=00000000000000, event Code=EventType[ALARM_CAM_FORCED: 96], batteryStatus=100], LogItem [timestamp=147 6888501, uid=00000667BE4404, eventCode=EventType[USER_CLOSE: 18], batteryStatus= 73], LogItem [timestamp=1476888500, uid=00000667BE4404, eventCode=EventType[OPER ATION_REQUEST: 7], batteryStatus=73], LogItem [timestamp=1476887991, uid=0000066 7BE4404, eventCode=EventType[USER_OPEN: 16], batteryStatus=73], LogItem [timesta](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-165.png)
![ mp=1476887990, uid=00000667BE4404, eventCode=EventType[OPERATION_REQUEST: 7], ba tteryStatus=73], LogItem [timestamp=1476887561, uid=00000667BE4404, eventCode=Ev entType[USER_CLOSE: 18], batteryStatus=73], LogItem [timestamp=1476887560, uid=0 0000667BE4404, eventCode=EventType[OPERATION_REQUEST: 7], batteryStatus=73], Log Item [timestamp=1476886236, uid=00000667BE4404, eventCode=EventType[USER_OPEN: 1 6], batteryStatus=73]]]]]]],dataModelVersion=DataModelVersion[vInteger=0, vDecim al=3, vSecDecimal=18],dataModelCheck=DataModelChk[checksum=50397],] {"log":{"overwrite":false,"size":69,"events":[{"date":1476888500,"event_code":"6 0","uid":"00000000000000","battery_status":100},{"date":1476888501,"event_code": "12","uid":"00000667BE4404","battery_status":73},{"date":1476888500,"event_code" :"7","uid":"00000667BE4404","battery_status":73},{"date":1476887991,"event_code" :"10","uid":"00000667BE4404","battery_status":73},{"date":1476887990,"event_code ":"7","uid":"00000667BE4404","battery_status":73},{"date":1476887561,"event_code ":"12","uid":"00000667BE4404","battery_status":73},{"date":1476887560,"event_cod e":"7","uid":"00000667BE4404","battery_status":73},{"date":1476886236,"event_cod e":"10","uid":"00000667BE4404","battery_status":73}]}, Lock number of cycles Definition Returns the information concerning the cycles that the lock has already completed.](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-166.png)
![ OJMAR 167 Parameters A JSON structure will be received by TCP/IP with following parameters. Parameter Mandatory Data type Possible values ,/%"$+& K$& ))'<9; (,/%"$+ K$& ))'<9&")%!/; %+$&"'+0 K$& ")%!/ !%6.,)+'"$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$(!.,)+'"%,!$I $&" K$& ))'< !.,)+'"%,! K$& ")%!/ +5$).<-($&$&0,!&$.),+"')"0 K$& !" .),+:'""$)<#'!/$ K$& !" Example logSize=69, logItems=[LogItem [timestamp=1476888906, uid=00000667BE4404 , eventCode=EventType[USER_OPEN: 16], batteryStatus=73]]]],commands=[CommandCont ainer [commands=[InformationRequest [information=NumberOfCyclesResponse[fromStar tUp=7602432,fromBatteryChange=7602432]]]]] Lock public information Definition Returns the information concerning the complete configuration that the lock has. Parameters A JSON structure will be received by TCP/IP with following parameters. Parameter Mandatory Data type Possible values ,/%"$+& K$& ))'<9; (,/%"$+ K$& ))'<9&")%!/;%+$&"'+0 K$& ")%!/ !%6.,)+'"$2$!",*$ K$& ")%!/ 2$!"-,*$@*$&-)%0"%,!9$$!!$6;5'""$)<&"'" & K$& ")%!/ W,.5'""$)<($2$(](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-167.png)
![ Parameter Mandatory Data type Possible values !.,)+'"%,!$I $&"K$& ))'< !.,)+'"%,! K$& ")%!/ $'* 5(%-,!.%/ )'"%,!$&0,!&$%!&" K$& ")%!/ & 5%!&" K$& ")%!/ "%+$ K$& !" !%6"%+$5'""$)<&"'" & K$& !" 74&"'" & K$& ")%!/ .),+"')"0 K$& !" .),+:'""$)<#'!/$ K$& !" K$& ")%!/ "#'"%&,-- 0<%!/"#$(,-1 logItems=[LogItem [timestamp=1476889166, uid=00000667BE4404 , eventCode=EventType[USER_CLOSE: 18], batteryStatus=73]]]],commands=[CommandCon tainer [commands=[InformationRequest [information=ReadPublicConfigurationRespons e[integrator=0,inst=0,subinst=0,time=0,id8=0,id7=0,id6=0,id5=0,id4=0,id3=0,id2=0 ,id1=0,dstH=0,dstha=0,dsthd=0,dstDa=0,dstDd=0,lowBatteryPos=0,batteryStatus=0,hw Status=0,profiles=0,tmpProfiles=0,fromStartUp=0,fromBatteryChange=0,uid=00000000 0A0300]]]]] ation":0,"time":"01/01/1970","openings":[],"default_pos_low_battery":0,"battery_ status":0,"hw_status":0,"profiles":[],"tmp_profiles":[],"cycles_from_init":0,"cy cles_from_change":0,"uid":"000000000A0300"},](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-168.png)
![ Once the frame is created, this data will be loaded to the NFC programmer: MULTIPART FORM POST http://localhost:8086/nfc/configureProgrammerNMD JSON request: Content-Disposition: form-data; name="data" 00051111B1B2C2098D020A0401000001000032B1B2030A0401000001000032111104090401000001000032C2050B0401000001000032FFFFFF145B04010000010000324F6E6C696E6553797374656D0000000000000000000000000000000000000000413141324133413400000000000000000000000000000000000000000000000002C0A80161C0A80164C0A8010A0132FFFFFF000A03010800FE02411D JSON response: { "result": "ok", "data": "Ok", } So, initialization data has been uploaded to the programmer. 7.4.1.2Initialize the lock and configure it by the socket Choose the lock option on the NFC programmer, Nexo NLX1 and initialize option. Choose the lock number that wants to be initialized, and approach the programmer to the lock: Once done, following data will be sent from the lock to the server. { "uid":"05814719", "mem_uid":"00000000", "lock_status":["A","L"], "num_installation":"B1B2", "num_subinstallation":"C2", "locks":[], "lock_request":true, "lock_response":false, "num_lock":1 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-170.png)
![ OJMAR 171 The third-party software reads the JSON, detects if it is the first time that this lock makes a request and sends the following JSON forcing configuration. { "num_lock":1, "config":true, "change_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":"B1B2", "num_subinstallation":"C2", "dedicated_locks":[0], "free_locks":0 } Lock will send back the event in order to finish the communication and will beep 3 times. { "logs":[ {"date":1460390756, "event_code":"64", "uid":"000094FC6B4A04", "battery_status":33 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-171.png)
![ 7.4.2User card request 7.4.2.1Record a user card Once the lock is configured, a user card will be written. For that, two steps will be made POST http://localhost:8086/serialization/userSimpleCard JSON request: { "lock_type":"online", "num_installation":"2222", "num_subinstallation":"89", "free_locks":8, "dedicated_locks":[1] } JSON response: { "result": "ok", "data": "00051111B1B2C201248400000104FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF03065100006100000A03010800FE02A490" } POST http://localhost:8086/card/write JSON request: http://localhost:8086/card/read/cnreader/classic JSON response: { "result": "ok", "data_online": "00051111B1B2C201248400000104FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF04FFFFFF03065100006100000A03010800FE02A490", "uid": "26F99832" } 7.4.2.2User card closing allowement A user card is approached to the lock and lock sends following JSON to the socket. { "uid":"94FC6B4A",](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-172.png)
![ OJMAR 173 "mem_uid":"00000000", "lock_status":["A","L"], "num_installation":"2222", "num_subinstallation":"33", "locks":[ {"lock_type":"dedicated", "num_lock":"1" } ], "lock_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", "range_from":"0", "range_to":1, "media":"serial_port", "get_log":{ "n_events":2 } }, "profiles":null, "num_installation":"B1B2", "num_subinstallation":"C2", "dedicated_locks":[1], "free_locks":6 }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-173.png)
![ The lock detects that the third-party software ask for logs, so sends the following JSON. { "logs":[ {"date":1460390756, "event_code":"12", "uid":"000094FC6B4A04", "battery_status":33 } {"date":1460390754, "event_code":"10", "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.5CODE EXAMPLES 7.5.1PHP // Create a TCP Stream socket $sock = socket_create(AF_INET, SOCK_STREAM, 0); // Bind the socket to an address/port socket_bind($sock, '0.0.0.0', 7777) or die('Could not bind to address'); // Start listening for connections socket_listen($sock);](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-174.png)
![ OJMAR 175 // Accept incoming requests and handle them as child processes $client = socket_accept($sock); // Read the input from the client $input = socket_read($client, 65535); // Process request and write response to $output. // Write response socket_write($client, $output, strlen($output)); // Close the master sockets socket_close($sock); 7.5.2Java 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", args[1]); // Pre-cook response List<String> whitelist = new ArrayList<String>(); whitelist.add("A1B2C3D4"); whitelist.add("A1B2C3D4"); whitelist.add("A1B2C3D4"); whitelist.add("A1B2C3D4"); // Receive data byte[] data = readBytes(); // Send response Gson gson = new Gson(); String rawResponse = gson.toJson(whitelist); sendBytes(rawResponse.getBytes()); }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-175.png)
![ public void sendBytes(byte[] myByteArray) throws IOException { sendBytes(myByteArray, 0, myByteArray.length); } public void sendBytes(byte[] myByteArray, int start, int len) throws IOException { if (len < 0) throw new IllegalArgumentException("Negative length not allowed"); if (start < 0 || start >= myByteArray.length) throw new IndexOutOfBoundsException("Out 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 DataOutputStream(out); dos.writeInt(len); if (len > 0) { dos.write(myByteArray, start, len); } } public byte[] readBytes() throws IOException { // Again, probably better to store these objects references in the support class InputStream in = socket.getInputStream(); DataInputStream dis = new DataInputStream(in); int len = dis.readInt(); byte[] data = new byte[len]; if (len > 0) { dis.readFully(data); } return data;](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-176.png)
![ OJMAR 177 } } 7.5.3C using System; using System.Net; using System.Net.Sockets; using System.Text; public class SynchronousSocketClient { public static void StartClient() { // Data buffer for incoming data. byte[] bytes = new byte[2048]; // Connect to a remote device. try { // Establish the remote 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 IPEndPoint(ipAddress,7777); // Create a TCP/IP socket. Socket sender = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp ); // Connect the socket to the remote endpoint. Catch any errors. try { sender.Connect(remoteEP); Console.WriteLine("Socket connected to {0}", sender.RemoteEndPoint.ToString());](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-177.png)
![ // Receive the response from the remote device. int bytesRec = sender.Receive(bytes); Console.WriteLine("Received: {0}", Encoding.ASCII.GetString(bytes,0,bytesRec)); // Encode the data string into a byte array. byte[] whitelist = Encoding.ASCII.GetBytes("['A1B2C3D4E5','A1B2C3D4E5','A1B2C3D4E5']"); // 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("ArgumentNullException : {0}",ane.ToString()); } catch (SocketException se) { Console.WriteLine("SocketException : {0}",se.ToString()); } catch (Exception e) { Console.WriteLine("Unexpected exception : {0}", e.ToString()); } } catch (Exception e) { Console.WriteLine( e.ToString()); } } public static int Main(String[] args) { StartClient(); return 0; } }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-178.png)
![ OJMAR 179 7.6ANEXO 7.6.1Generate and read JSON files 7.6.1.1PHP PHP has a function to create JSON string from an array. string json_encode (mixed $value [,int $options = 0 [, int $depth = 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 ( string $json [, bool $assoc = false [, int $depth = 512 [, int $options = 0]]] ) Example: <?php $json = '{"a":1,"b":2,"c":3,"d":4,"e":5}'; var_dump(json_decode($json, true)); ?> The above example would be: array(5) { ["a"] => int(1) ["b"] => int(2) ["c"] => int(3) ["d"] => int(4) ["e"] => int(5) }](https://usermanual.wiki/OJMAR/OJM002.User-manual-v2/User-Guide-3769157-Page-179.png)
