스크립트 함수 목록
스크립트 함수
모든 함수는 괄호와 함께 사용되어야 합니다.
Function | Description |
---|---|
alarm.createAllCsv(enum storageType ) |
모든 경보를 지정한 Storage type 에 CSV 파일로 저장합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.:1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project 리턴 값은 없습니다. 예시:
|
alarm.createCsv(String label , enum storageType ) |
지정한 String label 을 사용하는 모든 경보를 **Storage type** 에 CSV 파일로 저장합니다.String label 은 다음 이미지와 같이 경보에 사용된 레이블의 이름을 의미합니다.![]() Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project 리턴 값은 없습니다. 예시:
|
datalog.addRow(String modelName ) |
지정한 데이터 수집 모델에 행 하나를 추가합니다.String modelName 에는 데이터 수집 모델의 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
datalog.createCsv(String modelName , enum storageType ) |
지정한 데이터 수집 모델을 지정 경로에 CSV 파일로 저장합니다.String modelName 에는 데이터 수집 모델의 이름을 입력합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project 리턴 값은 없습니다. 예시:
|
datalog.createCsvForRange(String modelName , Date start , Date end , enum storageType ) |
지정한 데이터 수집 모델의 일정 기간 내 데이터만 CSV 파일로 저장합니다.String modelName 에는 데이터 수집 모델의 이름을 입력합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project Date start 에는 파일로 저장하고자 하는 데이터 수집 시작 일자를 입력합니다.Date end 에는 파일로 저장하고자 하는 데이터 수집 종료 일자를 입력합니다.리턴 값은 없습니다. 예시:
|
datalog.start(String modelName ) |
지정한 데이터 수집 모델의 데이터 수집 동작을 시작합니다.String modelName 에는 데이터 수집 모델의 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
datalog.stop(String modelName ) |
지정한 데이터 수집 모델의 데이터 수집 동작을 중지시킵니다.String modelName 에는 데이터 수집 모델의 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
driver.enable(Device Name ) |
지정한 디바이스를 활성화합니다.Device Name 에는 활성화할 IO 디바이스 이름을 입력합니다.예시:
|
driver.disable(Device Name ) |
지정한 디바이스를 비활성화합니다.Device Name 에는 비활성화할 IO 디바이스 이름을 입력합니다.예시:
|
keyboard.launchKeyboard(tagname , properties ) |
지정한 태그를 위한 문자 키보드를 지정 속성과 함께 화면에 표시합니다.tagname 에는 사용자가 문자열을 입력할 태그를 입력합니다.properties 에는 키패드의 구성 요소를 결정할 속성을 입력합니다.
예시:
|
keyboard.launchKeypad(tagname , properties ) |
지정한 태그를 위한 숫자 키패드를 지정 속성과 함께 화면에 표시합니다.tagname refers to the name of the tag to be set.properties 에는 키패드의 구성 요소를 결정할 속성을 입력합니다.
예시:
|
keyboard.sendKeyEvent(keycode ) |
키 코드 값을 이용하여 키보드의 키 입력과 같은 동작을 구현합니다.keycode 는 10진수 또는 16진수의 값으로 입력합니다.예시:
|
notification.send(string msg , int dismissInterval = -1 ) |
화면에 알림을 띄우는 함수입니다.string msg 에는 화면에 표시할 메시지를 입력합니다.int dismissInterval 에는 알림이 화면에 표시될 시간을 지정합니다.0보다 작은 값을 입력하면 그 알림은 사용자가 수동으로 닫기 전에는 사라지지 않습니다. 기본 값은 -1입니다. 리턴 값은 0 입니다. 예시:
|
page.close(string name ) |
지정된 이름의 페이지를 닫습니다.string name 에는 닫고자 하는 페이지의 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
page.closeIndex(number index ) |
지정된 인덱스의 페이지를 닫습니다.number index 에는 닫고자 하는 페이지의 인덱스를 입력합니다.리턴 값은 없습니다. 예시:
|
page.open(string name ) |
지정된 이름의 페이지를 엽니다.string name 에는 열고자 하는 페이지의 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
page.openIndex(number index ) |
지정된 인덱스의 페이지를 엽니다.number index 에는 열고자 하는 페이지의 인덱스를 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.createRecord(string recipe , int id , string name , List<Value> values ) |
지정된 레시피에 새 레코드를 추가합니다.string recipe 에는 레코드를 추가할 레시피를 입력합니다.int id 에는 새 레코드의 ID를 입력합니다.string name 에는 새 레코드의 이름을 입력합니다.List<Value> values 에는 레코드가 포함해야 하는 모든 파라미터 값을 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.deleteRecord(string recipe , int id ) |
지정한 레코드를 레시피에서 삭제합니다.string recipe 에는 레코드가 속한 레시피를 입력합니다.int id 삭제하려는 레코드의 ID를 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.exportCsv(string recipe , Storage type , string path ) |
지정한 레시피의 데이터를 지정한 경로에 CSV 파일로 저장합니다.string recipe 에는 레시피의 이름을 입력합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project string path 에는 CSV 파일 경로를 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.getAllParameters(string recipe ) |
지정한 레시피의 모든 파라미터 데이터를 가져옵니다.string recipe 에는 레시피의 이름을 입력합니다.리턴 값은 해당 레시피의 모든 파라미터 값 리스트입니다. 예시:
|
recipe.getParameter(string recipe , int id , int index ) |
지정한 레코드의 특정 파라미터 값을 가져옵니다.string recipe 에는 레시피의 이름을 입력합니다.int id 에는 레코드 ID를 입력합니다.int index 에는 파라미터의 인덱스를 입력합니다.리턴 값은 요청한 파라미터의 값이 반환됩니다. 예시:
|
recipe.getParameterByName(string recipe , int id , string name ) |
지정한 레코드의 특정 파라미터 이름을 검색하여 그 값을 가져옵니다.string recipe 에는 레시피의 이름을 입력합니다.int id 에는 레코드 ID를 입력합니다.string name 에는 파라미터의 이름을 입력합니다.리턴 값은 요청한 파라미터의 값이 반환됩니다. 예시:
|
recipe.getRecordName(string recipe , int id ) |
지정한 데이터베이스의 특정한 레코드 이름을 가져옵니다.string recipe 에는 레시피의 이름을 입력합니다.int id 에는 레코드 id를 입력합니다.리턴 값은 요청한 레코드의 이름이 반환됩니다. 예시:
|
recipe.getRecordValues(string recipe , int id ) |
지정한 레코드의 값을 가져옵니다.string recipe 에는 레코드가 속한 레시피의 이름을 입력합니다.int id 레코드의 ID를 입력합니다.리턴 값은 해당 레코드의 모든 파라미터 값 리스트입니다. 예시:
|
recipe.importCsv(string recipe , Storage type , string path ) |
지정한 레시피에 CSV 파일을 불러와 덮어쓰기 합니다.string recipe 에는 레시피의 이름을 입력합니다.에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다. 1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project string path CSV 파일이 위치한 경로를 입력합니다. 저장 위치의 상대경로를 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.setParameter(string recipe , int id , int index , Value value ) |
지정한 레코드의 특정 파라미터에 값을 씁니다.string recipe 에는 레시피의 이름을 입력합니다.int id 에는 레코드 ID를 입력합니다.int index 에는 파라미터의 인덱스를 입력합니다.Value value 에는 파라미터에 쓸 값을 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.setParameterByName(string recipe , int id , string name , Value value ) |
지정한 레코드의 특정 파라미터 이름을 검색하여 값을 씁니다.string recipe 에는 레시피의 이름을 입력합니다.int id 에는 레코드 ID를 입력합니다.string name 에는 파라미터의 이름을 입력합니다.Value value 에는 파라미터에 쓸 값을 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.setRecord(string recipe , int id , List<Value> values ) |
지정한 레코드의 값을 새로 설정합니다.string recipe 에는 레코드가 속한 레시피의 이름을 입력합니다.int id 에는 레코드의 ID를 입력합니다.List<Value> values 에는 레코드가 포함해야 하는 모든 파라미터 값을 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.setRecordId(string recipe , int oldId , int newId ) |
지정한 레시피의 특정 레코드 ID를 다른 ID로 변경합니다.string recipe 에는 레시피의 이름을 입력합니다.int oldId 에는 변경 이전의 레코드 ID를 입력합니다.int newId 에는 변경 이후의 레코드 ID를 입력합니다.리턴 값은 없습니다. 예시:
|
recipe.setRecordName(string recipe , int id , string name ) |
지정한 레시피의 특정 레코드에 이름을 설정합니다.string recipe 에는 레시피의 이름을 입력합니다.int id 에는 레코드 ID를 입력합니다.string name 에는 레코드 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
schedule.isEnabled(string title ) |
스케줄 활성 여부를 반환합니다.string title 에는 확인하고자 하는 스케줄의 이름을 입력합니다.예시:
|
schedule.setEnable(string title , bool enable ) |
지정된 스케줄의 활성 여부를 결정합니다.string title 에는 활성 여부를 결정할 스케줄 이름을 입력합니다.bool enable 에는 활성 (1 또는 True), 비활성 (0 또는 False) 를 입력합니다.리턴 값은 없습니다. 예시:
|
system.audio.playFile(Storage type , string relativePath , bool async = true ) |
지정된 경로에 있는 오디오 파일을 실행합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project string relativePath 에는 오디오 파일이 위치한 상대경로를 입력합니다.값이 1 (또는 true)라면 이 함수 이후의 동작을 파일이 재생되는 동안에도 수행합니다. 리턴 값은 오디오 파일을 반환합니다. 예시:
2024년 11월 이전에 판매된 CM-eXT07, CM-nXT07은 지원하지 않는 기능입니다.
|
system.audio.stopFile(Storage type , string relativePath ) |
지정된 경로에 있는 오디오 파일을 중지합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project string relativePath 에는 오디오 파일이 위치한 상대경로를 입력합니다.리턴 값은 오디오 파일을 반환합니다. 이 명령을 사용하려면 재생중인 대상 오디오가 비동기 상태로 재생되고 있어야 합니다. 예시:
2024년 11월 이전에 판매된 CM-eXT07, CM-nXT07은 지원하지 않는 기능입니다.
|
system.audit.log(description ) |
입력된 내용으로 감사 로그 데이터베이스에 로그를 추가합니다.description 에는 데이터베이스에 추가할 내용을 입력합니다.리턴 값은 없습니다. 예시:
|
system.currentUsername() |
현재 로그인된 유저의 유저이름을 반환합니다. 예시:
|
system.display.enableBacklight(Boolean ) |
Xpanel의 화면을 켜거나 끕니다. 0: 화면 끄기 1: 화면 켜기 유의: 설정 앱의 자동 밝기 조절, 또는 자동 절전 모드와 함께 사용하지 않는 것을 권장합니다. 예시:
|
system.email.send(properties ) |
SMTP 설정을 사용해 이메일을 발송합니다.properties 에는 이메일 속성을 지정합니다.
유의: 본 함수는 오프라인 시뮬레이터에서 사용할 수 없습니다. 예시:
|
system.exit() |
현재 실행중인 런타임을 종료합니다. 리턴 값은 없습니다. 예시:
|
system.file.exists(Storage type , String path = string() ) |
해당 경로에 파일이 존재하는지 확인합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project String path 에는 파일 경로를 입력합니다.리턴 값은 파일이 있을 때 1 (True), 없을 때 0 (false) 입니다. 예시:
|
system.file.isDirectory(Storage type , String path ) |
입력한 경로가 폴더 경로인지 아닌지 확인합니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project String path 에는 폴더 경로를 입력합니다.리턴 값은 경로가 맞을 때 1 (True), 아닐 때 0 (false) 입니다. 예시:
|
system.file.openDialog(Storage type , String path = string() ) |
입력된 경로에 대한 파일 브라우저를 엽니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project String path 에는 열고자 하는 파일 경로를 입력합니다.리턴 값은 없습니다. 예시:
|
system.file.openPdf(Storage type , String path ) |
지정한 PDF 파일을 실행합니다.Storage type :1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project String path 에는 실행하고자 하는 PDF 파일이 위치한 경로를 입력합니다.리턴 값은 PDF 파일이 열리면 1 (true), 열리지 않았으면 0 (false) 입니다. 유의: 본 함수는 시뮬레이터에서 사용할 수 없습니다. 예시:
|
system.file.saveDialog(Storage type , String path = string() ) |
입력한 경로에 파일을 저장할 수 있는 파일 브라우저를 엽니다.Storage type 에는 다음과 같이 숫자 혹은 저장 위치를 입력합니다.1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project String path 에는 열고자 하는 파일 경로를 입력합니다.리턴 값은 없습니다. 예시:
|
system.ftp.startServer() |
FTP 서버를 시작합니다. 리턴 값은 없습니다. 유의: 본 함수는 시뮬레이터에서 사용할 수 없습니다. 예시:
|
system.ftp.stopServer() |
FTP 서버를 정지합니다. 리턴 값은 없습니다. 유의: 본 함수는 시뮬레이터에서 사용할 수 없습니다. 예시:
|
system.hasPermission(string permission ) |
현재 로그인된 사용자에게 지정된 권한이 부여되었는지 확인합니다.string permission 에는 확인하고자 하는 권한 이름을 입력합니다.리턴 값은 권한이 있을 시 1 (True), 없을 시 0 (False) 입니다. 예시:
|
system.importScript(string scriptName ) |
지정된 외부 스크립트를 현재 실행중인 스레드에서 호출합니다.string scriptName 에는 호출할 스크립트의 이름을 입력합니다.리턴 값은 해당 호출 스크립트의 결과입니다. 예시:
|
system.login(string username , string password ) |
지정된 사용자 이름과 비밀번호를 사용하여 로그인합니다.string username 에는 로그인 하고자 하는 사용자명을 입력합니다.string password 로그인 하고자 하는 사용자의 비밀번호를 입력합니다. 사용자에게 비밀번호가 할당되지 않은 상태라면 입력하지 않은 채 사용할 수 있습니다.리턴 값은 로그인 성공 시 1 (또는 True), 로그인 실패 시 0 (또는 False) 입니다. 예시:
|
system.logout() |
현재 로그인된 사용자 계정에서 로그아웃 합니다. 리턴 값은 없습니다. 예시:
|
system.openAuthWindow(properties ) |
사용자 인증 창을 엽니다. 이미 로그인 된 상태여도 다시 사용자명 및 비밀번호를 입력해야 합니다.properties 에는 다음과 같은 항목을 설정할 수 있습니다.Username: 인증 받아야 하는 사용자를 지정합니다. 지정되지 않으면 사용자 인증 창에 입력한 사용자를 대상으로 인증을 진행합니다. 로그인 한 사용자가 없다면 0 (False) 를 반환합니다. Permissions: 지정된 권한이 있는 사용자만 로그인 할 수 있도록 합니다. 권한이 없는 사용자면 정보가 맞아도 로그인을 할 수 없습니다. 리턴 값은 로그인 되면 1 (True), 아니면 0 (False) 입니다. 예시:
|
system.openConfig() |
런타임 설정창을 엽니다. 리턴 값은 없습니다. 예시:
|
system.openFrameMonitor() |
프레임 모니터를 엽니다. 리턴 값은 없습니다. 유의: 본 함수는 시뮬레이터에서 사용할 수 없습니다. 예시:
|
system.openLoginWindow(properties ) |
사용자 로그인 창을 엽니다.properties 에는 사용자 목록 표시 여부를 결정하는 값을 입력합니다.listUsers: 사용자 목록 표시를 원할 시 1, 아닐 시 0을 입력합니다. 리턴 값은 없습니다. 예시:
|
system.runScript(string scriptName ) |
지정된 스크립트를 별도의 스레드에서 실행하도록 호출합니다.string scriptName 에는 호출하고자 하는 스크립트 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
system.screenshot(Storage type ) |
화면 스크린샷을 찍습니다.Storage type :2: Storage.Usb 3: Storage.SdCard 예시:
|
system.setLanguage(string language ) |
문자열 테이블 편집기에 등록된 언어 중 지정된 언어로 프로젝트의 설정을 변경합니다.string language 에는 문자열 테이블 편집기에 등록된 언어 이름을 입력합니다.리턴 값은 없습니다. 예시:
|
system.video.playFile(Storage type , String path ) |
지정한 비디오 파일을 실행합니다.Storage type :1: Storage.Local 2: Storage.Usb 3: Storage.SdCard 4: Storage.Ftp 5: Storage.Project String path 에는 실행하고자 하는 파일이 위치한 경로를 입력합니다.리턴 값은 파일이 실행되면 1 (true), 실행되지 않으면 0 (false) 입니다. 유의: 본 함수는 시뮬레이터에서 사용할 수 없습니다. 예시:
eXT2 제품에서만 사용 가능합니다.
|
system.video.stop() |
현재 런타임에서 재생중인 비디오를 중지합니다. 유의: 본 함수는 시뮬레이터에서 사용할 수 없습니다. 예시:
eXT2 제품에서만 사용 가능합니다.
|
tag.read(string name ) |
지정한 태그의 값을 읽습니다.string name 에는 태그 이름을 입력합니다.리턴 값은 태그의 종류에 따라 결정됩니다. 예시:
|
tag.write(string name , value ) |
지정한 태그에 값을 씁니다.string name 에는 태그 이름을 입력합니다.Value 에는 쓰고자 하는 값을 입력합니다.리턴 값은 없습니다. 예시:
|
thread.msleep(number msecs ) |
실행중인 스레드를 지정한 msec 만큼 일시정지 합니다.number msecs 에는 일시정지할 msec값을 입력합니다.리턴 값은 없습니다. 예시:
|
thread.sleep(number secs ) |
실행중인 스레드를 지정한 sec 만큼 일시정지 합니다.number secs 에는 일시정지할 sec값을 입력합니다.리턴 값은 없습니다. 예시:
|