Skip to content

clear-code/lua-chrome-devtools-client

Repository files navigation

Chrome DevTools client for Lua 5.x

This module is connect to Chrome with chrome devtools protocol.

LuaRocks Installation

luarocks install chrome-devtools-client

Dependencies

  • lua-cjson
  • http
  • luasocket
  • lrexlib-oniguruma

Usage

API List:

  • connect
  • close
  • page_navigate
  • convert_html_to_xml
  • capture_screenshot
  • get_version

connect

Examples

require("chrome-devtools-client")

local client = Client:new()
client:connect("localhost", "9222")

close

Examples

require("chrome-devtools-client")

local client = Client:new()
client:connect("localhost", "9222")
client:close()

page_navigate

Examples

require("chrome-devtools-client")

local client = Client:new()
client:connect("localhost", "9222")

client:page_navigate("file:///tmp/test.html")
client:close()

convert_html_to_xml

Examples

require("chrome-devtools-client")

local client = Client:new()
client:connect("localhost", "9222")

xml = client:convert_html_to_xml(html_data)
print(xml)
client:close()

argument of convert_html_to_xml is HTML data(string). HTML data is below.

local html_data = "<!DOCTYPE html><meta charset=utf-8><title>Hello World</title>"

capture_screenshot

Return value of this function is base64 encoded data.

Examples

local connect_ip = "localhost"
local connect_port = "9222"

local client = Client:new()
client:connect(connect_ip, connect_port)
client:page_navigate("https://www.google.co.jp/")

local capture_img = client:capture_screenshot()

get_version

Retrun value of this function is string data.

Examples

local client = Client:new()
print(client.get_version())

License(MIT)

Copyright(C) 2017 by Yasuhiro Horimoto

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.