Add raw HF signal plotting (#786)

[proxmark3-svn] / client / scripts / dumptoemul.lua

-- The getopt-functionality is loaded from pm3/getopt.lua
-- Have a look there for further details
getopt = require('getopt')
bin = require('bin')

example = "script run dumptoemul -i dumpdata-foobar.bin"
author = "Martin Holst Swende"
usage = "script run dumptoemul [-i <file>] [-o <file>]"
desc =[[
This script takes a dumpfile from 'hf mf dump' and converts it to a format that can be used
by the emulator

Arguments:
	-h 				This help
	-i <file>		Specifies the dump-file (input). If omitted, 'dumpdata.bin' is used	
	-o <filename>	Specifies the output file. If omitted, <uid>.eml is used. 	

]]

-------------------------------
-- Some utilities 
-------------------------------

--- 
-- A debug printout-function
function dbg(args)
	if DEBUG then
		print("###", args)
	end
end 
--- 
-- This is only meant to be used when errors occur
function oops(err)
	print("ERROR: ",err)
end


--- 
-- Usage help
function help()
	print(desc)
	print("Example usage")
	print(example)
end

local function convert_to_ascii(hexdata)
	if string.len(hexdata) % 32 ~= 0 then 
		return oops(("Bad data, length should be a multiple of 32 (was %d)"):format(string.len(hexdata)))
	end

	local js,i = "[";
	for i = 1, string.len(hexdata),32 do
		js = js .."'" ..string.sub(hexdata,i,i+31).."',\n"
	end
	js = js .. "]"
	return js
end

local function readdump(infile)
	 t = infile:read("*all")
	 --print(string.len(t))
	 len = string.len(t)
	 local len,hex = bin.unpack(("H%d"):format(len),t)
	 --print(len,hex)
	 return hex
end

local function convert_to_emulform(hexdata)
	if string.len(hexdata) % 32 ~= 0 then 
		return oops(("Bad data, length should be a multiple of 32 (was %d)"):format(string.len(hexdata)))
	end
	local ascii,i = "";
	for i = 1, string.len(hexdata),32 do
		ascii = ascii  ..string.sub(hexdata,i,i+31).."\n"
	end
	
	return string.sub(ascii,1,-1)
end

local function main(args)

	local input = "dumpdata.bin"
	local output

	for o, a in getopt.getopt(args, 'i:o:h') do
		if o == "h" then return help() end		
		if o == "i" then input = a end
		if o == "o" then output = a end
	end
	-- Validate the parameters
	
	local infile = io.open(input, "rb")
	if infile == nil then 
		return oops("Could not read file ", input)
	end
	local dumpdata = readdump(infile)
	-- The hex-data is now in ascii-format,

	-- But first, check the uid
	local uid = string.sub(dumpdata,1,8)
	output = output or (uid .. ".eml")

	-- Format some linebreaks
	dumpdata = convert_to_emulform(dumpdata)

	local outfile = io.open(output, "w")
	if outfile == nil then 
		return oops("Could not write to file ", output)
	end
	
	outfile:write(dumpdata:lower())
	io.close(outfile)
	print(("Wrote an emulator-dump to the file %s"):format(output))
end


--[[
In the future, we may implement so that scripts are invoked directly 
into a 'main' function, instead of being executed blindly. For future
compatibility, I have done so, but I invoke my main from here.  
--]]
main(args)