Skip to content

jmtodev/libcr

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
example
example
 
 
include
include
 
 
lib
lib
 
 
obj
obj
 
 
.gitignore
.gitignore
 
 
README.md
README.md
 
 
build_test.sh
build_test.sh
 
 

Repository files navigation

JMTO Control Room Service Library (LibCR)

LibCR merupakan library untuk menyediakan service komunikasi data antar aplikasi Toll Collector dengan aplikasi Control-Room JMTO. Library akan mengurus semua proses komunikasi, dari mulai inisialisasi port server, protokol komunikasi, hingga kontrol pengiriman data.

Aplikasi Toll Collector hanya perlu menyisipkan library, melakukan inisialisasi dan selanjutnya melakukan provide informasi-informasi yang dibutuhkan oleh Control-Room dengan menggunakan fungsi-fungsi yang telah tersedia.

Untuk penerimaan data/event dari Control-Room, aplikasi Toll Collector dapat melakukan registrasi fungsi callback, baik itu untuk mendapatkan event keyboard ataupun event cst.

Library tersedia untuk Linux dalam 3 arsitektur, diantaranya:

  • amd64 - Intel/AMD x86 dengan 64bit
  • aarch64 - ARM 64bit
  • armv7 - ARM 32bit

Sedangkan untuk QNX/NTO hanya disediakan arsitektur i386 (Intel/AMD x86 dengan 32bit)

Binary Build Library

LibCR dibangun sebagai static library untuk C/C++ yang dapat digunakan pada environment gcc.

File library terdiri dari 2 jenis extension *.a (pada direktori lib) atau *.o (pada direktori obj). Aplikasi Toll Collector dapat memilih salah-satu format sesuai dengan kebutuhannya.

Berikut adalah nama-nama file binary untuk library beserta keterangan arsitektur dan platformnya:

  • libcr-amd64.a / libcr-amd64.o - Linux x86 64bit
  • libcr-aarch64.a / libcr-aarch64.o - Linux ARM 64bit
  • libcr-armv7.a / libcr-armv7.o - Linux ARMv7
  • libcr-i386-qnx.a / libcr-i386-qnx.o - QNX/NTO x86 32bit

Test Program

Test program dapat dilihat pada file example/testlibcr.c, dan dapat di-build dengan build_test.sh (Hanya untuk Linux). Berikut command untuk melakukan build sesuai dengan arsitektur yang dituju:

# Build untuk x86 64bit
./build_test.sh

# Build untuk arm-64
./build_test.sh aarch64

# Build untuk arm-v7 32bit
./build_test.sh armv7

Referensi Library

Berikut adalah referensi lengkap dari Library Control Room yang terbagi kedalam 4 segment diantaranya:

  • Struktur Data - Kumpulan struktur data yang akan digunakan pada fungsi atau callback interface sebagai sarana pengiriman data non-primitif.
  • Callback Interface - Merupakan interface yang akan digunakan aplikasi Toll Collector untuk menerima data/event dari Control Room
  • Function - Merupakan fungsi-fungsi yang dapat dipanggil aplikasi Toll Collector untuk mengontrol, berkomunikasi dan mengirimkan data kepada Control Room.
  • Constants - Merupakan kumpulan nilai konstanta yang digunakan pada fungsi

Control Room dibangun secara fleksibel untuk menunjang berbagai kebutuhan dan ketersediaan sistem, oleh sebab itu fungsi-fungsi yang diimplementasikan aplikasi Toll Collector dibagi kedalam beberapa requirement diantaranya:

  • MANDATORY - Fungsi harus dipenuhi aplikasi Toll Collector, dikarenakan data dari fungsi yang dimaksud sangat dibutuhkan oleh operator Control Room, dan pengoperasian Control Room tidak akan berjalan tanpa adanya informasi yang dimaksud.
  • RECOMMENDED - Fungsi yang sangat direkomendasikan untuk diimplementasikan aplikasi Toll Collector, dengan dipenuhinya implementasi ini, pengoperasian Control Room akan semakin seamless.
  • OPTIONAL - Opsional untuk diimplementasikan, tapi lebih baik tetap dipenuhi.
  • - - Bukan merupakan fungsi requirement, tapi sarana untuk kebutuhan informasi dan sequence logic dari aplikasi Toll Collector yang dapat digunakan.

Daftar Isi

Struktur Data

libcr_cstdata_t

Struktur data mifare yang akan dikirimkan pada event tap kartu pada CST. terdiri dari block 1 sampai 3. Block 0 tidak akan dikirimkan.

typedef struct {
  uint8_t status;     /* Status pembacaan kartu. Lihat LIBCR_CSTSTATUS_* */
  uint8_t sector_id;  /* ID Sektor yang dibaca */
  uint8_t block1[16]; /* 16byte data pada block 1 (relatif-sektor) */
  uint8_t block2[16]; /* 16byte data pada block 2 (relatif-sektor) */
  uint8_t block3[16]; /* 16byte data pada block 3 (relatif-sektor) */
} libcr_cstdata_t;

Callback Interfaces

*libcr_keyboard_cb()

Callback interface untuk menerima event keyboard dari ControlRoom.

Arguments

  • keycode : Kode keyboard yang ditekan. Lihat LIBCR_KEY_*

Return Value

  • void tidak perlu memberikan return
typedef void (*libcr_keyboard_cb)(uint8_t keycode);

*libcr_cst_cb()

Callback interface untuk menerima event tap CST

Arguments

  • uuid : Hex String (null terminated) untuk UUID kartu yang di tap
  • data : Data kartu yang di tap di control room
  • data_length : Jumlah data/sektor yang didapat

Return Value

  • void tidak perlu memberikan return
typedef void (*libcr_cst_cb)(const char* uuid, const libcr_cstdata_t* data,
                             size_t data_length);

*libcr_log_cb()

Callback interface untuk logging

Arguments

  • log : String log
  • log_length : Panjang string log

Return Value

  • void tidak perlu memberikan return
typedef void (*libcr_log_cb)(const char* log, int log_length);

Functions

libcr_init()

Inisialisasi dan mulai service control room. Hanya panggil sekali ketika program dimulai, dan jalankan libcr_close ketika program selesai.

Requirement : MANDATORY

Arguments

  • app : String nama aplikasi dan versi (Contoh: TCT 1.00)
  • port : Port TCP yang akan digunakan (Rekomendasi LIBCR_DEFAULT_PORT)

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_init(
    const char* app,
    int port
);

libcr_close()

Hentikan service control room.

Requirement : MANDATORY

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_close();

libcr_set_info()

Set detail informasi gardu. Disarankan informasi awal ini telah di-set sebelum menjalankan libcr_init().

Requirement : MANDATORY

Arguments

  • kode_gerbang : Kode gerbang (1-99)
  • kode_gardu : Kode gardu (1-99)
  • jenis_gardu : Gunakan LIBCR_GARDU_SINGLE atau LIBCR_GARDU_MULTI
  • jenis_gerbang : Lihat LIBCR_GERBANG_*
  • nama_gardu : Nama gardu (contoh: KALIHUTIP UTAMA 1)
  • nama_ruas : Nama gardu (contoh: PURBALEUNYI)

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_info(
    uint8_t kode_gerbang,
    uint8_t kode_gardu,
    uint8_t jenis_gardu,
    uint8_t jenis_gerbang,
    const char* nama_gardu,
    const char* nama_ruas
);

libcr_is_active()

Cek apakah service control room berjalan

Requirement : -

Return Value

  • LIBCR_OK bila aktif, LIBCR_ERR_NOSERVICE bila non-aftif
int libcr_is_active();

libcr_set_keyboard_cb()

Set callback untuk penerima event keyboard

Requirement : MANDATORY

Arguments

  • callback : Fungsi callback. Isi NULL bila nonaktif

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_keyboard_cb(
    libcr_keyboard_cb callback
);

libcr_set_cst_cb()

Set callback untuk penerima event cst

Requirement : RECOMMENDED

Arguments

  • callback : Fungsi callback. Isi NULL bila nonaktif

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_cst_cb(
    libcr_cst_cb callback
);

libcr_set_log_cb()

Set callback untuk penerima message log. Rekomendasi hanya gunakan LIBCR_LOGLEVEL_ERROR atau LIBCR_LOGLEVEL_NONE pada argumen loglevel untuk build production.

Requirement : OPTIONAL

Arguments

  • callback : Fungsi callback. Isi NULL bila nonaktif
  • loglevel : Lihat LIBCR_LOGLEVEL_*

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_log_cb(
    libcr_log_cb callback,
    uint8_t loglevel
);

libcr_cst_reg_sector()

Tambah registrasi request sektor mifare. Sektor yang telah teregistrasi akan dibaca CST Control Room ketika kartu mifare di-tap, dan data akan dikirimkan melalui callback yang telah diset dengan fungsi libcr_set_cst_cb.

Registrasi multiple sektor dapat dilakukan dengan menjalankan fungsi ini kembali dengan argument sector_id yang berbeda.

Bila fungsi ini dipanggil kembali dengan sector_id sebelumnya telah teregistrasi, maka data keytype dan key pada registrasi sector tersebut akan ditimpa.

Jumlah maksimal sector yang dapat diregistrasi adalah sebanyak 5 sektor.

Requirement : RECOMMENDED

Arguments

  • sector_id : ID sektor mifare yang akan dibaca
  • keytype : Lihat LIBCR_CST_KEY_TYPE_*
  • key : Hex string mifare key untuk sektor yang dimaksud
  • sector_id : ID sektor mifare yang akan dibaca

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_cst_reg_sector(
    uint8_t sector_id,
    uint8_t keytype,
    const char* key
);

libcr_cst_unreg_sector()

Hapus registrasi request sektor mifare yang sebelumnya pernah diregistrasi menggunakan fungsi libcr_cst_reg_sector.

Requirement : -

Arguments

  • sector_id : ID sektor mifare yang akan hapus

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_cst_unreg_sector(
    uint8_t sector_id
);

libcr_cst_num_sector()

Dapatkan jumlah sektor yang sudah direquest

Requirement : -

Return Value

  • Error Code. atau jumlah sektor yang sudah di request (>=0)
int libcr_cst_num_sector();

libcr_set_gtostate()

Set state transaksi saat ini. Selalu panggil ketika selesai SOP, mulai EOP, transaksi berhasil dan terjadi deteksi

Requirement : MANDATORY

Arguments

  • gtostate : State transaksi saat ini. Lihat LIBCR_GTOSTATE_*

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_gtostate(
    uint8_t gtostate
);

libcr_set_data_perioda()

Set informasi perioda yang sedang berjalan, setiap selesai SOP pastikan fungsi ini dijalankan.

Rekomendasi juga ketika EOP panggil fungsi ini dengan memberikan nilai 0 pada semua argument nya.

Requirement : RECOMMENDED

Arguments

  • plt : Nomor PLT/CS yang sedang bertugas
  • kspt : Nomor KSPT/CSS yang sedang bertugas
  • shift : Shift yang sedang berjalan (0: Tutup, 1-3)
  • perioda : Perioda yang sedang berjalan (0: Tutup, 1-99)

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_data_perioda(
    uint32_t plt,
    uint32_t kspt,
    uint8_t shift,
    uint8_t perioda
);

libcr_set_golongan()

Set golongan saat ini. Selalu panggil ketika golongan kendaraan berubah. Set LIBCR_GOL_CLEAR untuk clear golongan.

Requirement : MANDATORY

Arguments

  • golongan : Golongan kendaraan (1-5), atau LIBCR_GOL_CLEAR

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_golongan(
    uint8_t golongan
);

libcr_set_golongan_avc()

Set golongan yang didapatkan avc. Selalu panggil ketika golongan avc berubah. Set LIBCR_GOL_CLEAR untuk clear golongan avc.

Requirement : RECOMMENDED

Arguments

  • golongan : Golongan avc (1-5), atau LIBCR_GOL_CLEAR

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_golongan_avc(
    uint8_t golongan
);

libcr_set_tarif()

Set tarif saat ini. Selalu panggil ketika tarif berubah. Set LIBCR_TARIF_NONE untuk clear tarif.

Requirement : RECOMMENDED

Arguments

  • tarif : Tarif dalam integer, atau LIBCR_TARIF_NONE

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_tarif(
    int32_t tarif
);

libcr_set_saldo()

Set saldo transaksi saat ini. Panggil ketika transaksi berhasil dan mendapatkan saldo terakhir, set LIBCR_SALDO_NONE ketika transaksi selesai (deteksi).

Requirement : OPTIONAL

Arguments

  • saldo : Saldo dalam integer, atau LIBCR_SALDO_NONE

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_saldo(
    int32_t saldo
);

libcr_set_noresi()

Set Nomor Resi untuk transaksi yang sedang dan akan berlangsung. Set LIBCR_NORESI_NONE ketika tidak menerima transaksi (Belum SOP, dll).

Requirement : OPTIONAL

Arguments

  • noresi : Nomor Resi dalam integer, atau LIBCR_NORESI_NONE

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_noresi(
    int32_t noresi
);

libcr_set_llb()

Set status llb saat ini. Selalu panggil ketika state llb berubah. Set LIBCR_LLB_NONE bila tidak akan mengirimkan status perubahan llb.

Requirement : OPTIONAL

Arguments

  • llb : Lihat LIBCR_LLB_*

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_llb(
    int8_t llb
);

libcr_set_bantuan()

Set status indikator/lampu permintaan bantuan saat ini. Penggil ketika indikator bantuan (VIA) aktif, agar operator di Control Room mendapatkan notifikasi dan dapat segera melakukan tindakan.

Requirement : OPTIONAL

Arguments

  • bantuan : Gunakan LIBCR_BANTUAN_OFF atau LIBCR_BANTUAN_ON

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_bantuan(
    uint8_t bantuan
);

libcr_set_message()

Set message yang akan ditampilkan di control room saat ini. Dapat digunakan sebagai sarana informasi untuk CS, misalnya:

  • TENTUKAN GOLONGAN KENDARAAN
  • TAP KARTU OPERASIONAL UNTUK SOP
  • MASUKAN PIN: 123_
  • TRANSAKSI BERHASIL. MENUNGGU DETEKSI

Isi dengan NULL bila akan mengosongkan pesan.

Requirement : RECOMMENDED

Arguments

  • message : Message yang akan tampil (max 256 karakter).

Return Value

  • Error Code. Lihat LIBCR_OK atau LIBCR_ERR_*
int libcr_set_message(
    const char* message
);

Constants

LibCR Default Port

NAME VALUE Keterangan
LIBCR_DEFAULT_PORT 8280 Port Default LibCR (8280)

State GTO

NAME VALUE Keterangan
LIBCR_GTOSTATE_NOREADY 0 Belum SOP / Bukan dalam mode transaksi
LIBCR_GTOSTATE_READY 1 Siap Transaksi (sebelum transaksi)
LIBCR_GTOSTATE_TRANS 2 Proses Transaksi s/d sebelum deteksi

Jenis Gardu

NAME VALUE Keterangan
LIBCR_GARDU_SINGLE 0 GTO Single
LIBCR_GARDU_MULTI 1 GTO Multi

Jenis Gerbang

NAME VALUE Keterangan
LIBCR_GERBANG_OPEN 0 Open / Sistem Terbuke
LIBCR_GERBANG_ENTRANCE 1 Entrance / Sistem Tertutup
LIBCR_GERBANG_EXIT 2 Exit / Sistem Tertutup
LIBCR_GERBANG_OPEN_ENTRANCE 3 Multi Open & entrance / Hybrid
LIBCR_GERBANG_EXIT_ENTRANCE 4 Multi Exit & entrance / Hybrid

Tarif, Saldo & Nomor Resi

NAME VALUE Keterangan
LIBCR_TARIF_NONE -1 Tidak ada tarif
LIBCR_SALDO_NONE -1 Tidak ada saldo
LIBCR_NORESI_NONE -1 Tidak ada nomor resi

Golongan

NAME VALUE Keterangan
LIBCR_GOL_CLEAR 0 Clear/Cancel Golongan
LIBCR_GOL_1 1 Golongan 1 / BUS
LIBCR_GOL_2 2 Golongan 2
LIBCR_GOL_3 3 Golongan 3
LIBCR_GOL_4 4 Golongan 4
LIBCR_GOL_5 5 Golongan 5

Keycode

NAME VALUE Keterangan
LIBCR_KEY_GOL1 1 GOL1
LIBCR_KEY_GOL2 2 GOL2
LIBCR_KEY_GOL3 3 GOL3
LIBCR_KEY_GOL4 4 GOL4
LIBCR_KEY_GOL5 5 GOL5
LIBCR_KEY_TEST 6 TEST PRINT
LIBCR_KEY_REG 7 REG
LIBCR_KEY_BSP 8 BACKSPACE
LIBCR_KEY_CAN 9 CANCEL
LIBCR_KEY_RESET 10 RESET
LIBCR_KEY_MENU 11 MENU
LIBCR_KEY_LLA 12 LLA
LIBCR_KEY_EXT1 13 Extra Key 1 (example: left)
LIBCR_KEY_EXT2 14 Extra Key 2 (example: right)
LIBCR_KEY_EXT3 15 Extra Key 3 (example: up)
LIBCR_KEY_EXT4 16 Extra Key 4 (example: down)
LIBCR_KEY_EXT5 17 Extra Key 5 (example: alb/dns)
LIBCR_KEY_EXT6 18 Extra Key 6 - unavailable
LIBCR_KEY_EXT7 19 Extra Key 7 - unavailable
LIBCR_KEY_NUM0 20 NUMBER 0
LIBCR_KEY_NUM1 21 NUMBER 1
LIBCR_KEY_NUM2 22 NUMBER 2
LIBCR_KEY_NUM3 23 NUMBER 3
LIBCR_KEY_NUM4 24 NUMBER 4
LIBCR_KEY_NUM5 25 NUMBER 5
LIBCR_KEY_NUM6 26 NUMBER 6
LIBCR_KEY_NUM7 27 NUMBER 7
LIBCR_KEY_NUM8 28 NUMBER 8
LIBCR_KEY_NUM9 29 NUMBER 9

State LLB

NAME VALUE Keterangan
LIBCR_LLB_NONE -1 Tidak ada info llb
LIBCR_LLB_RED 0 llb merah
LIBCR_LLB_GREEN 1 llb hijau

State Indikator Bantuan

NAME VALUE Keterangan
LIBCR_BANTUAN_OFF 0 Indikator bantuan mati
LIBCR_BANTUAN_ON 1 Indikator bantuan nyala

CST Mifare Key Type

NAME VALUE Keterangan
LIBCR_CST_KEY_TYPE_A 0 Mifare Key Type-A
LIBCR_CST_KEY_TYPE_B 1 Mifare Key Type-B

CST Read Sector Status

NAME VALUE Keterangan
LIBCR_CSTSTATUS_OK 0 Pembacaan berhasil
LIBCR_CSTSTATUS_ERR_AUTH 1 Auth Sector Gagal
LIBCR_CSTSTATUS_ERR_READ 2 Proses baca setelah auth gagal

Log Level

NAME VALUE Keterangan
LIBCR_LOGLEVEL_NONE 0 Jangan lakukan log
LIBCR_LOGLEVEL_ERROR 1 Log ketika ada error
LIBCR_LOGLEVEL_WARNING 2 Log ketika ada error+warning
LIBCR_LOGLEVEL_INFO 3 Log ketika ada error+warning+informasi
LIBCR_LOGLEVEL_MORE 4 Log dengan informasi lengkap
LIBCR_LOGLEVEL_VERBOSE 5 Log secara mendetail

Error Code

NAME VALUE Keterangan
LIBCR_OK 0 Tidak terjadi error
LIBCR_ERR_ARG -1 Argumen yang disertakan tidak valid
LIBCR_ERR_INIT -2 Init service gagal
LIBCR_ERR_REINIT -3 Service sebelumnya masih berjalan
LIBCR_ERR_NOSERVICE -4 Service belum dijalankan (di-init)
LIBCR_ERR_NOSECTORID -5 Sector-id mifare belum terdaftar

About

JMTO Control Room Service Library (LibCR)

Topics

tol

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages